Trait bevy::audio::AudioSinkPlayback
pub trait AudioSinkPlayback {
// Required methods
fn volume(&self) -> f32;
fn set_volume(&self, volume: f32);
fn speed(&self) -> f32;
fn set_speed(&self, speed: f32);
fn play(&self);
fn pause(&self);
fn is_paused(&self) -> bool;
fn stop(&self);
fn empty(&self) -> bool;
// Provided method
fn toggle(&self) { ... }
}
Expand description
Common interactions with an audio sink.
Required Methods§
fn volume(&self) -> f32
fn volume(&self) -> f32
Gets the volume of the sound.
The value 1.0
is the “normal” volume (unfiltered input). Any value other than 1.0
will multiply each sample by this value.
fn set_volume(&self, volume: f32)
fn set_volume(&self, volume: f32)
Changes the volume of the sound.
The value 1.0
is the “normal” volume (unfiltered input). Any value other than 1.0
will multiply each sample by this value.
fn speed(&self) -> f32
fn speed(&self) -> f32
Gets the speed of the sound.
The value 1.0
is the “normal” speed (unfiltered input). Any value other than 1.0
will change the play speed of the sound.
fn set_speed(&self, speed: f32)
fn set_speed(&self, speed: f32)
Changes the speed of the sound.
The value 1.0
is the “normal” speed (unfiltered input). Any value other than 1.0
will change the play speed of the sound.
fn play(&self)
fn play(&self)
Resumes playback of a paused sink.
No effect if not paused.
fn pause(&self)
fn pause(&self)
Pauses playback of this sink.
No effect if already paused.
A paused sink can be resumed with play
.
fn stop(&self)
fn stop(&self)
Stops the sink.
It won’t be possible to restart it afterwards.
Provided Methods§
fn toggle(&self)
fn toggle(&self)
Toggles the playback of this sink.
Will pause if playing, and will be resumed if paused.