Struct SoundHandle 

pub struct SoundHandle { /* private fields */ }

Controls one playing sound instance, as returned by crate::Audio::play and friends.

Dropping the handle does not stop the sound; it keeps playing until it ends (or forever, if it loops). Clones refer to the same instance.

A handle can exist before the sound actually plays: a sound started with crate::PlayOptions::deferred before audio is available (on the web, before the first user gesture) is pending. Volume, pause and stop calls on a pending handle are remembered and applied when the sound starts.

Implementations

impl SoundHandle

pub fn set_volume(&self, volume: f32)

Set the volume as a linear amplitude (1.0 is the sound’s own level, 0.0 silence).

pub fn set_volume_db(&self, db: f32)

Set the volume in decibels (0.0 is the sound’s own level, -6.0 roughly half).

pub fn fade_volume(&self, volume: f32, duration: Duration)

Fade the volume to a linear amplitude over duration.

pub fn fade_volume_db(&self, db: f32, duration: Duration)

Fade the volume to db decibels over duration.

pub fn pause(&self)

Pause playback. SoundHandle::resume continues where it left off.

pub fn resume(&self)

Resume a paused sound.

pub fn stop(&self)

Stop the sound for good. A stopped sound can’t be resumed; play it again instead.

pub fn is_playing(&self) -> bool

Whether the sound is currently audible: playing, or fading in or out. false while paused, pending or finished.

pub fn is_paused(&self) -> bool

Whether the sound is paused (or will start paused, if pending).

pub fn is_pending(&self) -> bool

Whether the sound is still waiting for audio to start (see crate::PlayOptions::deferred).

pub fn is_finished(&self) -> bool

Whether the sound has ended or was stopped. A looping sound only finishes when stopped.

pub fn with_kira<R>( &self, f: impl FnOnce(&mut StaticSoundHandle) -> R, ) -> Option<R>

Run f on the underlying kira handle, for anything this type doesn’t cover (playback rate, panning, seeking). None while the sound is pending or was cancelled.

Trait Implementations

impl Clone for SoundHandle

fn clone(&self) -> SoundHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundHandle

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

Formats the value using the given formatter.