Struct Audio 

pub struct Audio { /* private fields */ }

The output device and the sounds playing on it. The runner owns one; a host driving a core itself makes one with Audio::new and calls Audio::apply and Audio::poll_ended on its own turns.

Implementations

impl Audio

pub fn new() -> Self

A closed device; nothing opens until the first command.

pub fn warm(&mut self)

Starts opening the device if nothing has yet. Cheap to call every frame; the driver calls it once the session holds a sound, so the device is open by the time a click asks for one.

pub fn apply( &mut self, cmds: Vec<AudioCommand>, resources: &SharedResources, ) -> Answered

Applies queued commands to the device; while it is still opening they wait, in order. Returns what the device answered back: the stops that landed on a sound still playing and the plays it would not take. A command that waited for the device reports on the apply that flushes it, not the one that queued it.

pub fn poll_ended(&mut self) -> Vec<PlaybackId>

Playbacks that finished on their own since the last poll (stopped ones were already forgotten by Stop). Also where a command that waited for the device starts, since the driver polls while anything is active.

pub fn holds_device(&self) -> bool

Whether the device is open or opening. An open output stream is a real-time thread that runs whether or not anything is playing, so a driver closes it after a quiet spell.

pub fn close(&mut self)

Lets the output device go; the decoded-sound cache stays, so the next play pays the open again but not the decode. Does nothing while anything is playing or waiting, or while the device is still opening: call it once Self::active has been false for a while, and again if it did not take.

pub fn active(&self) -> bool

Whether any playback is live or waiting on the device to open, or an answer is waiting for the next apply. Keep polling while it is true.

pub fn env(&self) -> AudioEnv

The reading a view gets as env.audio: the device’s state and the playbacks started or waiting.

Trait Implementations

impl Default for Audio

fn default() -> Self

Returns the “default value” for a type.