Struct audio_streams::capture::CaptureBuffer

pub struct CaptureBuffer<'a> {
    buffer: AudioBuffer<'a>,
    drop: &'a mut dyn BufferCommit,
}

CaptureBuffer contains a block of audio samples got from capture stream. It provides temporary view to those samples and will notifies capture stream when dropped. Note that it’ll always send buffer.len() / frame_size to drop function when it got destroyed since CaptureBufferStream assumes that users get all the samples from the buffer.

Fields

buffer: AudioBuffer<'a>

drop: &'a mut dyn BufferCommit

Implementations

impl<'a> CaptureBuffer<'a>

pub fn new<F>( frame_size: usize, buffer: &'a mut [u8], drop: &'a mut F ) -> Result<Self, CaptureBufferError>

where F: BufferCommit,

Creates a new CaptureBuffer that holds a reference to the backing memory specified in buffer.

pub fn frame_capacity(&self) -> usize

Returns the number of audio frames that fit in the buffer.

pub fn commit(&mut self)

This triggers the callback of BufferCommit. This should be called after the data is read from the buffer.

Always sends frame_capacity.

pub fn latency_bytes(&self) -> u32

pub fn copy_cb<F: FnOnce(&[u8])>(&mut self, size: usize, cb: F) -> Result<usize>

Reads up to size bytes directly from this buffer inside of the given callback function.

Trait Implementations

impl<'a> Read for CaptureBuffer<'a>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.