Struct ndi::AudioData

pub struct AudioData { /* fields omitted */ }

An audio frame

Implementations

impl AudioData

pub fn new() -> Self

Create new instance of AudioData

pub fn sample_rate(&self) -> u32

The sample-rate of this buffer

pub fn no_channels(&self) -> u32

The number of audio channels

pub fn no_samples(&self) -> u32

The number of audio samples per channel

pub fn timecode(&self) -> i64

The timecode of this frame in 100ns intervals

pub fn timestamp(&self) -> Option<i64>

A per-frame timestamp filled in by the NDI SDK using a high precision clock.

This is only valid when receiving a frame. It represents the time (in 100 ns intervals measured in UTC time, since the Unix Time Epoch 1/1/1970 00:00 of the exact moment that the frame was submitted by the sending side If this value is None then this value is not available.

pub fn p_data(&self) -> *mut u8

A pointer to the audio data

If FourCC is NDIlib_FourCC_type_FLTP, then this is the floating-point audio data in planar format, with each audio channel stored together with a stride between channels specified by channel_stride_in_bytes.

pub fn four_cc(&self) -> FourCCAudioType

What FourCC type is for this frame

There is currently one supported format: FLTP.

pub fn channel_stride_in_bytes(&self) -> u32

The stride in bytes for a single channel.

This is the number of bytes that are used to step from one audio channel to another.

pub fn metadata(&self) -> String

This is a per frame metadata stream in XML

It is sent and received with the frame.

Trait Implementations

impl Debug for AudioData

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

Formats the value using the given formatter.

impl Drop for AudioData

fn drop(&mut self)

Executes the destructor for this type.

impl Send for AudioData

impl Sync for AudioData