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

use std::sync::Arc;

use crate::{
	Decibels, Tween, Value,
	command::{CommandWriter, ValueChangeCommand},
};

use super::{SendTrackId, TrackShared};

/// Controls a mixer track.
///
/// When a [`SendTrackHandle`] is dropped, the corresponding mixer
/// track will be removed.
#[derive(Debug)]
pub struct SendTrackHandle {
	pub(crate) id: SendTrackId,
	pub(crate) shared: Arc<TrackShared>,
	pub(crate) set_volume_command_writer: CommandWriter<ValueChangeCommand<Decibels>>,
}

impl SendTrackHandle {
	/// Returns a unique identifier for this send track.
	pub fn id(&self) -> SendTrackId {
		self.id
	}

	/// Sets the (post-effects) volume of the send track.
	pub fn set_volume(&mut self, volume: impl Into<Value<Decibels>>, tween: Tween) {
		self.set_volume_command_writer.write(ValueChangeCommand {
			target: volume.into(),
			tween,
		})
	}
}

impl Drop for SendTrackHandle {
	fn drop(&mut self) {
		self.shared.mark_for_removal();
	}
}