Struct kira::manager::AudioManagerSettings

#[non_exhaustive]
pub struct AudioManagerSettings {
    pub command_capacity: usize,
    pub sound_capacity: usize,
    pub sub_track_capacity: usize,
    pub clock_capacity: usize,
    pub main_track_builder: TrackBuilder,
}

Settings for an AudioManager.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

command_capacity: usize

The number of commands that be sent to the renderer at a time.

Each action you take, like playing a sound or pausing a clock, queues up one command.

sound_capacity: usize

The maximum number of sounds that can be playing at a time.

sub_track_capacity: usize

The maximum number of mixer sub-tracks that can exist at a time.

clock_capacity: usize

The maximum number of clocks that can exist at a time.

main_track_builder: TrackBuilder

Configures the main mixer track.

Implementations

impl AudioManagerSettings

pub fn new() -> Self

Creates a new AudioManagerSettings with the default settings.

pub fn command_capacity(self, command_capacity: usize) -> Self

Sets the number of commands that be sent to the renderer at a time.

Each action you take, like playing a sound or pausing a clock, queues up one command.

pub fn sound_capacity(self, sound_capacity: usize) -> Self

Sets the maximum number of sounds that can be playing at a time.

pub fn sub_track_capacity(self, sub_track_capacity: usize) -> Self

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

pub fn clock_capacity(self, clock_capacity: usize) -> Self

Sets the maximum number of clocks that can exist at a time.

pub fn main_track_builder(self, builder: TrackBuilder) -> Self

Configures the main mixer track.

Trait Implementations

impl Default for AudioManagerSettings

fn default() -> Self

Returns the “default value” for a type.