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

#[cfg(test)]
pub(crate) mod mock;
#[cfg(feature = "symphonia")]
pub(crate) mod symphonia;

use crate::frame::Frame;

/// Decodes chunks of audio.
pub trait Decoder: Send {
	/// Errors that can occur when decoding audio.
	type Error;

	/// Returns the sample rate of the audio (in Hz).
	#[must_use]
	fn sample_rate(&self) -> u32;

	/// Returns the total number of samples of audio.
	#[must_use]
	fn num_frames(&self) -> usize;

	/// Decodes the next chunk of audio.
	fn decode(&mut self) -> Result<Vec<Frame>, Self::Error>;

	/// Seeks to an audio sample.
	///
	/// The `index` is the _requested_ sample to seek to. It's OK if the decoder
	/// seeks to an earlier sample than the one requested.
	///
	/// This should return the sample index that was _actually_ seeked to.
	fn seek(&mut self, index: usize) -> Result<SeekedToIndex, Self::Error>;
}

type SeekedToIndex = usize;