pub struct AudioBuses { /* private fields */ }Expand description
Flat named buses under master; music/sfx are available by default. Muting affects gain only; envelopes and stream clocks continue advancing.
Implementations§
Source§impl AudioBuses
impl AudioBuses
Sourcepub fn add(&mut self, name: &str) -> Result<BusId, AudioError>
pub fn add(&mut self, name: &str) -> Result<BusId, AudioError>
Adds a game-defined bus, or returns the existing handle for that name.
Sourcepub fn settings_for(&self, id: BusId) -> Result<BusSettings, AudioError>
pub fn settings_for(&self, id: BusId) -> Result<BusSettings, AudioError>
Reads persistent controls, independent of ducking and parent gain.
Sourcepub fn set_volume(&mut self, id: BusId, volume: f32) -> Result<(), AudioError>
pub fn set_volume(&mut self, id: BusId, volume: f32) -> Result<(), AudioError>
Sets a user volume; rejects nonfinite/out-of-range values.
Sourcepub fn set_muted(&mut self, id: BusId, muted: bool) -> Result<(), AudioError>
pub fn set_muted(&mut self, id: BusId, muted: bool) -> Result<(), AudioError>
Mutes a bus, preserving the stored volume.
Sourcepub fn duck(
&mut self,
id: BusId,
gain: f32,
duration: Duration,
) -> Result<(), AudioError>
pub fn duck( &mut self, id: BusId, gain: f32, duration: Duration, ) -> Result<(), AudioError>
Fades a transient multiplier, e.g. 0.25 while a pause menu covers play. This does not alter the persisted user volume.
Sourcepub fn gain(&self, id: BusId) -> Result<f32, AudioError>
pub fn gain(&self, id: BusId) -> Result<f32, AudioError>
Effective bus gain, including master exactly once.
Sourcepub fn advance(&mut self, delta: Duration)
pub fn advance(&mut self, delta: Duration)
Advances every duck envelope by one frame’s wall time.
Sourcepub fn settings(&self) -> AudioSettings
pub fn settings(&self) -> AudioSettings
Captures user values for serialization into the game’s save container.
Sourcepub fn apply_settings(
&mut self,
settings: &AudioSettings,
) -> Result<(), AudioError>
pub fn apply_settings( &mut self, settings: &AudioSettings, ) -> Result<(), AudioError>
Atomically applies named settings, creating extra buses when needed. Unlisted buses and all transient duck envelopes retain their values.