GstRtphdrext

GstRtp.RTPHeaderExtension

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Element
                ╰──GstRtp.RTPHeaderExtension

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.get_direction

function GstRtp.RTPHeaderExtension.prototype.get_direction(): {
    // javascript wrapper for 'gst_rtp_header_extension_get_direction'
}

Retrieve the direction

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.get_id

function GstRtp.RTPHeaderExtension.prototype.get_id(): {
    // javascript wrapper for 'gst_rtp_header_extension_get_id'
}

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.get_max_size

function GstRtp.RTPHeaderExtension.prototype.get_max_size(input_meta: Gst.Buffer): {
    // javascript wrapper for 'gst_rtp_header_extension_get_max_size'
}

This is used to know how much data a certain header extension will need for both allocating the resulting data, and deciding how much payload data can be generated.

Implementations should return as accurate a value as is possible using the information given in the input buffer.

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.get_sdp_caps_field_name

function GstRtp.RTPHeaderExtension.prototype.get_sdp_caps_field_name(): {
    // javascript wrapper for 'gst_rtp_header_extension_get_sdp_caps_field_name'
}

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.get_supported_flags

function GstRtp.RTPHeaderExtension.prototype.get_supported_flags(): {
    // javascript wrapper for 'gst_rtp_header_extension_get_supported_flags'
}

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.get_uri

function GstRtp.RTPHeaderExtension.prototype.get_uri(): {
    // javascript wrapper for 'gst_rtp_header_extension_get_uri'
}

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.read

function GstRtp.RTPHeaderExtension.prototype.read(read_flags: GstRtp.RTPHeaderExtensionFlags, data: [ Number ], size: Number, buffer: Gst.Buffer): {
    // javascript wrapper for 'gst_rtp_header_extension_read'
}

Read the RTP header extension from data.

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.set_attributes_from_caps

function GstRtp.RTPHeaderExtension.prototype.set_attributes_from_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_rtp_header_extension_set_attributes_from_caps'
}

GstRtp.RTPHeaderExtension.prototype.set_id must have been called with a valid extension id that is contained in these caps.

The only current known caps format is based on the SDP standard as produced by GstSdp.SDPMedia.prototype.attributes_to_caps.

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.set_caps_from_attributes

function GstRtp.RTPHeaderExtension.prototype.set_caps_from_attributes(caps: Gst.Caps): {
    // javascript wrapper for 'gst_rtp_header_extension_set_caps_from_attributes'
}

GstRtp.RTPHeaderExtension.prototype.set_id must have been called with a valid extension id that is contained in these caps.

The only current known caps format is based on the SDP standard as produced by GstSdp.SDPMedia.prototype.attributes_to_caps.

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.set_caps_from_attributes_helper

function GstRtp.RTPHeaderExtension.prototype.set_caps_from_attributes_helper(caps: Gst.Caps, attributes: String): {
    // javascript wrapper for 'gst_rtp_header_extension_set_caps_from_attributes_helper'
}

Helper implementation for GstRTPExtensionClass::set_caps_from_attributes that sets the ext uri on caps with the specified extension id as required for sdp Gst.Caps.

Requires that the extension does not have any attributes or direction advertised in caps.

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.set_direction

function GstRtp.RTPHeaderExtension.prototype.set_direction(direction: GstRtp.RTPHeaderExtensionDirection): {
    // javascript wrapper for 'gst_rtp_header_extension_set_direction'
}

Set the direction that this header extension should be used in. If GstRtp.RTPHeaderExtensionDirection.INHERITED is included, the direction will not be included in the caps (as it shouldn't be in the extmap line in the SDP).

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.set_id

function GstRtp.RTPHeaderExtension.prototype.set_id(ext_id: Number): {
    // javascript wrapper for 'gst_rtp_header_extension_set_id'
}

sets the RTP extension id on ext

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.set_non_rtp_sink_caps

function GstRtp.RTPHeaderExtension.prototype.set_non_rtp_sink_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_rtp_header_extension_set_non_rtp_sink_caps'
}

