Struct kira::manager::AudioManager

pub struct AudioManager<B: Backend> { /* private fields */ }

Controls audio from gameplay code.

Implementations

impl<B: Backend> AudioManager<B>

pub fn new(
    backend: B,
    settings: AudioManagerSettings
) -> Result<Self, B::InitError>

Creates a new AudioManager.

pub fn play<D: SoundData>(
    &mut self,
    sound_data: D
) -> Result<D::Handle, PlaySoundError<D::Error>>

Plays a sound.

pub fn add_sub_track(
    &mut self,
    builder: TrackBuilder
) -> Result<TrackHandle, AddSubTrackError>

Creates a mixer sub-track.

pub fn add_clock(
    &mut self,
    speed: ClockSpeed
) -> Result<ClockHandle, AddClockError>

Creates a clock.

pub fn pause(&mut self, fade_out_tween: Tween) -> Result<(), CommandError>

Fades out and pauses all audio.

pub fn resume(&mut self, fade_out_tween: Tween) -> Result<(), CommandError>

Resumes and fades in all audio.

pub fn main_track(&self) -> TrackHandle

Returns a handle to the main mixer track.

pub fn state(&self) -> MainPlaybackState

Returns the current playback state of the audio.

pub fn sound_capacity(&self) -> usize

Returns the number of sounds that can be loaded at a time.

pub fn sub_track_capacity(&self) -> usize

Returns the number of mixer sub-tracks that can exist at a time.

pub fn clock_capacity(&self) -> usize

Returns the number of clocks that can exist at a time.

pub fn num_sounds(&self) -> usize

Returns the number of sounds that are currently loaded.

pub fn num_sub_tracks(&self) -> usize

Returns the number of mixer sub-tracks that currently exist.

pub fn num_clocks(&self) -> usize

Returns the number of clocks that currently exist.

pub fn backend_mut(&mut self) -> &mut B

Returns a mutable reference to this manager’s backend.