Struct Configurator 

pub struct Configurator<'a, T> { /* private fields */ }

Available on crate feature alsa only.

A simple Pcm stream configuration.

Examples

use audio_device::alsa;

let mut pcm = alsa::Pcm::open_default(alsa::Stream::Playback)?;

let config = pcm.configure::<f32>()
    .rate(48000)
    .channels(5)
    .install()?;

dbg!(config);

Implementations

impl<'a, T> Configurator<'a, T>

where T: Sample,

pub fn access(self, access: Access) -> Self

Configure the stream access to use.

Examples

use audio_device::alsa;

let mut pcm = alsa::Pcm::open_default(alsa::Stream::Playback)?;

let config = pcm.configure::<f32>()
    .access(alsa::Access::MmapInterleaved)
    .install()?;

dbg!(config);

pub fn format(self, format: Format) -> Result<Self>

Configure the stream format to use.

This will check that the format is appropriate to use by the current sample. Inappropriate formats will be signalled with Error::FormatMismatch.

Examples

use audio_device::alsa;

let mut pcm = alsa::Pcm::open_default(alsa::Stream::Playback)?;

let config = pcm.configure::<f32>()
    .format(alsa::Format::FloatLE)?
    .install()?;

dbg!(config);

pub fn latency(self, latency: Duration) -> Self

Configure the stream latency to use.

Will never accept a latency higher than 2**32. Anything larger will be floored to it.

Examples

use audio_device::alsa;

let mut pcm = alsa::Pcm::open_default(alsa::Stream::Playback)?;

let config = pcm.configure::<f32>()
    .latency(std::time::Duration::from_micros(500))
    .install()?;

dbg!(config);

pub fn channels(self, channels: c_uint) -> Self

Configure the number of channels to use.

Examples

use audio_device::alsa;

let mut pcm = alsa::Pcm::open_default(alsa::Stream::Playback)?;

let config = pcm.configure::<f32>()
    .channels(5)
    .install()?;

dbg!(config);

pub fn rate(self, rate: c_uint) -> Self

Configure the sample rate to use.

Examples

use audio_device::alsa;

let mut pcm = alsa::Pcm::open_default(alsa::Stream::Playback)?;

let config = pcm.configure::<f32>()
    .rate(48000)
    .install()?;

dbg!(config);

pub fn install(self) -> Result<Config>

Install the current configuration and return the one which is used by the underlying PCM.

Examples

use audio_device::alsa;

let mut pcm = alsa::Pcm::open_default(alsa::Stream::Playback)?;

let config = pcm.configure::<f32>()
    .channels(2)
    .rate(48000)
    .install()?;

dbg!(config);