gstbase.flow_combiner

Module for [FlowCombiner] class

Types 1

Utility struct to help handling #GstFlowReturn combination. Useful for #GstElements that have multiple source pads and need to combine the different #GstFlowReturn for those pads.

#GstFlowCombiner works by using the last #GstFlowReturn for all #GstPad it has in its list and computes the combined return value and provides it to the caller.

To add a new pad to the #GstFlowCombiner use [gstbase.flow_combiner.FlowCombiner.addPad]. The new #GstPad is stored with a default value of [gst.types.FlowReturn.Ok].

In case you want a #GstPad to be removed, use [gstbase.flow_combiner.FlowCombiner.removePad].

Please be aware that this struct isn't thread safe as its designed to be used by demuxers, those usually will have a single thread operating it.

These functions will take refs on the passed #GstPads.

Aside from reducing the user's code size, the main advantage of using this helper struct is to follow the standard rules for #GstFlowReturn combination. These rules are:

[gst.types.FlowReturn.Eos]: only if all returns are EOS too
[gst.types.FlowReturn.NotLinked]: only if all returns are NOT_LINKED too
[gst.types.FlowReturn.Error] or below: if at least one returns an error return
[gst.types.FlowReturn.NotNegotiated]: if at least one returns a not-negotiated return
[gst.types.FlowReturn.Flushing]: if at least one returns flushing
[gst.types.FlowReturn.Ok]: otherwise

[gst.types.FlowReturn.Error] or below, GST_FLOW_NOT_NEGOTIATED and GST_FLOW_FLUSHING are returned immediately from the [gstbase.flow_combiner.FlowCombiner.updateFlow] function.

Methods

void * _cPtr(Flag!"Dup" dup = No.Dup)

GType _getGType()

GType _gType() @property

FlowCombiner self()Returns `this`, for use in `with` statements.

void addPad(gst.pad.Pad pad)Adds a new #GstPad to the #GstFlowCombiner.

void clear()Removes all pads from a #GstFlowCombiner and resets it to its initial state.

void removePad(gst.pad.Pad pad)Removes a #GstPad from the #GstFlowCombiner.

void reset()Reset flow combiner and all pads to their initial state without removing pads.

gst.types.FlowReturn updateFlow(gst.types.FlowReturn fret)Computes the combined flow return for the pads in it.

gst.types.FlowReturn updatePadFlow(gst.pad.Pad pad, gst.types.FlowReturn fret)Sets the provided pad's last flow return to provided value and computes the combined flow return for the pads in it.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new #GstFlowCombiner, use [gstbase.flow_combiner.FlowCombiner.free] to free it. Returns: A new #GstFlowCombiner