Struct bones_framework::audio::audio_manager::AudioManager

pub struct AudioManager(/* private fields */);

The audio manager resource which can be used to play sounds.

Methods from Deref<Target = KiraAudioManager<CpalWithFallbackBackend>>

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

where D: SoundData,

Plays a sound.

Examples

use kira::sound::static_sound::{StaticSoundData, StaticSoundSettings};

let sound_data = StaticSoundData::from_file("sound.ogg")?;
manager.play(sound_data)?;

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

Creates a mixer sub-track.

pub fn add_clock( &mut self, speed: impl Into<Value<ClockSpeed>>, ) -> Result<ClockHandle, ResourceLimitReached>

Creates a clock.

Examples

let clock = manager.add_clock(ClockSpeed::TicksPerMinute(120.0))?;

pub fn add_spatial_scene( &mut self, settings: SpatialSceneSettings, ) -> Result<SpatialSceneHandle, ResourceLimitReached>

Creates a spatial scene.

pub fn add_modulator<Builder>( &mut self, builder: Builder, ) -> Result<<Builder as ModulatorBuilder>::Handle, ResourceLimitReached>

where Builder: ModulatorBuilder,

Creates a modulator.

Examples

use kira::modulator::lfo::LfoBuilder;

let modulator = manager.add_modulator(LfoBuilder::new())?;

pub fn main_track(&mut self) -> &mut TrackHandle

Returns a handle to the main mixer track.

Examples

Use the main track handle to adjust the volume of all audio:

use kira::tween::Tween;

manager.main_track().set_volume(0.5, Tween::default());

pub fn sound_capacity(&self) -> u16

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

pub fn sub_track_capacity(&self) -> u16

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

pub fn clock_capacity(&self) -> u16

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

pub fn spatial_scene_capacity(&self) -> u16

Returns the number of spatial scenes that can exist at a time.

pub fn modulator_capacity(&self) -> u16

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

pub fn num_sounds(&self) -> u16

Returns the number of sounds that are currently loaded.

pub fn num_sub_tracks(&self) -> u16

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

pub fn num_clocks(&self) -> u16

Returns the number of clocks that currently exist.

pub fn num_spatial_scenes(&self) -> u16

Returns the number of spatial scenes that currently exist.

pub fn num_modulators(&self) -> u16

Returns the number of modulators that currently exist.

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

Returns a mutable reference to this manager’s backend.

Trait Implementations

impl Default for AudioManager

fn default() -> Self

Returns the “default value” for a type.

impl Deref for AudioManager

type Target = AudioManager<CpalWithFallbackBackend>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for AudioManager

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl HasSchema for AudioManager

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry.

fn cast<T>(this: &Self) -> &T

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn cast_mut<T>(this: &mut Self) -> &mut T

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn as_schema_ref(&self) -> SchemaRef<'_>

where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>

where Self: Sized,

Converts a reference of T to a SchemaRefMut