GstVideoAggregator

GstVideo.VideoAggregator

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Element
                ╰──GstBase.Aggregator
                    ╰──GstVideo.VideoAggregator
                        ╰──GstGL.GLBaseMixer

Since : 1.16

GstVideo.VideoAggregator.prototype.get_execution_task_pool

function GstVideo.VideoAggregator.prototype.get_execution_task_pool(): {
    // javascript wrapper for 'gst_video_aggregator_get_execution_task_pool'
}

The returned Gst.TaskPool is used internally for performing parallel video format conversions/scaling/etc during the vfunc_prepare_frame_start() process. Subclasses can add their own operation to perform using the returned Gst.TaskPool during vfunc_aggregate_frames().

Since : 1.20

force-live

“force-live” Number

Causes the element to aggregate on a timeout even when no live source is connected to its sinks. See min-upstream-latency for a companion property: in the vast majority of cases where you plan to plug in live sources with a non-zero latency, you should set it to a non-zero value.

Flags : Read / Write / Construct Only

Since : 1.22

vfunc_aggregate_frames

function vfunc_aggregate_frames(videoaggregator: GstVideo.VideoAggregator, outbuffer: Gst.Buffer): {
    // javascript implementation of the 'aggregate_frames' virtual method
}

Lets subclasses aggregate frames that are ready. Subclasses should iterate the GstElement.sinkpads and use the already mapped GstVideo.VideoFrame from GstVideo.VideoAggregatorPad.prototype.get_prepared_frame or directly use the Gst.Buffer from GstVideo.VideoAggregatorPad.prototype.get_current_buffer if it needs to map the buffer in a special way. The result of the aggregation should land in outbuffer.

vfunc_create_output_buffer

function vfunc_create_output_buffer(videoaggregator: GstVideo.VideoAggregator, outbuffer: Gst.Buffer): {
    // javascript implementation of the 'create_output_buffer' virtual method
}

Optional. Lets subclasses provide a Gst.Buffer to be used as outbuffer of the aggregate_frames vmethod.

vfunc_find_best_format

function vfunc_find_best_format(vagg: GstVideo.VideoAggregator, downstream_caps: Gst.Caps, best_info: GstVideo.VideoInfo): {
    // javascript implementation of the 'find_best_format' virtual method
}

Optional. Lets subclasses decide of the best common format to use.

vfunc_update_caps

function vfunc_update_caps(videoaggregator: GstVideo.VideoAggregator, caps: Gst.Caps): {
    // javascript implementation of the 'update_caps' virtual method
}

Optional. Lets subclasses update the Gst.Caps representing the src pad caps before usage. Return null to indicate failure.

GstVideo.VideoAggregatorConvertPad

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Pad
                ╰──GstBase.AggregatorPad
                    ╰──GstVideo.VideoAggregatorPad
                        ╰──GstVideo.VideoAggregatorConvertPad
                            ╰──GstVideo.VideoAggregatorParallelConvertPad

Since : 1.16

GstVideo.VideoAggregatorConvertPad.prototype.update_conversion_info

function GstVideo.VideoAggregatorConvertPad.prototype.update_conversion_info(): {
    // javascript wrapper for 'gst_video_aggregator_convert_pad_update_conversion_info'
}

Requests the pad to check and update the converter before the next usage to update for any changes that have happened.

converter-config

“converter-config” Gst.Structure

Flags : Read / Write

vfunc_create_conversion_info

function vfunc_create_conversion_info(pad: GstVideo.VideoAggregatorConvertPad, agg: GstVideo.VideoAggregator, conversion_info: GstVideo.VideoInfo): {
    // javascript implementation of the 'create_conversion_info' virtual method
}

GstVideo.VideoAggregatorPad

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Pad
                ╰──GstBase.AggregatorPad
                    ╰──GstVideo.VideoAggregatorPad
                        ╰──GstGL.GLBaseMixerPad
                        ╰──GstVideo.VideoAggregatorConvertPad

