kira 0.12.0

Expressive audio library for games
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

use crate::track::MainTrackBuilder;

use crate::backend::Backend;

/// Specifies how many of each resource type an audio context
/// can have.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Capacities {
	/// The maximum number of mixer sub-tracks that can exist at a time.
	pub sub_track_capacity: usize,
	/// The maximum number of mixer send tracks that can exist at a time.
	pub send_track_capacity: usize,
	/// The maximum number of clocks that can exist at a time.
	pub clock_capacity: usize,
	/// The maximum number of modulators that can exist at a time.
	pub modulator_capacity: usize,
	/// The maximum number of listeners that can exist at a time.
	pub listener_capacity: usize,
}

impl Default for Capacities {
	fn default() -> Self {
		Self {
			sub_track_capacity: 128,
			send_track_capacity: 16,
			clock_capacity: 8,
			modulator_capacity: 16,
			listener_capacity: 8,
		}
	}
}

/// Settings for an [`AudioManager`](super::AudioManager).
pub struct AudioManagerSettings<B: Backend> {
	/// Specifies how many of each resource type an audio context
	/// can have.
	pub capacities: Capacities,
	/// Configures the main mixer track.
	pub main_track_builder: MainTrackBuilder,
	/// Determines how often modulators and clocks will be updated (in samples).
	///
	/// At the default size of 128 samples, at a sample rate of 44100hz,
	/// modulators and clocks will update about every 3 milliseconds.
	///
	/// Decreasing this value increases the precision of clocks and modulators
	/// at the expense of higher CPU usage.
	pub internal_buffer_size: usize,
	/// Configures the backend.
	pub backend_settings: B::Settings,
}

impl<B: Backend> Default for AudioManagerSettings<B>
where
	B::Settings: Default,
{
	fn default() -> Self {
		Self {
			capacities: Capacities::default(),
			main_track_builder: MainTrackBuilder::default(),
			internal_buffer_size: 128,
			backend_settings: B::Settings::default(),
		}
	}
}