Struct SoundEffect

pub struct SoundEffect { /* private fields */ }

Sound effect (although it can also be used for music) You must call SoundEffect::update or SoundEffect::update_secs with accurate values and often otherwise playback may stutter or jump

Usage

//this must live as long as `sound` but there's no lifetimes to enforce this
let mut engine = AudioEngine::new().unwrap();
let mut sound = engine.load_from_bytes(&BYTES, duration).unwrap();
sound.play();
loop {
    timing.update();
    sound.update(&timing);
}

Implementations

impl SoundEffect

pub fn new(sound: Sound, duration: f64) -> SoundEffect

pub fn play(&mut self)

Play sound effect, won’t do anything if sound effect is already playing

pub fn reset(&mut self)

Reset playback position and stop playback

pub fn set_loop(&mut self, loops: bool)

Set if the sound loops automatically

pub fn set_volume(&mut self, volume: f32)

pub fn can_play(&self) -> bool

Returns true if calling SoundEffect::play will do anything

pub fn update(&mut self, timing: &Timing)

Allows the sound to continue playing

pub fn update_secs(&mut self, delta: f64)

Allows the sound to continue playing

pub fn is_playing(&self) -> bool

If the sound is currently playing

pub fn duration(&self) -> f64

Length in seconds

pub fn loops(&self) -> bool

If sound will automatically loop

Trait Implementations

impl Debug for SoundEffect

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

Formats the value using the given formatter.