GstBase.AggregatorPad¶

Subclasses:: None

Methods¶

Inherited:: Gst.Pad (84), Gst.Object (27), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`drop_buffer` ()
	`has_buffer` ()
	`is_eos` ()
	`is_inactive` ()
	`peek_buffer` ()
	`pop_buffer` ()

Virtual Methods¶

Inherited:: Gst.Pad (2), Gst.Object (1), GObject.Object (7)

	`do_flush` (aggregator)
	`do_skip_buffer` (aggregator, buffer)

Properties¶

Inherited:: Gst.Pad (4), Gst.Object (2)

Name	Type	Flags	Short Description
`emit-signals`	`bool`	r/w	Send signals to signal data consumption

Signals¶

Inherited:: Gst.Pad (2), Gst.Object (1), GObject.Object (1)

Name	Short Description
`buffer-consumed`

Fields¶

Inherited:: Gst.Pad (2), Gst.Object (1), GObject.Object (1)

Name	Type	Access	Description
parent	`Gst.Pad`	r
segment	`Gst.Segment`	r	last segment received.

Class Details¶

class GstBase.AggregatorPad(**kwargs)¶

Bases:: Gst.Pad
Abstract:: No
Structure:: GstBase.AggregatorPadClass

Pads managed by a GstBase.Aggregator subclass.

This class used to live in gst-plugins-bad and was moved to core.

New in version 1.14.

drop_buffer()¶

Returns:: True if there was a buffer queued in self, or False if not.
Return type:: bool

Drop the buffer currently queued in self.

has_buffer()¶

Returns:: True if the pad has a buffer available as the next thing.
Return type:: bool

This checks if a pad has a buffer available that will be returned by a call to GstBase.AggregatorPad.peek_buffer() or GstBase.AggregatorPad.pop_buffer().

New in version 1.14.1.

is_eos()¶

Returns:: True if the pad is EOS, otherwise False.
Return type:: bool

is_inactive()¶

Returns:: True if the pad is inactive, False otherwise. See gst_aggregator_ignore_inactive_pads() for more info.
Return type:: bool

It is only valid to call this method from #GstAggregatorClass::aggregate()

New in version 1.20.

peek_buffer()¶

Returns:: A reference to the buffer in self or None if no buffer was queued. You should unref the buffer after usage.
Return type:: Gst.Buffer or None

pop_buffer()¶

Returns:: The buffer in self or None if no buffer was queued. You should unref the buffer after usage.
Return type:: Gst.Buffer or None

Steal the ref to the buffer currently queued in self.

do_flush(aggregator) virtual¶

Parameters:: aggregator (GstBase.Aggregator) –
Return type:: Gst.FlowReturn

do_skip_buffer(aggregator, buffer) virtual¶

Parameters:

aggregator (GstBase.Aggregator) –
buffer (Gst.Buffer) –

Return type:

bool

Signal Details¶

GstBase.AggregatorPad.signals.buffer_consumed(aggregator_pad, object)¶

Signal Name:

buffer-consumed

Flags:

RUN_FIRST

Parameters:

aggregator_pad (GstBase.AggregatorPad) – The object which received the signal
object (Gst.Buffer) –

Property Details¶

GstBase.AggregatorPad.props.emit_signals¶

Name:: emit-signals
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Enables the emission of signals such as GstBase.AggregatorPad ::buffer-consumed

New in version 1.16.