AggregatorPad

Added in version 1.14.

class AggregatorPad(**properties: Any)

Superclasses: Pad, Object, InitiallyUnowned, Object

Pads managed by a Aggregator subclass.

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

Methods

class AggregatorPad

do_flush(self, aggregator: Aggregator) → FlowReturn

Parameters:

aggregator

do_skip_buffer(self, aggregator: Aggregator, buffer: Buffer) → bool

Parameters:

• aggregator

• buffer

drop_buffer() → bool

Drop the buffer currently queued in pad.

has_buffer() → bool

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

Added in version 1.14.1.

is_eos() → bool

is_inactive() → bool

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

Added in version 1.20.

peek_buffer() → Buffer | None

pop_buffer() → Buffer | None

Steal the ref to the buffer currently queued in pad.

Properties

class AggregatorPad

props.current_level_buffers: int

The number of currently queued buffers inside this pad

Added in version 1.28.

props.current_level_bytes: int

The number of currently queued bytes inside this pad

Added in version 1.28.

props.current_level_time: int

The amount of currently queued time inside this pad

Added in version 1.28.

props.emit_signals: bool

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

Added in version 1.16.

Signals

class AggregatorPad.signals

buffer_consumed(object: Buffer) → None

Parameters:

object

Virtual Methods

class AggregatorPad

do_flush(aggregator: Aggregator) → FlowReturn

Optional Called when the pad has received a flush stop, this is the place to flush any information specific to the pad, it allows for individual pads to be flushed while others might not be.

Parameters:

aggregator

do_skip_buffer(aggregator: Aggregator, buffer: Buffer) → bool

Optional Called before input buffers are queued in the pad, return True if the buffer should be skipped.

Parameters:

• aggregator

• buffer

Fields

class AggregatorPad

parent

priv

segment

Last segment received.