GI.GstBase.Structs.FlowCombiner

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

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 gst_flow_combiner_add_pad(). The new #GstPad is stored with a default value of %GST_FLOW_OK.

In case you want a #GstPad to be removed, use gst_flow_combiner_remove_pad().

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 #GstPad--s.

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_FLOW_EOS: only if all returns are EOS too
• %GST_FLOW_NOT_LINKED: only if all returns are NOT_LINKED too
• %GST_FLOW_ERROR or below: if at least one returns an error return
• %GST_FLOW_NOT_NEGOTIATED: if at least one returns a not-negotiated return
• %GST_FLOW_FLUSHING: if at least one returns flushing
• %GST_FLOW_OK: otherwise

%GST_FLOW_ERROR or below, GST_FLOW_NOT_NEGOTIATED and GST_FLOW_FLUSHING are returned immediatelly from the gst_flow_combiner_update_flow() function.

Exported types

newtype FlowCombiner

Constructors

FlowCombiner (ForeignPtr FlowCombiner)

Instances

BoxedObject FlowCombiner

((~) * signature (a -> FlowReturn -> m FlowReturn), MonadIO m, PadK a) => MethodInfo * FlowCombinerUpdatePadFlowMethodInfo FlowCombiner signature

((~) * signature (FlowReturn -> m FlowReturn), MonadIO m) => MethodInfo * FlowCombinerUpdateFlowMethodInfo FlowCombiner signature

((~) * signature (m ()), MonadIO m) => MethodInfo * FlowCombinerResetMethodInfo FlowCombiner signature

((~) * signature (a -> m ()), MonadIO m, PadK a) => MethodInfo * FlowCombinerRemovePadMethodInfo FlowCombiner signature

((~) * signature (m ()), MonadIO m) => MethodInfo * FlowCombinerFreeMethodInfo FlowCombiner signature

((~) * signature (m ()), MonadIO m) => MethodInfo * FlowCombinerClearMethodInfo FlowCombiner signature

((~) * signature (a -> m ()), MonadIO m, PadK a) => MethodInfo * FlowCombinerAddPadMethodInfo FlowCombiner signature

((~) * info (ResolveFlowCombinerMethod t FlowCombiner), MethodInfo * info FlowCombiner p) => IsLabelProxy t (FlowCombiner -> p)

type AttributeList FlowCombiner

noFlowCombiner :: Maybe FlowCombiner

Methods

flowCombinerAddPad

data FlowCombinerAddPadMethodInfo

Instances

((~) * signature (a -> m ()), MonadIO m, PadK a) => MethodInfo * FlowCombinerAddPadMethodInfo FlowCombiner signature

flowCombinerAddPad :: (MonadIO m, PadK a) => FlowCombiner -> a -> m ()

flowCombinerClear

data FlowCombinerClearMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * FlowCombinerClearMethodInfo FlowCombiner signature

flowCombinerClear :: MonadIO m => FlowCombiner -> m ()

flowCombinerFree

data FlowCombinerFreeMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * FlowCombinerFreeMethodInfo FlowCombiner signature

flowCombinerFree :: MonadIO m => FlowCombiner -> m ()

flowCombinerNew

flowCombinerNew :: MonadIO m => m FlowCombiner

flowCombinerRemovePad

data FlowCombinerRemovePadMethodInfo

Instances

((~) * signature (a -> m ()), MonadIO m, PadK a) => MethodInfo * FlowCombinerRemovePadMethodInfo FlowCombiner signature

flowCombinerRemovePad :: (MonadIO m, PadK a) => FlowCombiner -> a -> m ()

flowCombinerReset

data FlowCombinerResetMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * FlowCombinerResetMethodInfo FlowCombiner signature

flowCombinerReset :: MonadIO m => FlowCombiner -> m ()

flowCombinerUpdateFlow

data FlowCombinerUpdateFlowMethodInfo

Instances

((~) * signature (FlowReturn -> m FlowReturn), MonadIO m) => MethodInfo * FlowCombinerUpdateFlowMethodInfo FlowCombiner signature

flowCombinerUpdateFlow :: MonadIO m => FlowCombiner -> FlowReturn -> m FlowReturn

flowCombinerUpdatePadFlow

data FlowCombinerUpdatePadFlowMethodInfo

Instances

((~) * signature (a -> FlowReturn -> m FlowReturn), MonadIO m, PadK a) => MethodInfo * FlowCombinerUpdatePadFlowMethodInfo FlowCombiner signature

flowCombinerUpdatePadFlow :: (MonadIO m, PadK a) => FlowCombiner -> a -> FlowReturn -> m FlowReturn