Struct tetra::audio::SoundInstance [−][src]
pub struct SoundInstance { /* fields omitted */ }
Expand description
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
Stops the sound. If playback is resumed, it will start over from the beginning.
Pauses the sound. If playback is resumed, it will continue from the point where it was paused.
Returns the current state of playback.
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.
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.
Sets whether the sound should repeat or not.
Toggles whether the sound should repeat or not.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for SoundInstance
impl Send for SoundInstance
impl Sync for SoundInstance
impl Unpin for SoundInstance
impl UnwindSafe for SoundInstance
Blanket Implementations
Mutably borrows from an owned value. Read more