Struct SoundData 

pub struct SoundData { /* private fields */ }

A sound’s samples, or the loaded bytes they are decoded from.

Build one by hand for computed audio; a loaded one comes from Assets::sound.

Implementations

impl SoundData

pub fn mono(rate: u32, samples: Vec<f32>) -> Self

A sound of rate frames a second, one sample per frame.

The rate must be more than zero; checked only in debug builds.

pub fn stereo(rate: u32, samples: Vec<f32>) -> Self

A sound of rate frames a second, samples interleaved left then right.

The rate must be more than zero and the length even; checked only in debug builds.

pub fn duration(&self) -> Duration

How long the sound plays for, at its own pitch.

pub fn streamed(self) -> Self

Decodes the sound while it plays, in place of keeping every sample in memory.

For music and other long loaded clips. A sound built by hand is already in memory, so this returns it as it is, with a debug log.

Examples found in repository

examples/breakout-game.rs (line 213)

    fn build(&self, assets: &Assets) -> SoundData {
        match self {
            Sound::Serve => assets.sound("serve"),
            Sound::BallLost => assets.sound("lost"),
            Sound::LevelClear => assets.sound("win"),
            Sound::GameOver => assets.sound("gameover"),
            Sound::Bounce => assets.sound("bounce"),
            Sound::BrickBreak => assets.sound("break"),
            Sound::Music => assets.sound("music").streamed(),
            Sound::MenuMusic => assets.sound("menu_music").streamed(),
            Sound::Click => assets.sound("click"),
        }
    }

examples/sound-lab.rs (line 282)

    fn build(&self, assets: &Assets) -> SoundData {
        match self {
            Sound::Bounce => assets.sound("bounce"),
            Sound::Break => assets.sound("break"),
            Sound::Serve => assets.sound("serve"),
            Sound::GameOver => assets.sound("gameover"),
            Sound::Lost => assets.sound("lost"),
            Sound::Win => assets.sound("win"),
            Sound::Click => assets.sound("click"),
            Sound::Theme => assets.sound("music").streamed(),
            Sound::ThemeDecoded => assets.sound("music"),
            Sound::MenuTheme => assets.sound("menu_music").streamed(),
            Sound::Pulse => assets.sound("break"),
        }
    }

Trait Implementations

impl Clone for SoundData

fn clone(&self) -> SoundData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundData

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

Formats the value using the given formatter.