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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

use crate::{
	Decibels, Panning, PlaybackRate, StartTime, Tween, Value,
	sound::{IntoOptionalRegion, PlaybackPosition, Region},
};

/// Settings for a static sound.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct StaticSoundSettings {
	/// When the sound should start playing.
	pub start_time: StartTime,
	/// Where in the sound playback should start.
	pub start_position: PlaybackPosition,
	/// The portion of the sound that should be looped.
	pub loop_region: Option<Region>,
	/// Whether the sound should be played in reverse.
	pub reverse: bool,
	/// The volume of the sound.
	pub volume: Value<Decibels>,
	/// The playback rate of the sound.
	///
	/// Changing the playback rate will change both the speed
	/// and the pitch of the sound.
	pub playback_rate: Value<PlaybackRate>,
	/// The panning of the sound, where 0 is hard left
	/// and 1 is hard right.
	pub panning: Value<Panning>,
	/// An optional fade-in from silence.
	pub fade_in_tween: Option<Tween>,
}

impl StaticSoundSettings {
	/// Creates a new [`StaticSoundSettings`] with the default settings.
	#[must_use]
	pub fn new() -> Self {
		Self {
			start_time: StartTime::default(),
			start_position: PlaybackPosition::Seconds(0.0),
			reverse: false,
			loop_region: None,
			volume: Value::Fixed(Decibels::IDENTITY),
			playback_rate: Value::Fixed(PlaybackRate(1.0)),
			panning: Value::Fixed(Panning::CENTER),
			fade_in_tween: None,
		}
	}

	/** Sets when the sound should start playing. */
	#[must_use = "This method consumes self and returns a modified StaticSoundSettings, so the return value should be used"]
	pub fn start_time(self, start_time: impl Into<StartTime>) -> Self {
		Self {
			start_time: start_time.into(),
			..self
		}
	}

	/// Sets where in the sound playback should start.
	#[must_use = "This method consumes self and returns a modified StaticSoundSettings, so the return value should be used"]
	pub fn start_position(self, start_position: impl Into<PlaybackPosition>) -> Self {
		Self {
			start_position: start_position.into(),
			..self
		}
	}

	/// Sets whether the sound should be played in reverse.
	#[must_use = "This method consumes self and returns a modified StaticSoundSettings, so the return value should be used"]
	pub fn reverse(self, reverse: bool) -> Self {
		Self { reverse, ..self }
	}

	/** Sets the portion of the sound that should be looped. */
	#[must_use = "This method consumes self and returns a modified StaticSoundSettings, so the return value should be used"]
	pub fn loop_region(self, loop_region: impl IntoOptionalRegion) -> Self {
		Self {
			loop_region: loop_region.into_optional_region(),
			..self
		}
	}

	/** Sets the volume of the sound. */
	#[must_use = "This method consumes self and returns a modified StaticSoundSettings, so the return value should be used"]
	pub fn volume(self, volume: impl Into<Value<Decibels>>) -> Self {
		Self {
			volume: volume.into(),
			..self
		}
	}

	/**

	Sets the playback rate of the sound.

	Changing the playback rate will change both the speed
	and the pitch of the sound.
	*/
	#[must_use = "This method consumes self and returns a modified StaticSoundSettings, so the return value should be used"]
	pub fn playback_rate(self, playback_rate: impl Into<Value<PlaybackRate>>) -> Self {
		Self {
			playback_rate: playback_rate.into(),
			..self
		}
	}

	/**

	Sets the panning of the sound, where 0 is hard left
	and 1 is hard right.
	*/
	#[must_use = "This method consumes self and returns a modified StaticSoundSettings, so the return value should be used"]
	pub fn panning(self, panning: impl Into<Value<Panning>>) -> Self {
		Self {
			panning: panning.into(),
			..self
		}
	}

	/// Sets the tween used to fade in the sound from silence.
	#[must_use = "This method consumes self and returns a modified StaticSoundSettings, so the return value should be used"]
	pub fn fade_in_tween(self, fade_in_tween: impl Into<Option<Tween>>) -> Self {
		Self {
			fade_in_tween: fade_in_tween.into(),
			..self
		}
	}
}

impl Default for StaticSoundSettings {
	fn default() -> Self {
		Self::new()
	}
}