Skip to main content

AlsaBackend

Struct AlsaBackend 

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

ALSA host backend with provider-supplied deterministic PCM devices.

Implementations§

Source§

impl AlsaBackend

Source

pub fn new(devices: Vec<AlsaPcmDevice>) -> Self

Builds a hardware-required backend over the supplied PCM devices.

Capabilities are derived from the devices’ directions; the backend reports that real audio hardware is required.

Source

pub fn fake() -> Self

Builds an offline backend with a deterministic set of fake PCM devices.

The backend reports that hardware is not required and carries the Offline and Fake capabilities, so it can drive validation without an ALSA development package or sound hardware. It exposes a default playback, a default capture, a hw:0,0 playback, and a plughw:1,0 capture device.

§Examples
use sim_lib_stream_alsa::AlsaBackend;

let backend = AlsaBackend::fake();
assert_eq!(backend.list_devices().len(), 4);
assert!(backend.default_playback().is_some());
assert!(backend.default_capture().is_some());
Source

pub fn list_devices(&self) -> &[AlsaPcmDevice]

Returns the backend’s PCM devices in registration order.

Source

pub fn default_playback(&self) -> Option<&AlsaPcmDevice>

Returns the first default device that can serve output, if any.

Source

pub fn default_capture(&self) -> Option<&AlsaPcmDevice>

Returns the first default device that can serve input, if any.

Source

pub fn open_default_playback(&self, capacity: usize) -> Result<HostOpenStream>

Opens an output stream on the default playback device.

Errors when no default playback device is present, or when the open request cannot be satisfied. capacity bounds the stream buffer.

Source

pub fn open_default_capture(&self, capacity: usize) -> Result<HostOpenStream>

Opens an input stream on the default capture device.

Errors when no default capture device is present, or when the open request cannot be satisfied. capacity bounds the stream buffer.

Trait Implementations§

Source§

impl Clone for AlsaBackend

Source§

fn clone(&self) -> AlsaBackend

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 AlsaBackend

Source§

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

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

impl Default for AlsaBackend

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl HostBackend for AlsaBackend

Source§

fn info(&self) -> &HostBackendInfo

Stable backend metadata.
Source§

fn enumerate(&self) -> Result<HostDeviceInventory>

Enumerates available devices and ports without opening hardware streams.
Source§

fn open(&self, request: HostStreamConfigRequest) -> Result<HostOpenStream>

Opens a stream according to the requested host configuration.

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.