Struct DeviceId 

pub struct DeviceId(pub HostId, pub String);

A stable identifier for an audio device across all supported platforms.

Device IDs should remain stable across application restarts and can be serialized using Display/FromStr.

A device ID consists of a HostId identifying the audio backend and a device-specific identifier string.

Example

use cpal::traits::{HostTrait, DeviceTrait};
use cpal::DeviceId;
use std::str::FromStr;

let host = cpal::default_host();
let device = host.default_output_device().unwrap();
let device_id = device.id().unwrap();

// Serialize to string (e.g., for storage in config file)
let id_string = device_id.to_string();
println!("Device ID: {}", id_string); // e.g., "wasapi:device_identifier"

// Deserialize from string
match DeviceId::from_str(&id_string) {
    Ok(parsed_id) => {
        // Retrieve the device by its ID
        if let Some(device) = host.device_by_id(&parsed_id) {
            println!("Found device: {:?}", device.id());
        }
    }
    Err(e) => eprintln!("Failed to parse device ID: {}", e),
}

Tuple Fields

0: HostId

1: String

Trait Implementations

impl Clone for DeviceId

fn clone(&self) -> DeviceId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceId

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

Formats the value using the given formatter.

impl Display for DeviceId

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

Formats the value using the given formatter.

impl FromStr for DeviceId

type Err = DeviceIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for DeviceId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DeviceId

fn eq(&self, other: &DeviceId) -> 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 DeviceId

impl StructuralPartialEq for DeviceId