Struct AVAudioFifo 

pub struct AVAudioFifo { /* private fields */ }

Context for an Audio FIFO Buffer.

• Operates at the sample level rather than the byte level.
• Supports multiple channels with either planar or packed sample format.
• Automatic reallocation when writing to a full buffer.

Implementations

impl AVAudioFifo

pub fn as_ptr(&self) -> *const AVAudioFifo

pub fn as_mut_ptr(&mut self) -> *mut AVAudioFifo

pub unsafe fn set_ptr(&mut self, ptr: NonNull<AVAudioFifo>)

Safety

This function should only be called when the pointer is valid and the data it’s pointing to can be dropped.

pub unsafe fn from_raw(raw: NonNull<AVAudioFifo>) -> Self

Safety

This function should only be called when the pointer is valid and the data it’s pointing to can be dropped.

pub fn into_raw(self) -> NonNull<AVAudioFifo>

impl AVAudioFifo

pub fn new(sample_fmt: AVSampleFormat, channels: i32, nb_samples: i32) -> Self

Allocate an AVAudioFifo.

pub fn realloc(&mut self, nb_samples: i32)

Reallocate an AVAudioFifo.

pub unsafe fn write( &mut self, data: *const *mut u8, nb_samples: i32, ) -> Result<()>

Write data to an AVAudioFifo.

The AVAudioFifo will be reallocated automatically if the available space is less than nb_samples.

Safety

Function is safe when the data points to valid samples.

pub unsafe fn peek( &mut self, data: *const *mut u8, nb_samples: i32, ) -> Result<i32>

Peek data from an AVAudioFifo.

Safety

Function is safe when the data points to valid sample buffer.

pub unsafe fn peek_at( &mut self, data: *const *mut u8, nb_samples: i32, offset: i32, ) -> Result<i32>

Peek data from an AVAudioFifo.

Safety

Function is safe when the data points to valid sample buffer.

pub unsafe fn read( &mut self, data: *const *mut u8, nb_samples: i32, ) -> Result<i32>

Read data from an AVAudioFifo.

This function returns actually read size if success.

Safety

Function is safe when the data points to valid array such as AVFrame::data.

pub fn drain(&mut self, nb_samples: i32)

Drain data from an AVAudioFifo.

Removes the data without reading it.

pub fn reset(&mut self)

Reset the AVAudioFifo buffer.

This empties all data in the buffer.

pub fn size(&self) -> i32

Get the current number of samples in the AVAudioFifo available for reading.

pub fn space(&self) -> i32

Get the current number of samples in the AVAudioFifo available for writing.

Trait Implementations

impl Deref for AVAudioFifo

type Target = AVAudioFifo

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for AVAudioFifo

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for AVAudioFifo

impl UnsafeDerefMut for AVAudioFifo

unsafe fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value, unsafely.