Struct AudioBus 

pub struct AudioBus {
    pub master_volume: f32,
    pub muted: bool,
    pub reverb: f32,
    pub reverb_room_ms: f32,
    pub music_volume: f32,
    pub effects_volume: f32,
    /* private fields */
}

Pending audio requests and the master volume. Lives in the scene, is never saved.

Fields

master_volume: f32

Gain applied to everything, 0..1.

muted: bool

Silences every sound without losing their state.

reverb: f32

Room echo added to sounds started from now on, 0 (dry) .. 1 (cathedral).

reverb_room_ms: f32

Size of the room for the echo: delay of the first reflection in milliseconds (20 small room .. 120 hall).

music_volume: f32

Separate gain of music (2D looping clips started with play_music).

effects_volume: f32

Separate gain of every other sound.

Implementations

impl AudioBus

pub fn play_with( &mut self, clip: &str, volume: f32, pitch: f32, pan: f32, looped: bool, ) -> SoundId

Plays a clip with every option at once (used by the editor’s sound panel).

pub fn play(&mut self, clip: &str, volume: f32) -> SoundId

Plays a clip in 2D at the given volume.

pub fn play_loop(&mut self, clip: &str, volume: f32) -> SoundId

Plays a looping clip in 2D (music, ambience). Stop it with Self::stop.

pub fn play_panned(&mut self, clip: &str, volume: f32, pan: f32) -> SoundId

Plays a clip with a stereo position: pan -1 is fully left, +1 fully right.

pub fn play_pitched(&mut self, clip: &str, volume: f32, pitch: f32) -> SoundId

Plays a clip with a speed / pitch change (pitch 2.0 is an octave higher and twice as fast).

pub fn play_at(&mut self, clip: &str, volume: f32, position: Vec3) -> SoundId

Plays a clip at a world position: it gets quieter with distance and pans left/right.

pub fn stop(&mut self, id: SoundId)

Stops one sound.

pub fn stop_all(&mut self)

Stops all sounds.

pub fn set_volume(&mut self, id: SoundId, volume: f32)

Changes the gain of a running sound (fade-outs, ducking).

pub fn drain(&mut self) -> Vec<AudioCmd>

Takes the queued requests; the backend calls this once per frame.

Trait Implementations

impl Clone for AudioBus

fn clone(&self) -> AudioBus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioBus

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

Formats the value using the given formatter.

impl Default for AudioBus

fn default() -> Self

Returns the “default value” for a type.