Struct Frame

pub struct Frame {
    pub samples: StackVec<f32, bbx_dsp::::frame::Frame::{constant#0}>,
    pub sample_rate: u32,
    pub num_channels: usize,
}

A frame of audio data for visualization or inter-thread communication.

Uses stack-allocated storage for realtime-safe operation on audio threads.

Fields

samples: StackVec<f32, bbx_dsp::::frame::Frame::{constant#0}>

Interleaved audio samples (stack-allocated).

sample_rate: u32

Sample rate in Hz.

num_channels: usize

Number of audio channels.

Implementations

impl Frame

pub fn new(samples: &[f32], sample_rate: u32, num_channels: usize) -> Frame

Create a new frame from a slice of samples.

Panics

Panics if samples.len() > MAX_FRAME_SAMPLES.

pub fn channel_samples( &self, channel: usize, ) -> Option<impl Iterator<Item = f32>>

Returns an iterator over samples for a specific channel (de-interleaved).

Returns None if the channel index is out of bounds.

pub fn samples_per_channel(&self) -> usize

Get the number of samples per channel.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.