Enum tetra::audio::SoundState

pub enum SoundState {
    Playing,
    Paused,
    Stopped,
}

The states that playback of a SoundInstance can be in.

Variants

Playing

The sound is currently playing.

If a SoundInstance is created via Sound::play, Sound::play_with, Sound::repeat or Sound::repeat_with, it will be in this state initially.

Paused

The sound is paused. If playback is resumed, it will continue from the point where it was paused.

If a SoundInstance is created via Sound::spawn or Sound::spawn_with, it will be in this state initially.

Stopped

The sound has stopped, either manually or as a result of it reaching the end of the audio data. If playback is resumed, it will start over from the beginning of the sound.

This state will never occur while a SoundInstance is set to be repeating.

Trait Implementations

impl Clone for SoundState

fn clone(&self) -> SoundState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SoundState

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

Formats the value using the given formatter.

impl PartialEq<SoundState> for SoundState

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

impl Eq for SoundState

impl StructuralEq for SoundState

impl StructuralPartialEq for SoundState