kittyaudio 0.2.0

An audio playback library focusing on simplicity
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

//! kittyaudio is an audio library focusing on simplicity.
//!
//! # Example
//!
//! ```ignore
//! use kittyaudio::{include_sound, Mixer};
//!
//! fn main() {
//!     // include a sound into the executable.
//!     // this type can be cheaply cloned.
//!     let sound = include_sound!("jump.ogg").unwrap();
//!
//!     // create sound mixer
//!     let mut mixer = Mixer::new();
//!     mixer.init(); // use init_ex to specify settings
//!
//!     let playing_sound = mixer.play(sound);
//!     playing_sound.set_volume(0.5); // decrease volume
//!
//!     mixer.wait(); // wait for all sounds to finish
//! }
//! ```
//!
//! See more examples in the `examples` directory.
//!
//! # Features
//!
//! * Low-latency audio playback
//! * Cross-platform audio playback (including wasm)
//! * Handle device changes or disconnects in real time
//! * Low CPU usage
//! * Minimal dependencies
//! * Minimal memory allocations
//! * No `panic!()` or `.unwrap()`, always propogate errors
//! * No unsafe code
//! * Simple API, while being customizable
//! * Optionally use [Symphonia](https://github.com/pdeljanov/Symphonia) to support most audio formats
//! * Feature to disable audio playback support, if you want to use kittyaudio purely as an audio library
//! * Commands to change volume, playback rate, position and panning in the sound with easings
//! * Loops, and commands to change them with easings
//!
//! # Roadmap
//!
//! Those features are not implemented yet.
//!
//! * Effects (reverb, delay, eq, etc.)
//! * C API
//! * Audio streaming from disk

#![warn(missing_docs)] // warn on missing function docs

#[cfg(feature = "cpal")]
mod backend;

mod command;
mod error;
mod mixer;
mod renderer;
mod resampler;
mod sound;

#[cfg(feature = "cpal")]
pub use backend::*;

pub use command::*;
pub use error::*;
pub use mixer::*;
pub use renderer::*;
pub use resampler::*;
pub use sound::*;

// Re-export the cpal and symphonia crate
#[cfg(feature = "cpal")]
pub use cpal;

#[cfg(feature = "symphonia")]
pub use symphonia;