Struct cpal::Host

pub struct Host(_);

The platform's dynamically dispatched Host type.

An instance of this Host type may represent one of any 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.

Methods

impl Host

pub fn id(&self) -> HostId

The unique identifier associated with this host.

Trait Implementations

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.

type EventLoop = EventLoop

The event loop type used 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 event_loop(&self) -> Self::EventLoop

Initialise the event loop, ready for managing audio streams.

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.

impl From<Host> for Host

fn from(h: Host) -> Self

Performs the conversion.