GstRtp.RTPBaseDepayload

g GObject.InitiallyUnowned GObject.InitiallyUnowned Gst.Object Gst.Object GObject.InitiallyUnowned->Gst.Object GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gst.Element Gst.Element GstRtp.RTPBaseDepayload GstRtp.RTPBaseDepayload Gst.Element->GstRtp.RTPBaseDepayload Gst.Object->Gst.Element

Subclasses:

None

Methods

Inherited:

Gst.Element (81), Gst.Object (27), GObject.Object (37)

Structs:

Gst.ElementClass (10), GObject.ObjectClass (5)

is_source_info_enabled ()

push (out_buf)

push_list (out_list)

set_source_info_enabled (enable)

Virtual Methods

Inherited:

Gst.Element (16), Gst.Object (1), GObject.Object (7)

do_handle_event (event)

do_packet_lost (event)

do_process (in_)

do_process_rtp_packet (rtp_buffer)

do_set_caps (caps)

Properties

Inherited:

Gst.Object (2)

Name

Type

Flags

Short Description

auto-header-extension

bool

r/w

Whether RTP header extensions should be automatically enabled, if an implementation is available

max-reorder

int

r/w

Max seqnum reorder before assuming sender has restarted

source-info

bool

r/w

Add RTP source information as buffer meta

stats

Gst.Structure

r

Various statistics

Signals

Inherited:

Gst.Element (3), Gst.Object (1), GObject.Object (1)

Name

Short Description

add-extension

Add ext as an extension for reading part of an RTP header extension from incoming RTP packets.

clear-extensions

Clear all RTP header extensions used by this depayloader.

request-extension

The returned ext must be configured with the correct ext_id and with the necessary attributes as required by the extension implementation.

Fields

Inherited:

Gst.Element (3), Gst.Object (1), GObject.Object (1)

Name

Type

Access

Description

clock_rate

int

r

need_newsegment

bool

r

parent

Gst.Element

r

segment

Gst.Segment

r

sinkpad

Gst.Pad

r

srcpad

Gst.Pad

r

Class Details

class GstRtp.RTPBaseDepayload(**kwargs)
Bases:

Gst.Element

Abstract:

Yes

Structure:

GstRtp.RTPBaseDepayloadClass

Provides a base class for RTP depayloaders

is_source_info_enabled()
Returns:

True if source-info is enabled.

Return type:

bool

Queries whether GstRtp.RTPSourceMeta will be added to depayloaded buffers.

New in version 1.16.

push(out_buf)
Parameters:

out_buf (Gst.Buffer) – a Gst.Buffer

Returns:

a Gst.FlowReturn.

Return type:

Gst.FlowReturn

Push out_buf to the peer of self. This function takes ownership of out_buf.

This function will by default apply the last incoming timestamp on the outgoing buffer when it didn’t have a timestamp already.

push_list(out_list)
Parameters:

out_list (Gst.BufferList) – a Gst.BufferList

Returns:

a Gst.FlowReturn.

Return type:

Gst.FlowReturn

Push out_list to the peer of self. This function takes ownership of out_list.

set_source_info_enabled(enable)
Parameters:

enable (bool) – whether to add meta about RTP sources to buffer

Enable or disable adding GstRtp.RTPSourceMeta to depayloaded buffers.

New in version 1.16.

do_handle_event(event) virtual
Parameters:

event (Gst.Event) –

Return type:

bool

do_packet_lost(event) virtual
Parameters:

event (Gst.Event) –

Return type:

bool

do_process(in_) virtual
Parameters:

in (Gst.Buffer) –

Return type:

Gst.Buffer

do_process_rtp_packet(rtp_buffer) virtual
Parameters:

rtp_buffer (GstRtp.RTPBuffer) –

Return type:

Gst.Buffer

do_set_caps(caps) virtual
Parameters:

caps (Gst.Caps) –

Return type:

bool

Signal Details

GstRtp.RTPBaseDepayload.signals.add_extension(r_t_p_base_depayload, ext)
Signal Name:

add-extension

Flags:

RUN_LAST, ACTION

Parameters:

Add ext as an extension for reading part of an RTP header extension from incoming RTP packets.

New in version 1.20.

GstRtp.RTPBaseDepayload.signals.clear_extensions(r_t_p_base_depayload)
Signal Name:

clear-extensions

Flags:

RUN_LAST, ACTION

Parameters:

r_t_p_base_depayload (GstRtp.RTPBaseDepayload) – The object which received the signal

Clear all RTP header extensions used by this depayloader.

New in version 1.20.

GstRtp.RTPBaseDepayload.signals.request_extension(r_t_p_base_depayload, ext_id, ext_uri)
Signal Name:

request-extension

Flags:

RUN_LAST

Parameters:

  • r_t_p_base_depayload (GstRtp.RTPBaseDepayload) – The object which received the signal

  • ext_id (int) – the extension id being requested

  • ext_uri (str or None) – the extension URI being requested

Returns:

the GstRtp.RTPHeaderExtension for ext_id, or None

Return type:

GstRtp.RTPHeaderExtension or None

The returned ext must be configured with the correct ext_id and with the necessary attributes as required by the extension implementation.

New in version 1.20.

Property Details

GstRtp.RTPBaseDepayload.props.auto_header_extension
Name:

auto-header-extension

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE

If enabled, the depayloader will automatically try to enable all the RTP header extensions provided in the sink caps, saving the application the need to handle these extensions manually using the GstRtp.RTPBaseDepayload ::request-extension: signal.

New in version 1.20.

GstRtp.RTPBaseDepayload.props.max_reorder
Name:

max-reorder

Type:

int

Default Value:

100

Flags:

READABLE, WRITABLE

Max seqnum reorder before the sender is assumed to have restarted.

When max-reorder is set to 0 all reordered/duplicate packets are considered coming from a restarted sender.

New in version 1.18.

GstRtp.RTPBaseDepayload.props.source_info
Name:

source-info

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE

Add RTP source information found in RTP header as meta to output buffer.

New in version 1.16.

GstRtp.RTPBaseDepayload.props.stats
Name:

stats

Type:

Gst.Structure

Default Value:

None

Flags:

READABLE

Various depayloader statistics retrieved atomically (and are therefore synchroized with each other). This property return a Gst.Structure named application/x-rtp-depayload-stats containing the following fields relating to the last processed buffer and current state of the stream being depayloaded: