Struct AudioInputDevice 

pub struct AudioInputDevice {
    pub id: String,
    pub name: String,
    pub is_default: bool,
}

Represents an audio input device (microphone).

Fields

id: String

The unique device ID used with SCStreamConfiguration::with_microphone_capture_device_id

name: String

Human-readable device name

is_default: bool

Whether this is the system default audio input device

Implementations

impl AudioInputDevice

pub fn list() -> Vec<Self>

List all available audio input devices.

Caching

Not cached. Each call walks Apple’s audio device list via AVAudioSession/AudioUnit and copies the per-device strings across the FFI boundary. The cost is small in absolute terms (microseconds) but is non-zero on every call. Code that repeatedly needs the device list (e.g. inside a UI render loop or per-frame decision) should cache the result and re-list only when the user signals a possible device change (e.g. on a settings-pane open or an AVAudioRouteChangeNotification).

Example

use screencapturekit::audio_devices::AudioInputDevice;

let devices = AudioInputDevice::list();
for device in &devices {
    println!("{}: {} {}", device.id, device.name,
        if device.is_default { "(default)" } else { "" });
}

pub fn default_device() -> Option<Self>

Get the default audio input device, if any.

Example

use screencapturekit::audio_devices::AudioInputDevice;

if let Some(device) = AudioInputDevice::default_device() {
    println!("Default microphone: {}", device.name);
}

Trait Implementations

impl Clone for AudioInputDevice

fn clone(&self) -> AudioInputDevice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioInputDevice

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

Formats the value using the given formatter.

impl PartialEq for AudioInputDevice

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for AudioInputDevice

impl StructuralPartialEq for AudioInputDevice