Struct ambient_api_core::prelude::audio::AudioPlayer

pub struct AudioPlayer {
    pub entity: EntityId,
}

Available on crate feature client only.

Play the audio file at the given URL.

Fields

entity: EntityId

The entity that represents the audio player

Implementations

impl AudioPlayer

pub fn new() -> Self

Create new audio player from URL

pub fn set_looping(&self, val: bool)

Set the sound looping or not

pub fn add_one_pole_lpf(&self, rolloff_freq: f32)

Add a simple onepole lowpass filter to the sound with one param: roll off frequency

pub fn set_amplitude(&self, amp: f32)

Set the amp/volume of the sound 0.0 is 0%, 1.0 is 100%

pub fn set_panning(&self, pan: f32)

Set the panning of the sound -1.0 is 100% left, 1.0 is 100% right.

pub fn play(&self, url: String) -> EntityId

Play the sound, this will generate a new entity that represents the playing sound.

Trait Implementations

impl Clone for AudioPlayer

fn clone(&self) -> AudioPlayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioPlayer

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

Formats the value using the given formatter.

impl Default for AudioPlayer

fn default() -> Self

Returns the “default value” for a type.