Enum bevy_kira_audio::PlaybackState

pub enum PlaybackState {
    Paused {
        position: f64,
    },
    Pausing {
        position: f64,
    },
    Playing {
        position: f64,
    },
    Queued,
    Stopped,
    Stopping {
        position: f64,
    },
}

Playback status of a currently playing sound.

Variants

Paused

Fields

position: f64

Current playback position in seconds

The instance is paused.

Pausing

Fields

position: f64

Current playback position in seconds

The instance is fading out and will be paused when the fadeout is finished.

Playing

Fields

position: f64

Current playback position in seconds

The instance is playing.

Queued

The instance is queued

Stopped

The instance cannot be found anymore. This might might mean it was playing before and is stopped now, or it never played in the channel were you asked for it.

Stopping

Fields

position: f64

Current playback position in seconds

The instance is fading out and will be stopped when the fadeout is finished.

Implementations

impl PlaybackState

pub fn position(&self) -> Option<f64>

Get the playback position in seconds

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

Formats the value using the given formatter.

impl From<&StaticSoundHandle> for PlaybackState

fn from(sound_handle: &StaticSoundHandle) -> Self

Converts to this type from the input type.

impl From<StaticSoundHandle> for PlaybackState

fn from(sound_handle: StaticSoundHandle) -> Self

Converts to this type from the input type.

impl PartialEq for PlaybackState

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

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

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

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

impl PartialOrd for PlaybackState

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

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

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

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

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

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

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

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

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

impl StructuralPartialEq for PlaybackState