Struct nannou_audio::Host

source ·
pub struct Host { /* private fields */ }
Expand description

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

Implementations§

source§

impl Host

source

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

Instantiate the current host for the platform.

source

pub fn new() -> Self

Initialise the API.

The Default implementation for Host calls this constructor internally.

source

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

Enumerate the available audio devices on the system.

Produces an iterator yielding Devices.

source

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.

source

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.

source

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

The current default audio input device.

source

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

The current default audio output device.

source

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.

source

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§

source§

impl Default for Host

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl RefUnwindSafe for Host

§

impl Send for Host

§

impl Sync for Host

§

impl Unpin for Host

§

impl UnwindSafe for Host

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<S> FromSample<S> for S

source§

fn from_sample_(s: S) -> S

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

source§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,