Enum PcmLayout 

pub enum PcmLayout {
    Interleaved,
    Planar,
}

Available on crate feature audio only.

🔊 🧱 Sample arrangement of a PCM buffer.

---

^{📍 media/audio}

^{📦 size_of::<PcmLayout>() == 1 bytes / 8 bits}

---

A PCM layout describes how channel samples are placed in memory.

It is independent from PcmSpec: the same sample type, channel layout, and sample rate can be represented as either interleaved or planar data.

Variants

Interleaved

Channel samples are mixed by frame: LRLRLR….

Planar

Channel samples are stored in separate planes: [LLLL…], [RRRR…].

Implementations

impl PcmLayout

pub const fn as_code(self) -> &'static str

Returns a compact stable code for this layout.

pub const fn as_name(self) -> &'static str

Returns a human-readable name for this layout.

pub const fn is_interleaved(self) -> bool

Returns whether this layout stores all channel samples in one mixed slice.

pub const fn is_planar(self) -> bool

Returns whether this layout stores each channel in its own sample plane.

Trait Implementations

impl Clone for PcmLayout

fn clone(&self) -> PcmLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstInit for PcmLayout

const INIT: Self = Self::Interleaved

Returns the compile-time “initial value” for a type.

impl Copy for PcmLayout

impl Debug for PcmLayout

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

Formats the value using the given formatter.

impl Default for PcmLayout

fn default() -> PcmLayout

Returns the “default value” for a type.

impl Display for PcmLayout

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

Formats the value using the given formatter.

impl Eq for PcmLayout

impl Hash for PcmLayout

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 Ord for PcmLayout

fn cmp(&self, other: &PcmLayout) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PcmLayout

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

fn partial_cmp(&self, other: &PcmLayout) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for PcmLayout