Enum ChannelLayout

pub enum ChannelLayout {
    Mono,
    Stereo,
    Surround51,
    Surround71,
    AmbisonicFoa,
    AmbisonicSoa,
    AmbisonicToa,
    Custom(usize),
}

Describes the channel layout for audio processing.

Standard layouts include mono, stereo, surround formats, and ambisonics. Use Custom(n) for arbitrary channel counts.

Variants

Mono

Single channel (mono).

Stereo

Two channels (left, right).

Surround51

5.1 surround: L, R, C, LFE, Ls, Rs (6 channels).

Surround71

7.1 surround: L, R, C, LFE, Ls, Rs, Lrs, Rrs (8 channels).

AmbisonicFoa

First-order ambisonics (4 channels: W, Y, Z, X).

AmbisonicSoa

Second-order ambisonics (9 channels).

AmbisonicToa

Third-order ambisonics (16 channels).

Custom(usize)

Custom channel count for non-standard configurations.

Implementations

impl ChannelLayout

pub const fn channel_count(&self) -> usize

Returns the number of channels for this layout.

pub const fn is_ambisonic(&self) -> bool

Returns true if this is an ambisonic layout.

pub const fn ambisonic_order(&self) -> Option<usize>

Returns the ambisonic order if this is an ambisonic layout.

Returns None for non-ambisonic layouts.

pub const fn from_ambisonic_order(order: usize) -> Option<ChannelLayout>

Creates an ambisonic layout from an order (1-3).

Returns None if the order is out of range.

pub const fn ambisonic_channel_count(order: usize) -> usize

Returns the number of channels for a given ambisonic order.

Formula: (order + 1)^2

Trait Implementations

impl Clone for ChannelLayout

fn clone(&self) -> ChannelLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelLayout

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

Formats the value using the given formatter.

impl Default for ChannelLayout

fn default() -> ChannelLayout

Returns the “default value” for a type.

impl Hash for ChannelLayout

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

where __H: Hasher,

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 ChannelLayout

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

impl Eq for ChannelLayout

impl StructuralPartialEq for ChannelLayout