Enum gstreamer::StateChange

#[non_exhaustive]
pub enum StateChange {
    NullToReady,
    ReadyToPaused,
    PausedToPlaying,
    PlayingToPaused,
    PausedToReady,
    ReadyToNull,
    NullToNull,
    ReadyToReady,
    PausedToPaused,
    PlayingToPlaying,
    // some variants omitted
}

These are the different state changes an element goes through. State::Null ⇒ State::Playing is called an upwards state change and State::Playing ⇒ State::Null a downwards state change.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NullToReady

state change from NULL to READY.

• The element must check if the resources it needs are available. Device sinks and -sources typically try to probe the device to constrain their caps.
• The element opens the device (in case feature need to be probed).

ReadyToPaused

state change from READY to PAUSED.

• The element pads are activated in order to receive data in PAUSED. Streaming threads are started.
• Some elements might need to return StateChangeReturn::Async and complete the state change when they have enough information. It is a requirement for sinks to return StateChangeReturn::Async and complete the state change when they receive the first buffer or EventType::Eos (preroll). Sinks also block the dataflow when in PAUSED.
• A pipeline resets the running_time to 0.
• Live sources return StateChangeReturn::NoPreroll and don’t generate data.

PausedToPlaying

state change from PAUSED to PLAYING.

• Most elements ignore this state change.
• The pipeline selects a Clock and distributes this to all the children before setting them to PLAYING. This means that it is only allowed to synchronize on the Clock in the PLAYING state.
• The pipeline uses the Clock and the running_time to calculate the base_time. The base_time is distributed to all children when performing the state change.
• Sink elements stop blocking on the preroll buffer or event and start rendering the data.
• Sinks can post GST_MESSAGE_EOS in the PLAYING state. It is not allowed to post GST_MESSAGE_EOS when not in the PLAYING state.
• While streaming in PAUSED or PLAYING elements can create and remove sometimes pads.
• Live sources start generating data and return StateChangeReturn::Success.

PlayingToPaused

state change from PLAYING to PAUSED.

• Most elements ignore this state change.
• The pipeline calculates the running_time based on the last selected Clock and the base_time. It stores this information to continue playback when going back to the PLAYING state.
• Sinks unblock any Clock wait calls.
• When a sink does not have a pending buffer to play, it returns StateChangeReturn::Async from this state change and completes the state change when it receives a new buffer or an EventType::Eos.
• Any queued GST_MESSAGE_EOS items are removed since they will be reposted when going back to the PLAYING state. The EOS messages are queued in Bin containers.
• Live sources stop generating data and return StateChangeReturn::NoPreroll.

PausedToReady

state change from PAUSED to READY.

• Sinks unblock any waits in the preroll.
• Elements unblock any waits on devices
• Chain or get_range functions return FlowReturn::Flushing.
• The element pads are deactivated so that streaming becomes impossible and all streaming threads are stopped.
• The sink forgets all negotiated formats
• Elements remove all sometimes pads

ReadyToNull

state change from READY to NULL.

• Elements close devices
• Elements reset any internal state.

NullToNull

state change from NULL to NULL. (Since: 1.14)

ReadyToReady

state change from READY to READY, This might happen when going to PAUSED asynchronously failed, in that case elements should make sure they are in a proper, coherent READY state. (Since: 1.14)

PausedToPaused

state change from PAUSED to PAUSED. This might happen when elements were in PLAYING state and ‘lost state’, they should make sure to go back to real ‘PAUSED’ state (prerolling for example). (Since: 1.14)

PlayingToPlaying

state change from PLAYING to PLAYING. (Since: 1.14)

Implementations

impl StateChange

pub fn new(current: State, next: State) -> Self

pub fn current(self) -> State

pub fn next(self) -> State

pub fn name<'a>(self) -> &'a str

Trait Implementations

impl Clone for StateChange

fn clone(&self) -> StateChange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StateChange

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

Formats the value using the given formatter.

impl Display for StateChange

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

Formats the value using the given formatter.

impl<'a> FromValue<'a> for StateChange

type Checker = GenericValueTypeChecker<Self>

Value type checker.

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

Get the contained value from a Value.

impl Hash for StateChange

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 StateChange

fn cmp(&self, other: &StateChange) -> 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<StateChange> for StateChange

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

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

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

This method tests for !=.

impl PartialOrd<StateChange> for StateChange

fn partial_cmp(&self, other: &StateChange) -> 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 StateChange

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for StateChange

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ValueType for StateChange

type Type = Self

Type to get the Type from.

impl Copy for StateChange

impl Eq for StateChange

impl StructuralEq for StateChange

impl StructuralPartialEq for StateChange