Struct AudioDevice 

pub struct AudioDevice { /* private fields */ }

Represents a PulseAudio audio output device.

Feature flags

Real PulseAudio integration requires the pulseaudio feature and the libpulse-dev system package. Without the feature every method returns AudioError::Unsupported.

Thread safety

When the pulseaudio feature is enabled, AudioDevice is not Send because it holds a cached PulseAudio connection (Mainloop and Context from libpulse-binding are !Send). Use on a single thread only. A threaded-mainloop wrapper that restores Send + Sync may be added in a future release.

Trait Implementations

impl AudioDevice for AudioDevice

fn from_default() -> Result<Self, AudioError>

Returns the system default audio output device.

fn from_id(id: &str) -> Result<Self, AudioError>

Returns the audio device identified by id.

fn from_name(name: &str) -> Result<Self, AudioError>

Returns the first audio device whose name contains name (case-insensitive substring match).

fn list() -> Result<Vec<DeviceInfo>, AudioError>

Lists all available audio devices.

fn get_vol(&self) -> Result<u8, AudioError>

Returns the current volume level in the range 0..=100.

fn set_vol(&self, vol: u8) -> Result<(), AudioError>

Sets the volume level.

fn is_mute(&self) -> Result<bool, AudioError>

Returns true if the device is currently muted.

fn set_mute(&self, muted: bool) -> Result<(), AudioError>

Mutes or unmutes the device.

fn id(&self) -> &str

Returns the unique identifier for this device.

fn name(&self) -> &str

Returns the human-readable display name of this device.

impl Debug for AudioDevice

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

Formats the value using the given formatter.

impl Display for AudioDevice

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

Formats the device as "name (id)".