Passes RTP payloader's sink (i.e. not payloaded) caps to the header extension.

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.set_wants_update_non_rtp_src_caps

function GstRtp.RTPHeaderExtension.prototype.set_wants_update_non_rtp_src_caps(state: Number): {
    // javascript wrapper for 'gst_rtp_header_extension_set_wants_update_non_rtp_src_caps'
}

Call this function in a subclass from vfunc_read to tell the depayloader whether the data just parsed from RTP packet require updating its src (non-RTP) caps. If state is TRUE, GstRtp.RTPBaseDepayload will eventually invoke GstRtp.RTPHeaderExtension.prototype.update_non_rtp_src_caps to have the caps update applied. Applying the update also flips the internal "wants update" flag back to FALSE.

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.update_non_rtp_src_caps

function GstRtp.RTPHeaderExtension.prototype.update_non_rtp_src_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_rtp_header_extension_update_non_rtp_src_caps'
}

Updates depayloader src caps based on the information received in RTP header. caps must be writable as this function may modify them.

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.wants_update_non_rtp_src_caps

function GstRtp.RTPHeaderExtension.prototype.wants_update_non_rtp_src_caps(): {
    // javascript wrapper for 'gst_rtp_header_extension_wants_update_non_rtp_src_caps'
}

Call this function after GstRtp.RTPHeaderExtension.prototype.read to check if the depayloader's src caps need updating with data received in the last RTP packet.

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.write

function GstRtp.RTPHeaderExtension.prototype.write(input_meta: Gst.Buffer, write_flags: GstRtp.RTPHeaderExtensionFlags, output: Gst.Buffer, data: [ Number ], size: Number): {
    // javascript wrapper for 'gst_rtp_header_extension_write'
}

Writes the RTP header extension to data using information available from the input_meta. data will be sized to be at least the value returned from GstRtp.RTPHeaderExtension.prototype.get_max_size.

Since : 1.20

GstRtp.RTPHeaderExtensionClass.prototype.set_uri

function GstRtp.RTPHeaderExtensionClass.prototype.set_uri(klass: GstRtp.RTPHeaderExtensionClass, uri: String): {
    // javascript wrapper for 'gst_rtp_header_extension_class_set_uri'
}

Set the URI for this RTP header extension implementation.

Since : 1.20

GstRtp.RTPHeaderExtension.prototype.create_from_uri

function GstRtp.RTPHeaderExtension.prototype.create_from_uri(uri: String): {
    // javascript wrapper for 'gst_rtp_header_extension_create_from_uri'
}

Since : 1.20

vfunc_get_max_size

function vfunc_get_max_size(ext: GstRtp.RTPHeaderExtension, input_meta: Gst.Buffer): {
    // javascript implementation of the 'get_max_size' virtual method
}

retrieve the maximum size for this extension based on the information available from input_meta. Implementations should attempt to provide as accurate information as possible as the returned value will be used to control the amount of possible data in the payload. Implementations must return the maximum as the allocated size for writing the extension will be at least the size of the returned value. Return the amount of data read or <0 on failure.

vfunc_get_supported_flags

function vfunc_get_supported_flags(ext: GstRtp.RTPHeaderExtension): {
    // javascript implementation of the 'get_supported_flags' virtual method
}

retrieve the supported flags

vfunc_read

function vfunc_read(ext: GstRtp.RTPHeaderExtension, read_flags: GstRtp.RTPHeaderExtensionFlags, data: [ Number ], size: Number, buffer: Gst.Buffer): {
    // javascript implementation of the 'read' virtual method
}

read from a rtp payloaded buffer and extract the extension information, optionally adding some meta onto the output buffer.

vfunc_set_attributes

function vfunc_set_attributes(ext: GstRtp.RTPHeaderExtension, direction: GstRtp.RTPHeaderExtensionDirection, attributes: String): {
    // javascript implementation of the 'set_attributes' virtual method
}

set the necessary attributes that may be signaled e.g. with an SDP.

vfunc_set_caps_from_attributes

