Gjsify LogoGjsify Logo

Data structure that points to a packet at offset in buffer. The size of the structure is made public to allow stack allocations.

record

Hierarchy

  • RTCPPacket

Index

Constructors

Properties

offset: number

offset of packet in buffer data

field

pointer to RTCP buffer

field
name: string

Methods

  • add_profile_specific_ext(data: Uint8Array): boolean
  • Add profile-specific extension data to packet. If packet already contains profile-specific extension data will be appended to the existing extension.

    Parameters

    • data: Uint8Array

      profile-specific data

    Returns boolean

  • add_rb(ssrc: number, fractionlost: number, packetslost: number, exthighestseq: number, jitter: number, lsr: number, dlsr: number): boolean
  • Add a new report block to packet with the given values.

    Parameters

    • ssrc: number

      data source being reported

    • fractionlost: number

      fraction lost since last SR/RR

    • packetslost: number

      the cumululative number of packets lost

    • exthighestseq: number

      the extended last sequence number received

    • jitter: number

      the interarrival jitter

    • lsr: number

      the last SR packet from this source

    • dlsr: number

      the delay since last SR packet

    Returns boolean

  • app_get_data(): number
  • app_get_data_length(): number
  • app_get_name(): string
  • app_get_ssrc(): number
  • app_get_subtype(): number
  • app_set_data_length(wordlen: number): boolean
  • Set the length of the application-dependent data attached to an APP packet.

    Parameters

    • wordlen: number

      Length of the data in 32-bit words

    Returns boolean

  • app_set_name(name: string): void
  • app_set_ssrc(ssrc: number): void
  • app_set_subtype(subtype: number): void
  • bye_add_ssrc(ssrc: number): boolean
  • bye_add_ssrcs(ssrc: number[]): boolean
  • bye_get_nth_ssrc(nth: number): number
  • bye_get_reason(): string
  • bye_get_reason_len(): number
  • bye_get_ssrc_count(): number
  • bye_set_reason(reason: string): boolean
  • copy_profile_specific_ext(): [boolean, Uint8Array]
  • The profile-specific extension data is copied into a new allocated memory area data. This must be freed with g_free() after usage.

    Returns [boolean, Uint8Array]

  • fb_get_fci(): number
  • fb_get_fci_length(): number
  • fb_get_media_ssrc(): number
  • fb_get_sender_ssrc(): number
  • fb_set_fci_length(wordlen: number): boolean
  • Set the length of the Feedback Control Information attached to a RTPFB or PSFB packet.

    Parameters

    • wordlen: number

      Length of the FCI in 32-bit words

    Returns boolean

  • fb_set_media_ssrc(ssrc: number): void
  • fb_set_sender_ssrc(ssrc: number): void
  • get_count(): number
  • get_length(): number
  • get_padding(): boolean
  • get_profile_specific_ext(): [boolean, Uint8Array]
  • get_profile_specific_ext_length(): number
  • get_rb(nth: number): [number, number, number, number, number, number, number]
  • Parse the values of the nth report block in packet and store the result in the values.

    Parameters

    • nth: number

      the nth report block in packet

    Returns [number, number, number, number, number, number, number]

  • get_rb_count(): number
  • move_to_next(): boolean
  • Move the packet pointer packet to the next packet in the payload. Use gst_rtcp_buffer_get_first_packet() to initialize packet.

    Returns boolean

  • remove(): boolean
  • rr_get_ssrc(): number
  • rr_set_ssrc(ssrc: number): void
  • sdes_add_entry(type: RTCPSDESType, data: Uint8Array): boolean
  • sdes_add_item(ssrc: number): boolean
  • This function is like gst_rtcp_packet_sdes_get_entry() but it returns a null-terminated copy of the data instead. use g_free() after usage.

    Parameters

    Returns [boolean, Uint8Array]

  • sdes_first_entry(): boolean
  • sdes_first_item(): boolean
  • Get the data of the current SDES item entry. type (when not NULL) will contain the type of the entry. data (when not NULL) will point to len bytes.

    When type refers to a text item, data will point to a UTF8 string. Note that this UTF8 string is NOT null-terminated. Use gst_rtcp_packet_sdes_copy_entry() to get a null-terminated copy of the entry.

    Parameters

    Returns [boolean, Uint8Array]

  • sdes_get_item_count(): number
  • sdes_get_ssrc(): number
  • sdes_next_entry(): boolean
  • sdes_next_item(): boolean
  • set_rb(nth: number, ssrc: number, fractionlost: number, packetslost: number, exthighestseq: number, jitter: number, lsr: number, dlsr: number): void
  • Set the nth new report block in packet with the given values.

    Note: Not implemented.

    Parameters

    • nth: number

      the nth report block to set

    • ssrc: number

      data source being reported

    • fractionlost: number

      fraction lost since last SR/RR

    • packetslost: number

      the cumululative number of packets lost

    • exthighestseq: number

      the extended last sequence number received

    • jitter: number

      the interarrival jitter

    • lsr: number

      the last SR packet from this source

    • dlsr: number

      the delay since last SR packet

    Returns void

  • sr_get_sender_info(): [number, number, number, number, number]
  • sr_set_sender_info(ssrc: number, ntptime: number, rtptime: number, packet_count: number, octet_count: number): void
  • Set the given values in the SR packet packet.

    Parameters

    • ssrc: number

      the SSRC

    • ntptime: number

      the NTP time

    • rtptime: number

      the RTP time

    • packet_count: number

      the packet count

    • octet_count: number

      the octet count

    Returns void

  • xr_first_rb(): boolean
  • xr_get_block_length(): number
  • xr_get_dlrr_block(nth: number, ssrc: number, last_rr: number, delay: number): boolean
  • Parse the extended report block for DLRR report block type.

    Parameters

    • nth: number

      the index of sub-block to retrieve.

    • ssrc: number

      the SSRC of the receiver.

    • last_rr: number

      the last receiver reference timestamp of ssrc.

    • delay: number

      the delay since last_rr.

    Returns boolean

  • xr_get_prt_by_seq(seq: number, receipt_time: number): boolean
  • Retrieve the packet receipt time of seq which ranges in [begin_seq, end_seq).

    Parameters

    • seq: number

      the sequence to retrieve the time.

    • receipt_time: number

      the packet receipt time of seq.

    Returns boolean

  • xr_get_prt_info(ssrc: number, thinning: number, begin_seq: number, end_seq: number): boolean
  • Parse the Packet Recept Times Report Block from a XR packet

    Parameters

    • ssrc: number

      the SSRC of the RTP data packet source being reported upon by this report block.

    • thinning: number

      the amount of thinning performed on the sequence number space.

    • begin_seq: number

      the first sequence number that this block reports on.

    • end_seq: number

      the last sequence number that this block reports on plus one.

    Returns boolean

  • xr_get_rle_info(ssrc: number, thinning: number, begin_seq: number, end_seq: number, chunk_count: number): boolean
  • Parse the extended report block for Loss RLE and Duplicated LRE block type.

    Parameters

    • ssrc: number

      the SSRC of the RTP data packet source being reported upon by this report block.

    • thinning: number

      the amount of thinning performed on the sequence number space.

    • begin_seq: number

      the first sequence number that this block reports on.

    • end_seq: number

      the last sequence number that this block reports on plus one.

    • chunk_count: number

      the number of chunks calculated by block length.

    Returns boolean

  • xr_get_rle_nth_chunk(nth: number, chunk: number): boolean
  • Retrieve actual chunk data.

    Parameters

    • nth: number

      the index of chunk to retrieve.

    • chunk: number

      the nth chunk.

    Returns boolean

  • xr_get_rrt(timestamp: number): boolean
  • xr_get_ssrc(): number
  • xr_get_summary_info(ssrc: number, begin_seq: number, end_seq: number): boolean
  • Extract a basic information from static summary report block of XR packet.

    Parameters

    • ssrc: number

      the SSRC of the source.

    • begin_seq: number

      the first sequence number that this block reports on.

    • end_seq: number

      the last sequence number that this block reports on plus one.

    Returns boolean

  • xr_get_summary_jitter(min_jitter: number, max_jitter: number, mean_jitter: number, dev_jitter: number): boolean
  • Extract jitter information from the statistics summary. If the jitter flag in a block header is set as zero, all of jitters will be zero.

    Parameters

    • min_jitter: number

      the minimum relative transit time between two sequences.

    • max_jitter: number

      the maximum relative transit time between two sequences.

    • mean_jitter: number

      the mean relative transit time between two sequences.

    • dev_jitter: number

      the standard deviation of the relative transit time between two sequences.

    Returns boolean

  • xr_get_summary_pkt(lost_packets: number, dup_packets: number): boolean
  • Get the number of lost or duplicate packets. If the flag in a block header is set as zero, lost_packets or dup_packets will be zero.

    Parameters

    • lost_packets: number

      the number of lost packets between begin_seq and end_seq.

    • dup_packets: number

      the number of duplicate packets between begin_seq and end_seq.

    Returns boolean

  • xr_get_summary_ttl(is_ipv4: boolean, min_ttl: number, max_ttl: number, mean_ttl: number, dev_ttl: number): boolean
  • Extract the value of ttl for ipv4, or hop limit for ipv6.

    Parameters

    • is_ipv4: boolean

      the flag to indicate that the return values are ipv4 ttl or ipv6 hop limits.

    • min_ttl: number

      the minimum TTL or Hop Limit value of data packets between two sequences.

    • max_ttl: number

      the maximum TTL or Hop Limit value of data packets between two sequences.

    • mean_ttl: number

      the mean TTL or Hop Limit value of data packets between two sequences.

    • dev_ttl: number

      the standard deviation of the TTL or Hop Limit value of data packets between two sequences.

    Returns boolean

  • xr_get_voip_burst_metrics(burst_density: number, gap_density: number, burst_duration: number, gap_duration: number): boolean
  • xr_get_voip_configuration_params(gmin: number, rx_config: number): boolean
  • xr_get_voip_delay_metrics(roundtrip_delay: number, end_system_delay: number): boolean
  • xr_get_voip_jitter_buffer_params(jb_nominal: number, jb_maximum: number, jb_abs_max: number): boolean
  • xr_get_voip_metrics_ssrc(ssrc: number): boolean
  • xr_get_voip_packet_metrics(loss_rate: number, discard_rate: number): boolean
  • xr_get_voip_quality_metrics(r_factor: number, ext_r_factor: number, mos_lq: number, mos_cq: number): boolean
  • xr_get_voip_signal_metrics(signal_level: number, noise_level: number, rerl: number, gmin: number): boolean
  • xr_next_rb(): boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method