Gjsify LogoGjsify Logo

Note: The API in this module is not yet declared stable.

The GstRTPCBuffer helper functions makes it easy to parse and create regular #GstBuffer objects that contain compound RTCP packets. These buffers are typically of 'application/x-rtcp' #GstCaps.

An RTCP buffer consists of 1 or more #GstRTCPPacket structures that you can retrieve with gst_rtcp_buffer_get_first_packet(). #GstRTCPPacket acts as a pointer into the RTCP buffer; you can move to the next packet with gst_rtcp_packet_move_to_next().

record

Hierarchy

  • RTCPBuffer

Index

Constructors

Properties

buffer: Gst.Buffer
map: MapInfo
name: string

Methods

  • get_packet_count(): number
  • unmap(): boolean
  • Finish rtcp after being constructed. This function is usually called after gst_rtcp_buffer_map() and after adding the RTCP items to the new buffer.

    The function adjusts the size of rtcp with the total length of all the added packets.

    Returns boolean

  • Open buffer for reading or writing, depending on flags. The resulting RTCP buffer state is stored in rtcp.

    Parameters

    Returns boolean

  • Create a new buffer for constructing RTCP packets. The packet will have a maximum size of mtu.

    Parameters

    • mtu: number

      the maximum mtu size.

    Returns Gst.Buffer

  • Create a new buffer and set the data to a copy of len bytes of data and the size to len. The data will be freed when the buffer is freed.

    Parameters

    • data: Uint8Array

      data for the new buffer

    Returns Gst.Buffer

  • Create a new buffer and set the data and size of the buffer to data and len respectively. data will be freed when the buffer is unreffed, so this function transfers ownership of data to the new buffer.

    Parameters

    • data: Uint8Array

      data for the new buffer

    Returns Gst.Buffer

  • Check if the data pointed to by buffer is a valid RTCP packet using gst_rtcp_buffer_validate_data().

    Parameters

    Returns boolean

  • validate_data(data: Uint8Array): boolean
  • Check if the data and size point to the data of a valid compound, non-reduced size RTCP packet. Use this function to validate a packet before using the other functions in this module.

    Parameters

    • data: Uint8Array

      the data to validate

    Returns boolean

  • validate_data_reduced(data: Uint8Array): boolean
  • Check if the data and size point to the data of a valid RTCP packet. Use this function to validate a packet before using the other functions in this module.

    This function is updated to support reduced size rtcp packets according to RFC 5506 and will validate full compound RTCP packets as well as reduced size RTCP packets.

    Parameters

    • data: Uint8Array

      the data to validate

    Returns boolean

  • validate_reduced(buffer: Gst.Buffer): boolean
  • Check if the data pointed to by buffer is a valid RTCP packet using gst_rtcp_buffer_validate_reduced().

    Parameters

    Returns 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