Struct nannou_audio::Host

pub struct Host { /* fields omitted */ }

The top-level audio API, for enumerating devices and spawning input/output streams.

Methods

impl Host

pub fn from_id(id: HostId) -> Result<Self, HostUnavailable>

Instantiate the current host for the platform.

pub fn new() -> Self

Initialise the API.

Internally, this creates a new, inactive CPAL event loop ready for stream creation.

The Default implementation for Host calls this constructor internally.

pub fn devices(&self) -> Result<Devices, DevicesError>

Enumerate the available audio devices on the system.

Produces an iterator yielding Devices.

pub fn input_devices(&self) -> Result<Devices, DevicesError>

Enumerate the available audio devices on the system that support input streams.

Produces an iterator yielding Devices.

pub fn output_devices(&self) -> Result<Devices, DevicesError>

Enumerate the available audio devices on the system that support output streams.

Produces an iterator yielding Devices.

pub fn default_input_device(&self) -> Option<Device>

The current default audio input device.

pub fn default_output_device(&self) -> Option<Device>

The current default audio output device.

pub fn new_input_stream<M, S>(&self, model: M) -> BuilderInit<M, S>

Begin building a new input audio stream.

If this is the first time a stream has been created, this method will spawn the cpal::EventLoop::run method on its own thread, ready to run built streams.

pub fn new_output_stream<M, S>(&self, model: M) -> BuilderInit<M, S>

Begin building a new output audio stream.

If this is the first time a stream has been created, this method will spawn the cpal::EventLoop::run method on its own thread, ready to run built streams.

Trait Implementations

impl Default for Host

fn default() -> Self

Returns the "default value" for a type.