Since : 1.16

GstVideo.VideoAggregatorPad.prototype.get_current_buffer

function GstVideo.VideoAggregatorPad.prototype.get_current_buffer(): {
    // javascript wrapper for 'gst_video_aggregator_pad_get_current_buffer'
}

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

This must only be called from the vfunc_aggregate_frames virtual method, or from the vfunc_prepare_frame virtual method of the aggregator pads.

The return value is only valid until vfunc_aggregate_frames or vfunc_prepare_frame returns.

GstVideo.VideoAggregatorPad.prototype.get_prepared_frame

function GstVideo.VideoAggregatorPad.prototype.get_prepared_frame(): {
    // javascript wrapper for 'gst_video_aggregator_pad_get_prepared_frame'
}

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

This must only be called from the vfunc_aggregate_frames virtual method, or from the vfunc_prepare_frame virtual method of the aggregator pads.

The return value is only valid until vfunc_aggregate_frames or vfunc_prepare_frame returns.

GstVideo.VideoAggregatorPad.prototype.has_current_buffer

function GstVideo.VideoAggregatorPad.prototype.has_current_buffer(): {
    // javascript wrapper for 'gst_video_aggregator_pad_has_current_buffer'
}

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 vfunc_aggregate_frames virtual method, or from the vfunc_prepare_frame virtual method of the aggregator pads.

GstVideo.VideoAggregatorPad.prototype.set_needs_alpha

function GstVideo.VideoAggregatorPad.prototype.set_needs_alpha(needs_alpha: Number): {
    // javascript wrapper for 'gst_video_aggregator_pad_set_needs_alpha'
}

Allows selecting that this pad requires an output format with alpha

max-last-buffer-repeat

“max-last-buffer-repeat” Number

Flags : Read / Write

repeat-after-eos

“repeat-after-eos” Number

Flags : Read / Write

zorder

“zorder” Number

Flags : Read / Write

vfunc_clean_frame

function vfunc_clean_frame(pad: GstVideo.VideoAggregatorPad, videoaggregator: GstVideo.VideoAggregator, prepared_frame: GstVideo.VideoFrame): {
    // javascript implementation of the 'clean_frame' virtual method
}

clean the frame previously prepared in prepare_frame

vfunc_prepare_frame

function vfunc_prepare_frame(pad: GstVideo.VideoAggregatorPad, videoaggregator: GstVideo.VideoAggregator, buffer: Gst.Buffer, prepared_frame: GstVideo.VideoFrame): {
    // javascript implementation of the 'prepare_frame' virtual method
}

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.

vfunc_prepare_frame_finish

function vfunc_prepare_frame_finish(pad: GstVideo.VideoAggregatorPad, videoaggregator: GstVideo.VideoAggregator, prepared_frame: GstVideo.VideoFrame): {
    // javascript implementation of the 'prepare_frame_finish' virtual method
}

Finish preparing prepared_frame.

If overriden, prepare_frame_start must also be overriden.

Since : 1.20

vfunc_prepare_frame_start

function vfunc_prepare_frame_start(pad: GstVideo.VideoAggregatorPad, videoaggregator: GstVideo.VideoAggregator, buffer: Gst.Buffer, prepared_frame: GstVideo.VideoFrame): {
    // javascript implementation of the 'prepare_frame_start' virtual method
}

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

If overriden, prepare_frame_finish must also be overriden.

Since : 1.20

vfunc_update_conversion_info

function vfunc_update_conversion_info(pad: GstVideo.VideoAggregatorPad): {
    // javascript implementation of the 'update_conversion_info' virtual method
}

Called when either the input or output formats have changed.

GstVideo.VideoAggregatorParallelConvertPad

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Pad
                ╰──GstBase.AggregatorPad
                    ╰──GstVideo.VideoAggregatorPad
                        ╰──GstVideo.VideoAggregatorConvertPad
                            ╰──GstVideo.VideoAggregatorParallelConvertPad

Since : 1.20