Struct AlsaPcmDevice 

pub struct AlsaPcmDevice { /* private fields */ }

SIM-visible ALSA PCM device metadata.

Implementations

impl AlsaPcmDevice

pub fn playback( pcm_name: impl Into<String>, display_name: impl Into<String>, channels: usize, sample_rate_hz: u32, ) -> Result<Self>

Builds an output (playback) PCM device with the F32 sample format.

Examples

use sim_lib_stream_alsa::AlsaPcmDevice;

let device = AlsaPcmDevice::playback("hw:0,0", "Card 0", 2, 48_000).unwrap();
assert_eq!(device.channels(), 2);
assert_eq!(device.sample_rate_hz(), 48_000);
assert!(!device.is_default());

pub fn capture( pcm_name: impl Into<String>, display_name: impl Into<String>, channels: usize, sample_rate_hz: u32, ) -> Result<Self>

Builds an input (capture) PCM device with the F32 sample format.

pub fn default_playback(channels: usize, sample_rate_hz: u32) -> Result<Self>

Builds the routed default PCM device for playback.

pub fn default_capture(channels: usize, sample_rate_hz: u32) -> Result<Self>

Builds the routed default PCM device for capture.

pub fn new( pcm_name: AlsaPcmName, display_name: impl Into<String>, direction: HostDirection, channels: usize, sample_rate_hz: u32, sample_format: PcmSampleFormat, ) -> Result<Self>

Builds a PCM device from explicit parts, defaulting the buffer to 256 frames.

Returns an Error::Eval when channels or sample_rate_hz is zero. The device Symbol id is derived from the name and direction.

pub fn with_buffer_frames(self, buffer_frames: usize) -> Result<Self>

Returns a copy of this device with the buffer size set to buffer_frames, which must be greater than zero.

pub fn id(&self) -> &Symbol

Returns the device’s stable SIM identity symbol.

pub fn pcm_name(&self) -> &AlsaPcmName

Returns the parsed ALSA PCM name.

pub fn display_name(&self) -> &str

Returns the human-readable display name.

pub fn direction(&self) -> HostDirection

Returns the device direction (input, output, or duplex).

pub fn channels(&self) -> usize

Returns the channel count.

pub fn sample_rate_hz(&self) -> u32

Returns the sample rate in hertz.

pub fn sample_format(&self) -> PcmSampleFormat

Returns the PCM sample format.

pub fn buffer_frames(&self) -> usize

Returns the configured buffer size in frames.

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

Builds the PCM spec (channels, rate, format) for this device.

pub fn is_default(&self) -> bool

Returns true when this device wraps the ALSA default PCM.

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

Returns true when the device can serve the requested direction.

A duplex device satisfies any requested direction.

pub fn port_symbol(&self) -> Symbol

Returns the device’s port symbol, the device id with a /port suffix.

Trait Implementations

impl Clone for AlsaPcmDevice

fn clone(&self) -> AlsaPcmDevice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlsaPcmDevice

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

Formats the value using the given formatter.

impl Eq for AlsaPcmDevice

impl PartialEq for AlsaPcmDevice

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