Struct gstreamer_base::FlowCombiner

pub struct FlowCombiner(_);

Utility struct to help handling gst::FlowReturn combination. Useful for gst::Elements that have multiple source pads and need to combine the different gst::FlowReturn for those pads.

FlowCombiner works by using the last gst::FlowReturn for all gst::Pad it has in its list and computes the combined return value and provides it to the caller.

To add a new pad to the FlowCombiner use add_pad(). The new gst::Pad is stored with a default value of gst::FlowReturn::Ok.

In case you want a gst::Pad to be removed, use 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 gst::Pads.

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

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

gst::FlowReturn::Error or below, GST_FLOW_NOT_NEGOTIATED and GST_FLOW_FLUSHING are returned immediately from the update_flow() function.

Implementations

impl FlowCombiner

pub fn new() -> Self

Creates a new FlowCombiner, use gst_flow_combiner_free() to free it.

Returns

A new FlowCombiner

pub fn add_pad<P: IsA<Pad>>(&self, pad: &P)

Adds a new gst::Pad to the FlowCombiner.

pad

the gst::Pad that is being added

pub fn clear(&self)

Removes all pads from a FlowCombiner and resets it to its initial state.

pub fn remove_pad<P: IsA<Pad>>(&self, pad: &P)

Removes a gst::Pad from the FlowCombiner.

pad

the gst::Pad to remove

pub fn reset(&self)

Reset flow combiner and all pads to their initial state without removing pads.

pub fn update_flow<FRet: Into<FlowReturn>>(
    &self,
    fret: FRet
) -> Result<FlowSuccess, FlowError>

Computes the combined flow return for the pads in it.

The gst::FlowReturn parameter should be the last flow return update for a pad in this FlowCombiner. It will use this value to be able to shortcut some combinations and avoid looking over all pads again. e.g. The last combined return is the same as the latest obtained gst::FlowReturn.

fret

the latest gst::FlowReturn received for a pad in this FlowCombiner

Returns

The combined gst::FlowReturn

pub fn update_pad_flow<P: IsA<Pad>, FRet: Into<FlowReturn>>(
    &self,
    pad: &P,
    fret: FRet
) -> Result<FlowSuccess, FlowError>

Sets the provided pad’s last flow return to provided value and computes the combined flow return for the pads in it.

The gst::FlowReturn parameter should be the last flow return update for a pad in this FlowCombiner. It will use this value to be able to shortcut some combinations and avoid looking over all pads again. e.g. The last combined return is the same as the latest obtained gst::FlowReturn.

pad

the gst::Pad whose gst::FlowReturn to update

fret

the latest gst::FlowReturn received for a pad in this FlowCombiner

Returns

The combined gst::FlowReturn

Trait Implementations

impl Clone for FlowCombiner

fn clone(&self) -> FlowCombiner

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FlowCombiner

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FlowCombiner

fn default() -> Self

Returns the “default value” for a type.

impl Hash for FlowCombiner

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for FlowCombiner

fn cmp(&self, other: &FlowCombiner) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<FlowCombiner> for FlowCombiner

fn eq(&self, other: &FlowCombiner) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FlowCombiner) -> bool

This method tests for !=.

impl PartialOrd<FlowCombiner> for FlowCombiner

fn partial_cmp(&self, other: &FlowCombiner) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FlowCombiner

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FlowCombiner

impl StructuralEq for FlowCombiner

impl StructuralPartialEq for FlowCombiner