Struct Manager

pub struct Manager { /* private fields */ }

A Manager can play sounds by rendering sounds on a Renderer for a backend.

Implementations

impl Manager

pub fn new() -> (Self, Renderer)

Create a new Manager and the renderer its samples will render to.

Normally you do not need to call this function directly but you instead call .start(...) on a backend which will call this function.

pub fn play(&mut self, sound: Box<dyn Sound>)

Add a new Sound to be played in parallel to any existing sounds.

If you want to play Sounds sequentially use a SoundList.

See the modifier functions on Sound to control sounds before and/or after playing.

Examples found in repository

examples/play.rs (line 12)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let Some(file_path) = args() else {
        eprintln!("usage: FILE_PATH");
        std::process::exit(2);
    };

    let (mut manager, _backend) = awedio::start()?;
    let (sound, notifier) = awedio::sounds::open_file(file_path)?.with_completion_notifier();

    manager.play(Box::new(sound));
    let _ = notifier.recv();

    Ok(())
}

pub fn clear(&mut self)

Stop playing and remove all audio sounds. New sounds can still be added.

Trait Implementations

impl Clone for Manager

fn clone(&self) -> Manager

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Manager

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.