Struct tetra::audio::SoundInstance

pub struct SoundInstance { /* fields omitted */ }

A handle to a single instance of a Sound.

The audio thread will poll this for updates every 220 samples (roughly every 5ms at a 44100hz sample rate).

Cloning a SoundInstance will create a new handle to the same instance, rather than creating a new instance.

Note that dropping a SoundInstance does not stop playback, and the underlying data will not be freed until playback has finished. This means that dropping a repeating SoundInstance without stopping it first will cause the sound to loop forever.

Implementations

impl SoundInstance

pub fn play(&self)

Plays the sound if it is stopped, or resumes the sound if it is paused.

pub fn stop(&self)

Stops the sound. If playback is resumed, it will start over from the beginning.

pub fn pause(&self)

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

pub fn state(&self) -> SoundState

Returns the current state of playback.

pub fn set_state(&self, state: SoundState)

Sets the current state of playback.

In most cases, using the play, stop and pause methods is easier than explicitly setting a state, but this may be useful when, for example, defining transitions from one state to another.

pub fn set_volume(&self, volume: f32)

Sets the volume of the sound.

The parameter is used as a multiplier - for example, 1.0 would result in the sound being played back at its original volume.

pub fn set_speed(&self, speed: f32)

Sets the speed (and by extension, the pitch) of the sound.

The parameter is used as a multiplier - for example, 1.0 would result in the sound being played back at its original speed.

pub fn set_repeating(&self, repeating: bool)

Sets whether the sound should repeat or not.

pub fn toggle_repeating(&self)

Toggles whether the sound should repeat or not.

Trait Implementations

impl Clone for SoundInstance

fn clone(&self) -> SoundInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SoundInstance

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

Formats the value using the given formatter.