GstVideo.VideoAggregatorPad¶

Subclasses:: GstVideo.VideoAggregatorConvertPad

Methods¶

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

	`get_current_buffer` ()
	`get_prepared_frame` ()
	`has_current_buffer` ()
	`set_needs_alpha` (needs_alpha)

Virtual Methods¶

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

	`do_clean_frame` (videoaggregator, prepared_frame)
	`do_prepare_frame` (videoaggregator, buffer, prepared_frame)
	`do_prepare_frame_finish` (videoaggregator, prepared_frame)
	`do_prepare_frame_start` (videoaggregator, buffer, prepared_frame)
	`do_update_conversion_info` ()

Properties¶

Inherited:: GstBase.AggregatorPad (1), Gst.Pad (4), Gst.Object (2)

Name	Type	Flags	Short Description
`max-last-buffer-repeat`	`int`	r/w	Repeat last buffer for time (in ns, -1=until EOS), behaviour on EOS is not affected
`repeat-after-eos`	`bool`	r/w	Repeat the last frame after EOS until all pads are EOS
`zorder`	`int`	r/w	Z Order of the picture

Signals¶

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

Fields¶

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

Name	Type	Access	Description
info	`GstVideo.VideoInfo`	r	The `GstVideo.VideoInfo` currently set on the pad
parent	`GstBase.AggregatorPad`	r

Class Details¶

class GstVideo.VideoAggregatorPad(**kwargs)¶

Bases:: GstBase.AggregatorPad
Abstract:: No
Structure:: GstVideo.VideoAggregatorPadClass

New in version 1.16.

get_current_buffer()[source]¶

Returns:: The currently queued buffer
Return type:: Gst.Buffer

Returns the currently queued buffer that is going to be used for the current output frame.

This must only be called from the #GstVideoAggregatorClass::aggregate_frames virtual method, or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.

The return value is only valid until #GstVideoAggregatorClass::aggregate_frames or #GstVideoAggregatorPadClass::prepare_frame returns.

get_prepared_frame()[source]¶

Returns:: The currently prepared video frame
Return type:: GstVideo.VideoFrame

Returns the currently prepared video frame that has to be aggregated into the current output frame.

This must only be called from the #GstVideoAggregatorClass::aggregate_frames virtual method, or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.

The return value is only valid until #GstVideoAggregatorClass::aggregate_frames or #GstVideoAggregatorPadClass::prepare_frame returns.

has_current_buffer()[source]¶

Returns:: True if the pad has currently a buffer queued
Return type:: bool

Checks if the pad currently has a buffer queued that is going to be used for the current output frame.

This must only be called from the #GstVideoAggregatorClass::aggregate_frames virtual method, or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.

set_needs_alpha(needs_alpha)[source]¶

Parameters:: needs_alpha (bool) – True if this pad requires alpha output

Allows selecting that this pad requires an output format with alpha

do_clean_frame(videoaggregator, prepared_frame) virtual¶

Parameters:

videoaggregator (GstVideo.VideoAggregator) –
prepared_frame (GstVideo.VideoFrame) –

clean the frame previously prepared in prepare_frame

do_prepare_frame(videoaggregator, buffer, prepared_frame) virtual¶

Parameters:

videoaggregator (GstVideo.VideoAggregator) –
buffer (Gst.Buffer) –
prepared_frame (GstVideo.VideoFrame) –

Return type:

bool

Prepare the frame from the pad buffer and sets it to prepared_frame. Implementations should always return True. Returning False will cease iteration over subsequent pads.

do_prepare_frame_finish(videoaggregator, prepared_frame) virtual¶

Parameters:

videoaggregator (GstVideo.VideoAggregator) – the parent GstVideo.VideoAggregator
prepared_frame (GstVideo.VideoFrame) – the GstVideo.VideoFrame to prepare into

Finish preparing prepared_frame.

If overriden, prepare_frame_start must also be overriden.

New in version 1.20.

do_prepare_frame_start(videoaggregator, buffer, prepared_frame) virtual¶

Parameters:

videoaggregator (GstVideo.VideoAggregator) – the parent GstVideo.VideoAggregator
buffer (Gst.Buffer) – the input Gst.Buffer to prepare
prepared_frame (GstVideo.VideoFrame) – the GstVideo.VideoFrame to prepare into

Begin preparing the frame from the pad buffer and sets it to prepared_frame.

If overriden, prepare_frame_finish must also be overriden.

New in version 1.20.

do_update_conversion_info() virtual¶: Called when either the input or output formats have changed.

Property Details¶

GstVideo.VideoAggregatorPad.props.max_last_buffer_repeat¶

Name:: max-last-buffer-repeat
Type:: int
Default Value:: 18446744073709551615
Flags:: READABLE, WRITABLE

Repeat last buffer for time (in ns, -1=until EOS), behaviour on EOS is not affected

GstVideo.VideoAggregatorPad.props.repeat_after_eos¶

Name:: repeat-after-eos
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Repeat the last frame after EOS until all pads are EOS

GstVideo.VideoAggregatorPad.props.zorder¶

Name:: zorder
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Z Order of the picture