Struct symphonia_core::audio::SampleBuffer

pub struct SampleBuffer<S: Sample> { /* private fields */ }

A SampleBuffer, is a sample oriented buffer. It is agnostic to the ordering/layout of samples within the buffer. SampleBuffer is mean’t for safely importing and exporting sample data to and from Symphonia using the sample’s in-memory data-type.

Implementations

impl<S: Sample> SampleBuffer<S>

pub fn new(duration: Duration, spec: SignalSpec) -> SampleBuffer<S>

Instantiate a new SampleBuffer using the specified signal specification and of the given duration.

pub fn len(&self) -> usize

Gets the number of written samples.

pub fn is_empty(&self) -> bool

Returns true if the buffer contains no written samples.

pub fn samples(&self) -> &[S]

Gets an immutable slice of all written samples.

pub fn samples_mut(&mut self) -> &mut [S]

Gets a mutable slice of all written samples.

pub fn capacity(&self) -> usize

Gets the maximum number of samples the SampleBuffer may store.

pub fn clear(&mut self)

Clears all written samples.

pub fn copy_planar_ref(&mut self, src: AudioBufferRef<'_>)

where S: ConvertibleSample,

Copies all audio data from the source AudioBufferRef in planar channel order into the SampleBuffer. The two buffers must be equivalent.

pub fn copy_planar_typed<F>(&mut self, src: &AudioBuffer<F>)

where F: Sample + IntoSample<S>,

Copies all audio data from a source AudioBuffer into the SampleBuffer in planar channel order. The two buffers must be equivalent.

pub fn copy_interleaved_ref(&mut self, src: AudioBufferRef<'_>)

where S: ConvertibleSample,

Copies all audio data from the source AudioBufferRef in interleaved channel order into the SampleBuffer. The two buffers must be equivalent.

pub fn copy_interleaved_typed<F>(&mut self, src: &AudioBuffer<F>)

where F: Sample + IntoSample<S>,

Copies all audio samples from a source AudioBuffer into the SampleBuffer in interleaved channel order. The two buffers must be equivalent.