Struct StreamFormat 

pub struct StreamFormat { /* private fields */ }

A cross-platform mirror of AudioStreamBasicDescription.

Constructed with the typed constructors (Self::float32, Self::int16, …) for the standard interleaved linear-PCM streams, or with Self::from_raw for round-tripping an ASBD the framework received over the FFI boundary. The derived per-packet / per-frame byte counts are computed at construction.

Implementations

impl StreamFormat

pub const fn from_raw( sample_rate: f64, format_id: u32, format_flags: u32, bytes_per_packet: u32, frames_per_packet: u32, bytes_per_frame: u32, channels_per_frame: u32, bits_per_channel: u32, ) -> Self

Construct a format directly from the nine ASBD fields (mReserved excluded — it is always zero).

Prefer the typed constructors for standard streams; this raw form exists for round-tripping an AudioStreamBasicDescription received from the HAL.

pub const fn linear_pcm( sample: SampleFormat, sample_rate: f64, channels: u32, ) -> Self

Build a packed, interleaved, native-endian linear-PCM format from a SampleFormat.

pub const fn float32(sample_rate: f64, channels: u32) -> Self

32-bit IEEE float interleaved linear PCM — the canonical AudioServerPlugin interchange format.

pub const fn int16(sample_rate: f64, channels: u32) -> Self

16-bit signed integer interleaved linear PCM.

pub const fn int24(sample_rate: f64, channels: u32) -> Self

24-bit signed integer interleaved linear PCM.

pub const fn int32(sample_rate: f64, channels: u32) -> Self

32-bit signed integer interleaved linear PCM.

pub const fn sample_rate(&self) -> f64

mSampleRate — frames per second.

pub const fn format_id(&self) -> u32

mFormatID — the codec / encoding identifier. Always FORMAT_LINEAR_PCM for the typed constructors.

pub const fn format_flags(&self) -> u32

mFormatFlags — the kAudioFormatFlag* bit set.

pub const fn bytes_per_packet(&self) -> u32

mBytesPerPacket.

pub const fn frames_per_packet(&self) -> u32

mFramesPerPacket.

pub const fn bytes_per_frame(&self) -> u32

mBytesPerFrame — bytes for one frame across all channels.

pub const fn channels(&self) -> u32

mChannelsPerFrame — the channel count.

pub const fn bits_per_channel(&self) -> u32

mBitsPerChannel — significant bits per sample.

pub const fn is_linear_pcm(&self) -> bool

true iff this is a linear-PCM stream (FORMAT_LINEAR_PCM).

pub const fn is_float(&self) -> bool

true iff the samples are IEEE floating point.

pub const fn is_packed(&self) -> bool

true iff every bit of the sample word is significant.

pub const fn is_non_interleaved(&self) -> bool

true iff each channel occupies its own buffer.

pub fn sample_format(&self) -> Option<SampleFormat>

Identify the SampleFormat of this stream, or None if it is not one of the four standard packed interleaved layouts.

pub fn is_canonical(&self) -> bool

true iff this is the canonical interchange format: packed, interleaved 32-bit float linear PCM.

Trait Implementations

impl Clone for StreamFormat

fn clone(&self) -> StreamFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamFormat

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

Formats the value using the given formatter.

impl PartialEq for StreamFormat

fn eq(&self, other: &StreamFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for StreamFormat

impl StructuralPartialEq for StreamFormat