Struct bevy::audio::prelude::SpatialAudioSink

pub struct SpatialAudioSink { /* private fields */ }

Used to control spatial audio during playback.

Bevy inserts this component onto your entities when it begins playing an audio source that’s configured to use spatial audio.

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

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

Implementations

impl SpatialAudioSink

pub fn set_ears_position(&self, left_position: Vec3, right_position: Vec3)

Set the two ears position.

pub fn set_listener_position(&self, position: Transform, gap: f32)

Set the listener position, with an ear on each side separated by gap.

pub fn set_emitter_position(&self, position: Vec3)

Set the emitter position.

Trait Implementations

impl AudioSinkPlayback for SpatialAudioSink

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 SpatialAudioSink

where SpatialAudioSink: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.