Struct cpal::platform::Host

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

The platform’s dynamically dispatched Host type.

An instance of this Host type may represent one of the Hosts available on the platform.

Use this type if you require switching between available hosts at runtime.

This type may be constructed via the host_from_id function. HostIds may be acquired via the ALL_HOSTS const, and the available_hosts function.

Implementations

impl Host

pub fn id(&self) -> HostId

The unique identifier associated with this Host.

pub fn as_inner(&self) -> &HostInner

Returns a reference to the underlying platform specific implementation of this Host.

pub fn as_inner_mut(&mut self) -> &mut HostInner

Returns a mutable reference to the underlying platform specific implementation of this Host.

pub fn into_inner(self) -> HostInner

Returns the underlying platform specific implementation of this Host.

Trait Implementations

impl From<Host> for Host

fn from(h: Host) -> Self

Converts to this type from the input type.

impl From<HostInner> for Host

fn from(h: HostInner) -> Self

Converts to this type from the input type.

impl HostTrait for Host

type Devices = Devices

The type used for enumerating available devices by the host.

type Device = Device

The Device type yielded by the host.

fn is_available() -> bool

Whether or not the host is available on the system.

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

An iterator yielding all Devices currently available to the host on the system.

fn default_input_device(&self) -> Option<Self::Device>

The default input audio device on the system.

fn default_output_device(&self) -> Option<Self::Device>

The default output audio device on the system.

fn input_devices(&self) -> Result<InputDevices<Self::Devices>, DevicesError>

An iterator yielding all Devices currently available to the system that support one or more input stream formats.

fn output_devices(&self) -> Result<OutputDevices<Self::Devices>, DevicesError>

An iterator yielding all Devices currently available to the system that support one or more output stream formats.