Struct AudioFrameBuilder 

pub struct AudioFrameBuilder { /* private fields */ }

Builder for configuring an AudioFrame with ergonomic method chaining

Implementations

impl AudioFrameBuilder

pub fn new() -> Self

Create a new builder with no fields set

pub fn sample_rate(self, rate: i32) -> Self

Set the sample rate

pub fn channels(self, channels: i32) -> Self

Set the number of audio channels

pub fn samples(self, samples: i32) -> Self

Set the number of samples

pub fn timecode(self, tc: i64) -> Self

Set the timecode in 100 ns units (or the SDK synthesis sentinel).

pub fn format(self, format: AudioFormat) -> Self

Set the audio format

pub fn layout(self, layout: AudioLayout) -> Self

Set the audio data layout (planar or interleaved)

• Planar: All samples for channel 0, then all for channel 1, etc.
• Interleaved: Samples from all channels are interleaved.

Defaults to AudioLayout::Planar which is the native format for FLTP.

Example

use grafton_ndi::{AudioFrame, AudioLayout};

// Planar layout (default)
let frame = AudioFrame::builder()
    .channels(2)
    .samples(100)
    .layout(AudioLayout::Planar)
    .build()
    .unwrap();

pub fn data(self, data: Vec<f32>) -> Self

Set the audio data as 32-bit floats

The data length must equal num_channels * num_samples. The layout must match the configured AudioLayout:

• Planar: [C0S0, C0S1, ..., C1S0, C1S1, ...]
• Interleaved: [C0S0, C1S0, C0S1, C1S1, ...] (converted to planar at build time)

pub fn metadata<S: Into<String>>(self, meta: S) -> Self

Set metadata

pub fn timestamp(self, ts: i64) -> Self

Set the timestamp field in 100 ns units. This field is filled by the SDK on receive.

pub fn build(self) -> Result<AudioFrame>

Build the audio frame.

Defaults to 48 kHz stereo FLTP, 1024 samples per channel, planar input, synthesized timecode, and silent samples.

When AudioLayout::Interleaved is set, the input data is converted to planar format in Rust. The resulting frame always stores planar data with channel_stride_in_bytes = num_samples * 4.

Trait Implementations

impl Clone for AudioFrameBuilder

fn clone(&self) -> AudioFrameBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioFrameBuilder

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

Formats the value using the given formatter.

impl Default for AudioFrameBuilder

fn default() -> Self

Returns the “default value” for a type.