Struct SamplingFrequencyIndex 

pub struct SamplingFrequencyIndex(/* private fields */);

A 4-bit sampling frequency index as defined in ISO 14496-3.

Indices 0x0–0xc map to the 13 standard sampling rates (96 kHz down to 7.35 kHz). Indices 0xd–0xe are reserved. Index 0xf is excluded from this type as it signals that an explicit 24-bit frequency value follows in the bitstream instead.

Use freq to look up the sampling rate in Hz, which returns None for reserved indices.

Implementations

impl SamplingFrequencyIndex

pub const FREQ_96000: SamplingFrequencyIndex

96 kHz (index 0x0).

pub const FREQ_88200: SamplingFrequencyIndex

88.2 kHz (index 0x1).

pub const FREQ_64000: SamplingFrequencyIndex

64 kHz (index 0x2).

pub const FREQ_48000: SamplingFrequencyIndex

48 kHz (index 0x3).

pub const FREQ_44100: SamplingFrequencyIndex

44.1 kHz (index 0x4).

pub const FREQ_32000: SamplingFrequencyIndex

32 kHz (index 0x5).

pub const FREQ_24000: SamplingFrequencyIndex

24 kHz (index 0x6).

pub const FREQ_22050: SamplingFrequencyIndex

22.05 kHz (index 0x7).

pub const FREQ_16000: SamplingFrequencyIndex

16 kHz (index 0x8).

pub const FREQ_12000: SamplingFrequencyIndex

12 kHz (index 0x9).

pub const FREQ_11025: SamplingFrequencyIndex

11.025 kHz (index 0xa).

pub const FREQ_8000: SamplingFrequencyIndex

8 kHz (index 0xb).

pub const FREQ_7350: SamplingFrequencyIndex

7.35 kHz (index 0xc).

pub const fn new(value: u8) -> SamplingFrequencyIndex

Creates a SamplingFrequencyIndex from a 4-bit value.

Panics if value is 0xf (the escape value) or greater than 0xe. In const context, an invalid value produces a compile-time error.

pub fn freq(&self) -> Option<u32>

Returns the sampling rate in Hz, or None if the index is reserved or not yet defined.

Trait Implementations

impl Clone for SamplingFrequencyIndex

fn clone(&self) -> SamplingFrequencyIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SamplingFrequencyIndex

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

Formats the value using the given formatter.

impl PartialEq for SamplingFrequencyIndex

fn eq(&self, other: &SamplingFrequencyIndex) -> 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 TryFrom<u8> for SamplingFrequencyIndex

type Error = SamplingFrequencyIndexError

The type returned in the event of a conversion error.

fn try_from( value: u8, ) -> Result<SamplingFrequencyIndex, <SamplingFrequencyIndex as TryFrom<u8>>::Error>

Performs the conversion.

impl Copy for SamplingFrequencyIndex

impl Eq for SamplingFrequencyIndex

impl StructuralPartialEq for SamplingFrequencyIndex