Struct PcmSpec 

pub struct PcmSpec { /* private fields */ }

Audio format description for a PCM stream: channel count, sample rate, and sample encoding.

A PcmSpec is the validated, immutable contract shared by PCM buffers, sources, and sinks. It is constructed through PcmSpec::i16 or PcmSpec::f32, which reject a zero channel count or zero sample rate, so a constructed value is always a usable audio configuration.

Examples

use sim_lib_stream_audio::{PcmSampleFormat, PcmSpec};

let spec = PcmSpec::f32(2, 48_000)?;
assert_eq!(spec.channels(), 2);
assert_eq!(spec.sample_rate_hz(), 48_000);
assert_eq!(spec.sample_format(), PcmSampleFormat::F32);

Implementations

impl PcmSpec

pub fn i16(channels: usize, sample_rate_hz: u32) -> Result<Self>

Builds an interleaved 16-bit signed integer (PcmSampleFormat::I16) spec.

Returns an error when channels or sample_rate_hz is zero.

pub fn f32(channels: usize, sample_rate_hz: u32) -> Result<Self>

Builds an interleaved 32-bit float (PcmSampleFormat::F32) spec.

Returns an error when channels or sample_rate_hz is zero.

pub fn channels(self) -> usize

Returns the number of interleaved audio channels.

pub fn sample_rate_hz(self) -> u32

Returns the sample rate in hertz (frames per second).

pub fn sample_format(self) -> PcmSampleFormat

Returns the per-sample encoding.

Trait Implementations

impl Clone for PcmSpec

fn clone(&self) -> PcmSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PcmSpec

impl Debug for PcmSpec

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

Formats the value using the given formatter.

impl Eq for PcmSpec

impl PartialEq for PcmSpec

fn eq(&self, other: &PcmSpec) -> 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 StructuralPartialEq for PcmSpec