Struct 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 new(sink: SpatialSink) -> SpatialAudioSink

Create a new spatial audio sink.

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) -> Volume

Gets the volume of the sound as a Volume.

fn set_volume(&mut self, volume: Volume)

Changes the volume of the sound to the given Volume.

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

Returns true if the sink is paused.

fn stop(&self)

Stops the sink.

fn empty(&self) -> bool

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

fn is_muted(&self) -> bool

Returns true if the sink is muted.

fn mute(&mut self)

Mutes the sink.

fn unmute(&mut self)

Unmutes the sink.

fn toggle_playback(&self)

Toggles playback of the sink.

fn toggle_mute(&mut self)

Toggles whether the sink is muted or not.

impl Component for SpatialAudioSink

where SpatialAudioSink: Send + Sync + 'static,

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

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

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

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]