Enum Layout 

#[non_exhaustive]
pub enum Layout {
    Mono,
    Stereo,
    Discrete(u32),
    TwoPointOne,
    ThreePointZero,
    Quad,
    FourPointZero,
    FivePointZero,
    FivePointOne,
    SixPointOne,
    SevenPointOne,
}

Speaker meaning and interleaving order for PCM channels.

Named layouts interleave in the SMPTE/WAVE order (front left, front right, center, LFE, back left, back right, back center, side left, side right), keeping only the speakers the layout has. Every decoder reorders its codec’s native order into this one.

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.

Mono

One center channel.

Stereo

Left then right channels.

Discrete(u32)

Channels with no declared speaker positions, in source order.

Passes through unchanged but can’t be remixed into another layout.

TwoPointOne

2.1: left, right, LFE.

ThreePointZero

3.0: left, right, center.

Quad

Quad: left, right, back left, back right.

FourPointZero

4.0: left, right, center, back center.

FivePointZero

5.0: left, right, center, side left, side right.

FivePointOne

5.1: left, right, center, LFE, side left, side right.

SixPointOne

6.1: left, right, center, LFE, back center, side left, side right.

SevenPointOne

7.1: left, right, center, LFE, back left, back right, side left, side right.

Implementations

impl Layout

pub fn from_channels(channels: u32) -> Result<Self, Error>

The default layout for a channel count, by the WAVE convention: 1 is mono, 2 stereo, 3 2.1, 4 quad, 5 5.0, 6 5.1, 7 6.1, and 8 7.1.

Any other count is Discrete, since there is no convention to take speaker positions from.

pub fn channels(self) -> u32

Number of interleaved channels in this layout.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Layout

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Layout

impl PartialEq for Layout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Layout