awedio 0.6.0

A low-overhead and adaptable audio playback library
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

#![warn(missing_docs)]
#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

pub mod backends;
pub mod manager;
pub mod sounds;
pub mod utils;

mod error;
mod sound;
#[cfg(test)]
mod tests;

pub use error::Error;
pub use sound::NextSample;
pub use sound::Sound;

/// Start outputting audio with the default backend, device, and configs.
///
/// Currently if an error occurs, it is printed to stderr but not handled in any
/// other way. This should be improved in the future.
/// For more control, create the [CpalBackend][backends::CpalBackend]
/// explicitly.
#[cfg(feature = "cpal")]
pub fn start() -> Result<(manager::Manager, backends::CpalBackend), backends::CpalBackendError> {
    let mut backend =
        backends::CpalBackend::with_defaults().ok_or(backends::CpalBackendError::NoDevice)?;
    let manager = backend.start(|error| eprintln!("error with cpal output stream: {}", error))?;
    Ok((manager, backend))
}