Enum gstreamer::PadProbeReturn

#[repr(i32)]
pub enum PadProbeReturn {
    Drop = 0,
    Ok = 1,
    Remove = 2,
    Pass = 3,
    Handled = 4,
}

Different return values for the GstPadProbeCallback.

Variants

Drop = 0

drop data in data probes. For push mode this means that the data item is not sent downstream. For pull mode, it means that the data item is not passed upstream. In both cases, no other probes are called for this item and FlowReturn::Ok or true is returned to the caller.

Ok = 1

normal probe return value. This leaves the probe in place, and defers decisions about dropping or passing data to other probes, if any. If there are no other probes, the default behaviour for the probe type applies (‘block’ for blocking probes, and ‘pass’ for non-blocking probes).

Remove = 2

remove this probe, passing the data. For blocking probes this will cause data flow to unblock, unless there are also other blocking probes installed.

Pass = 3

pass the data item in the block probe and block on the next item. Note, that if there are multiple pad probes installed and any probe returns PASS, the data will be passed.

Handled = 4

Data has been handled in the probe and will not be forwarded further. For events and buffers this is the same behaviour as Drop (except that in this case you need to unref the buffer or event yourself). For queries it will also return true to the caller. The probe can also modify the FlowReturn value by using the GST_PAD_PROBE_INFO_FLOW_RETURN() accessor. Note that the resulting query must contain valid entries. Since: 1.6

Trait Implementations

impl Clone for PadProbeReturn

fn clone(&self) -> PadProbeReturn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PadProbeReturn

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

Formats the value using the given formatter.

impl From<PadProbeReturn> for Value

fn from(v: PadProbeReturn) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for PadProbeReturn

type Checker = GenericValueTypeChecker<PadProbeReturn>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for PadProbeReturn

type ParamSpec = ParamSpecEnum

type SetValue = PadProbeReturn

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: PadProbeReturn) -> ParamSpecEnumBuilder<'_, PadProbeReturn>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PadProbeReturn

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PadProbeReturn

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PadProbeReturn

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PadProbeReturn

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for PadProbeReturn

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for PadProbeReturn

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for PadProbeReturn

type Type = PadProbeReturn

Type to get the Type from.

impl Copy for PadProbeReturn

impl Eq for PadProbeReturn

impl StructuralPartialEq for PadProbeReturn