function vfunc_set_caps_from_attributes(ext: GstRtp.RTPHeaderExtension, caps: Gst.Caps): {
    // javascript implementation of the 'set_caps_from_attributes' virtual method
}

write the necessary caps field/s for the configured attributes e.g. as signalled with SDP.

vfunc_set_non_rtp_sink_caps

function vfunc_set_non_rtp_sink_caps(ext: GstRtp.RTPHeaderExtension, caps: Gst.Caps): {
    // javascript implementation of the 'set_non_rtp_sink_caps' virtual method
}

read any information from sink caps that the header extension needs for its function.

vfunc_update_non_rtp_src_caps

function vfunc_update_non_rtp_src_caps(ext: GstRtp.RTPHeaderExtension, caps: Gst.Caps): {
    // javascript implementation of the 'update_non_rtp_src_caps' virtual method
}

update depayloader non-RTP (depayloaded) caps with the information parsed from RTP header.

vfunc_write

function vfunc_write(ext: GstRtp.RTPHeaderExtension, input_meta: Gst.Buffer, write_flags: GstRtp.RTPHeaderExtensionFlags, output: Gst.Buffer, data: [ Number ], size: Number): {
    // javascript implementation of the 'write' virtual method
}

write into data the information for this extension. Various information is provided to help writing extensions in particular cases.

GstRtp.prototype.rtp_get_header_extension_list

function GstRtp.prototype.rtp_get_header_extension_list(): {
    // javascript wrapper for 'gst_rtp_get_header_extension_list'
}

Retrieve all the factories of the currently registered RTP header extensions. Call Gst.ElementFactory.prototype.create with each factory to create the associated GstRtp.RTPHeaderExtension.

Since : 1.20

GstRtp.prototype.rtp_hdrext_get_ntp_56

function GstRtp.prototype.rtp_hdrext_get_ntp_56(data: [ Number ], size: Number): {
    // javascript wrapper for 'gst_rtp_hdrext_get_ntp_56'
}

Reads the NTP time from the size NTP-56 extension bytes in data and store the result in ntptime.

GstRtp.prototype.rtp_hdrext_get_ntp_64

function GstRtp.prototype.rtp_hdrext_get_ntp_64(data: [ Number ], size: Number): {
    // javascript wrapper for 'gst_rtp_hdrext_get_ntp_64'
}

Reads the NTP time from the size NTP-64 extension bytes in data and store the result in ntptime.

GstRtp.prototype.rtp_hdrext_set_ntp_56

function GstRtp.prototype.rtp_hdrext_set_ntp_56(data: Object, size: Number, ntptime: Number): {
    // javascript wrapper for 'gst_rtp_hdrext_set_ntp_56'
}

Writes the NTP time in ntptime to the format required for the NTP-56 header extension. data must hold at least GstRtp.RTP_HDREXT_NTP_56_SIZE bytes.

GstRtp.prototype.rtp_hdrext_set_ntp_64

function GstRtp.prototype.rtp_hdrext_set_ntp_64(data: Object, size: Number, ntptime: Number): {
    // javascript wrapper for 'gst_rtp_hdrext_set_ntp_64'
}

Writes the NTP time in ntptime to the format required for the NTP-64 header extension. data must hold at least GstRtp.RTP_HDREXT_NTP_64_SIZE bytes.

GstRtp.RTPHeaderExtensionDirection

Direction to which to apply the RTP Header Extension

Since : 1.20

GstRtp.RTPHeaderExtensionFlags

Flags that apply to a RTP Audio/Video header extension.

Since : 1.20

GstRtp.RTP_HDREXT_BASE

GstRtp.RTP_HDREXT_ELEMENT_CLASS

Constant string used in element classification to signal that this element is a RTP header extension.

Since : 1.20

GstRtp.RTP_HDREXT_NTP_56

GstRtp.RTP_HDREXT_NTP_56_SIZE

GstRtp.RTP_HDREXT_NTP_64

GstRtp.RTP_HDREXT_NTP_64_SIZE

GstRtp.RTP_HEADER_EXTENSION_URI_METADATA_KEY

Since : 1.20