Struct AudioFrame 

pub struct AudioFrame { /* private fields */ }

Owned, tightly packed planar floating-point audio with a validated layout.

Channel samples are contiguous, with channels stored one after another. Conversion from borrowed SDK audio omits inter-channel padding.

Implementations

impl AudioFrame

pub fn builder() -> AudioFrameBuilder

Create a builder for configuring an audio frame

pub fn sample_rate(&self) -> i32

Get the sample rate in Hz.

pub fn num_channels(&self) -> i32

Get the number of audio channels.

pub fn num_samples(&self) -> i32

Get the number of samples per channel.

pub fn timecode(&self) -> i64

Get the timecode in 100 ns units.

Defaults to the SDK’s synthesized-timecode sentinel. An explicit zero is passed through as a literal timecode.

pub fn timestamp(&self) -> i64

Get the receive timestamp in 100 ns units since the Unix epoch.

On receive the SDK supplies this value, or its undefined-timestamp sentinel when unavailable. Outbound values are passed through unchanged; the SDK defines this field for receiving.

pub fn format(&self) -> AudioFormat

Get the audio format.

pub fn channel_stride_in_bytes(&self) -> i32

Get the channel stride in bytes.

pub fn data(&self) -> &[f32]

Get tightly packed planar audio as 32-bit floats. Each channel’s samples are contiguous; channels follow one another.

pub fn data_mut(&mut self) -> &mut [f32]

Get mutable audio sample data without changing the validated layout.

pub fn replace_data(&mut self, data: Vec<f32>) -> Result<()>

Replace the owned audio data while preserving the validated layout.

Errors

Returns Error::InvalidFrame if data is not exactly the validated sample count.

pub fn metadata(&self) -> Option<&str>

Get frame metadata as UTF-8 text, if present.

pub fn set_metadata<S: Into<String>>( &mut self, metadata: Option<S>, ) -> Result<()>

Replace frame metadata.

Errors

Returns Error::InvalidCString if metadata contains an interior NUL byte, or Error::InvalidFrame if the emitted C string would exceed the metadata size cap.

pub fn channel_data(&self, channel: usize) -> Option<&[f32]>

Get audio data for a specific channel

Data is always stored in planar format internally. If AudioLayout::Interleaved was specified at build time, the data was converted to planar during construction.

pub fn channel_data_mut(&mut self, channel: usize) -> Option<&mut [f32]>

Get mutable samples for one channel without allocating.

Trait Implementations

impl Debug for AudioFrame

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

Formats the value using the given formatter.

impl Default for AudioFrame

fn default() -> Self

Returns the “default value” for a type.

impl Drop for AudioFrame

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.