Struct Recorder 

pub struct Recorder<'d> { /* private fields */ }

Microphone capture.

Implementations

impl Recorder<'_>

pub async fn read(&mut self, out: &mut [i16]) -> Result<usize, Error>

Waits for audio and fills out with as many whole stereo frames as are available (at least one). Returns the number of i16 samples written, always even.

Read at least every ~170 ms (at 48 kHz) or the stream overruns; an overrun returns Error::Overrun once and restarts the stream.

Cancel-safe. It only waits before copying, so a cancelled call has written nothing to out and dropped no audio: the samples stay in the DMA buffer for the next call.

pub fn buffered_bytes(&mut self) -> usize

Bytes captured but not yet read (0 while the stream is restarting).

pub fn is_stopped(&mut self) -> bool

Whether the DMA has stopped (e.g. after an overrun).

pub async fn set_gain(&mut self, gain: MicGain) -> Result<(), Error>

Changes the microphone pre-amplifier gain.

pub fn rate(&self) -> SampleRate

The sample rate.

pub fn codec(&mut self) -> &mut Codec

The codec, for advanced control.

pub async fn shutdown(self) -> Result<(), Error>

Powers the codec down, then stops the stream. Prefer this over a plain drop when the device goes quiet for a while.