Enum SampleFormat 

#[non_exhaustive]
pub enum SampleFormat {
    Int16,
    Int24,
    Int32,
    Float32,
}

The sample type and width of a linear-PCM stream.

Covers the sample formats an AudioServerPlugin realistically negotiates. Anything outside this set is still representable as a raw StreamFormat via StreamFormat::from_raw, but the typed constructors and StreamFormat::sample_format only know these.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Int16

16-bit signed integer samples.

Int24

24-bit signed integer samples packed into 3-byte words.

Int32

32-bit signed integer samples.

Float32

32-bit IEEE float samples — the canonical interchange format.

Implementations

impl SampleFormat

pub const fn bits_per_channel(self) -> u32

Bits per individual sample (one channel of one frame).

pub const fn bytes_per_channel(self) -> u32

Bytes occupied by one sample in a packed stream.

pub const fn format_flags(self) -> u32

The kAudioFormatFlag* bits this sample format implies for a packed, interleaved, native-endian stream.

Trait Implementations

impl Clone for SampleFormat

fn clone(&self) -> SampleFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SampleFormat

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

Formats the value using the given formatter.

impl Hash for SampleFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SampleFormat

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

impl Eq for SampleFormat

impl StructuralPartialEq for SampleFormat