Skip to main content

CoreAudioDevice

Struct CoreAudioDevice 

Source
pub struct CoreAudioDevice { /* private fields */ }
Expand description

SIM-visible CoreAudio device metadata.

Implementations§

Source§

impl CoreAudioDevice

Source

pub fn output( id: impl Into<String>, name: impl Into<String>, channels: usize, timing: CoreAudioTiming, ) -> Result<Self>

Builds an output-direction device. See CoreAudioDevice::new.

Source

pub fn input( id: impl Into<String>, name: impl Into<String>, channels: usize, timing: CoreAudioTiming, ) -> Result<Self>

Builds an input-direction device. See CoreAudioDevice::new.

Source

pub fn duplex( id: impl Into<String>, name: impl Into<String>, channels: usize, timing: CoreAudioTiming, ) -> Result<Self>

Builds a duplex (input and output) device. See CoreAudioDevice::new.

Source

pub fn new( id: impl Into<String>, name: impl Into<String>, direction: HostDirection, channels: usize, timing: CoreAudioTiming, ) -> Result<Self>

Builds a device from its id, display name, direction, channel count, and timing.

The device starts flagged as neither the default input nor the default output. Returns an error when channels is zero.

Source

pub fn with_default_output(self) -> Self

Returns this device flagged as the default output device.

Source

pub fn with_default_input(self) -> Self

Returns this device flagged as the default input device.

Source

pub fn id(&self) -> &Symbol

Returns the device’s identifying symbol.

Source

pub fn name(&self) -> &str

Returns the device’s human-readable display name.

Source

pub fn direction(&self) -> HostDirection

Returns the device’s I/O direction.

Source

pub fn channels(&self) -> usize

Returns the device’s channel count.

Source

pub fn timing(&self) -> CoreAudioTiming

Returns the device’s timing metadata.

Source

pub fn default_output(&self) -> bool

Returns whether this device is flagged as the default output.

Source

pub fn default_input(&self) -> bool

Returns whether this device is flagged as the default input.

Source

pub fn spec(&self) -> Result<PcmSpec>

Returns the f32 PCM spec for this device’s channels and sample rate.

Source

pub fn is_compatible_with(&self, requested: HostDirection) -> bool

Returns whether this device can serve a stream in the requested direction.

A duplex device is compatible with any requested direction.

Source

pub fn port_symbol(&self) -> Symbol

Returns the <id>/port symbol naming this device’s host port.

Source

pub fn backend(&self) -> Symbol

Returns the CoreAudio backend symbol this device belongs to.

Trait Implementations§

Source§

impl Clone for CoreAudioDevice

Source§

fn clone(&self) -> CoreAudioDevice

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CoreAudioDevice

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for CoreAudioDevice

Source§

impl PartialEq for CoreAudioDevice

Source§

fn eq(&self, other: &CoreAudioDevice) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for CoreAudioDevice

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

Source§

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.