Type Alias MmapCapture

pub type MmapCapture<S> = MmapIO<S, Capture>;

Aliased Type

struct MmapCapture<S> { /* private fields */ }

Implementations

impl<S> MmapCapture<S>

pub fn iter(&mut self) -> CaptureIter<'_, S>

Read samples from the kernel ringbuffer.

When the iterator is dropped or depleted, the read samples will be committed, i e, the kernel can then write data to the location again. So do this ASAP.

impl<S, D: MmapDir> MmapIO<S, D>

pub fn status(&self) -> &Status

Read current status

pub fn appl_ptr(&self) -> Frames

Read current number of frames committed by application

This number wraps at ‘boundary’.

pub fn hw_ptr(&self) -> Frames

Read current number of frames read / written by hardware

This number wraps at ‘boundary’.

pub fn boundary(&self) -> Frames

The number at which hw_ptr and appl_ptr wraps.

pub fn buffer_size(&self) -> Frames

Total number of frames in hardware buffer

pub fn channels(&self) -> u32

Number of channels in stream

pub fn commit(&self, v: Frames)

Notifies the kernel that frames have now been read / written by the application

This will allow the kernel to write new data into this part of the buffer.

pub fn avail(&self) -> Frames

Number of frames available to read / write.

In case of an underrun, this value might be bigger than the buffer size.

pub fn data_ptr(&self) -> (RawSamples<S>, Option<RawSamples<S>>)

Returns raw pointers to data to read / write.

Use this if you want to read/write data yourself (instead of using iterators). If you do, using write_volatile or read_volatile is recommended, since it’s DMA memory and can change at any time.

Since this is a ring buffer, there might be more data to read/write in the beginning of the buffer as well. If so this is returned as the second return value.

Trait Implementations

impl<S: Debug, D: Debug> Debug for MmapIO<S, D>

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

Formats the value using the given formatter.