Struct audio_streams::AsyncPlaybackBuffer

pub struct AsyncPlaybackBuffer<'a> {
    pub(crate) buffer: AudioBuffer<'a>,
    pub(crate) trigger: &'a mut dyn AsyncBufferCommit,
}

AsyncPlaybackBuffer is the async version of PlaybackBuffer.

Fields

buffer: AudioBuffer<'a>

trigger: &'a mut dyn AsyncBufferCommit

Implementations

impl<'a> AsyncPlaybackBuffer<'a>

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

where F: AsyncBufferCommit,

Creates a new AsyncPlaybackBuffer 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 async fn commit(&mut self)

This triggers the callback of AsyncBufferCommit. This should be called after the data is copied to the buffer.

pub fn latency_bytes(&self) -> u32

It returns the latency in terms of bytes that the capture buffer was recorded.

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

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

pub fn copy_from(&mut self, reader: &mut dyn Read) -> Result<usize>

Copy data from an io::Reader

Trait Implementations

impl<'a> Write for AsyncPlaybackBuffer<'a>

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

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.