Enum PlaybackState

pub enum PlaybackState {
    Playing,
    Pausing,
    Paused,
    WaitingToResume,
    Resuming,
    Stopping,
    Stopped,
}

Available on crate feature dep_kira only.

The playback state of a sound.

Variants

Playing

The sound is playing normally.

Pausing

The sound is fading out, and when the fade-out is finished, playback will pause.

Paused

Playback is paused.

WaitingToResume

The sound is paused, but is schedule to resume in the future.

Resuming

The sound is fading back in after being previously paused.

Stopping

The sound is fading out, and when the fade-out is finished, playback will stop.

Stopped

The sound has stopped and can no longer be resumed.

Implementations

impl PlaybackState

pub fn is_advancing(self) -> bool

Whether the sound is advancing and outputting audio given its current playback state.

Trait Implementations

impl Clone for PlaybackState

fn clone(&self) -> PlaybackState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlaybackState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlaybackState

fn deserialize<__D>( __deserializer: __D, ) -> Result<PlaybackState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PlaybackState> for TrackPlaybackState

fn from(value: PlaybackState) -> TrackPlaybackState

Converts to this type from the input type.

impl Hash for PlaybackState

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

where __H: Hasher,

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 PartialEq for PlaybackState

fn eq(&self, other: &PlaybackState) -> 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 Serialize for PlaybackState

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PlaybackState

impl Eq for PlaybackState

impl StructuralPartialEq for PlaybackState