Struct SoundEngine 

pub struct SoundEngine(/* private fields */);

Sound engine manages contexts, feeds output device with data. Sound engine instance can be cloned, however this is always a “shallow” clone, because actual sound engine data is wrapped in Arc.

Implementations

impl SoundEngine

pub fn new() -> Result<SoundEngine, Box<dyn Error>>

Creates new instance of the sound engine. It is possible to have multiple engines running at the same time, but you shouldn’t do this because you can create multiple contexts which should cover 99% of use cases.

pub fn without_device() -> SoundEngine

Creates new instance of a sound engine without OS audio output device (so called headless mode). The user should periodically run State::render if they want to implement their own sample sending method to an output device (or a file, etc.).

pub fn initialize_audio_output_device(&self) -> Result<(), Box<dyn Error>>

Tries to initialize default audio output device.

pub fn destroy_audio_output_device(&self)

Destroys current audio output device (if any).

pub fn state(&self) -> MutexGuard<'_, State>

Provides direct access to actual engine data.

Trait Implementations

impl Clone for SoundEngine

fn clone(&self) -> SoundEngine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SoundEngine

fn default() -> SoundEngine

Returns the “default value” for a type.