Struct ambient_api_core::prelude::audio::SpatialAudioPlayer

pub struct SpatialAudioPlayer {
    pub player: EntityId,
}

Available on crate feature client only.

play spatial audio

Fields

player: EntityId

the entity that represents the spatial audio player

Implementations

impl SpatialAudioPlayer

pub fn new() -> Self

pub fn set_listener(&self, listener: EntityId)

pub fn set_emitter(&self, emitter: EntityId)

pub fn set_amplitude(&self, amp: f32)

pub fn set_looping(&self, val: bool)

pub fn play_sound_on_entity(&self, url: impl Into<String>, emitter: EntityId)

impl SpatialAudioPlayer

pub fn oneshot( position: Vec3, url: impl Into<String> ) -> Option<SpatialAudioPlayer>

Plays a sound at the given position. Note that the returned SpatialAudioPlayer will be removed after 60 seconds.

If no camera is available as a listener, no player will be created.

Trait Implementations

impl Clone for SpatialAudioPlayer

fn clone(&self) -> SpatialAudioPlayer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpatialAudioPlayer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpatialAudioPlayer

fn default() -> Self

Returns the “default value” for a type.