Struct bevy_audio::AudioSink

pub struct AudioSink { /* private fields */ }

Used to control audio during playback.

Bevy inserts this component onto your entities when it begins playing an audio source. Use AudioBundle to trigger that to happen.

You can use this component to modify the playback settings while the audio is playing.

If this component is removed from an entity, and an AudioSource is attached to that entity, that AudioSource will start playing. If that source is unchanged, that translates to the audio restarting.

Trait Implementations

impl AudioSinkPlayback for AudioSink

fn volume(&self) -> f32

Gets the volume of the sound.

fn set_volume(&self, volume: f32)

Changes the volume of the sound.

fn speed(&self) -> f32

Gets the speed of the sound.

fn set_speed(&self, speed: f32)

Changes the speed of the sound.

fn play(&self)

Resumes playback of a paused sink.

fn pause(&self)

Pauses playback of this sink.

fn is_paused(&self) -> bool

Is this sink paused?

fn stop(&self)

Stops the sink.

fn empty(&self) -> bool

Returns true if this sink has no more sounds to play.

fn toggle(&self)

Toggles the playback of this sink.

impl Component for AudioSink

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.