[−][src]Enum soundio::ChannelId

pub enum ChannelId {
    Invalid,
    FrontLeft,
    FrontRight,
    FrontCenter,
    Lfe,
    BackLeft,
    BackRight,
    FrontLeftCenter,
    FrontRightCenter,
    BackCenter,
    SideLeft,
    SideRight,
    TopCenter,
    TopFrontLeft,
    TopFrontCenter,
    TopFrontRight,
    TopBackLeft,
    TopBackCenter,
    TopBackRight,
    BackLeftCenter,
    BackRightCenter,
    FrontLeftWide,
    FrontRightWide,
    FrontLeftHigh,
    FrontCenterHigh,
    FrontRightHigh,
    TopFrontLeftCenter,
    TopFrontRightCenter,
    TopSideLeft,
    TopSideRight,
    LeftLfe,
    RightLfe,
    Lfe2,
    BottomCenter,
    BottomLeftCenter,
    BottomRightCenter,
    MsMid,
    MsSide,
    AmbisonicW,
    AmbisonicX,
    AmbisonicY,
    AmbisonicZ,
    XyX,
    XyY,
    HeadphonesLeft,
    HeadphonesRight,
    ClickTrack,
    ForeignLanguage,
    HearingImpaired,
    Narration,
    Haptic,
    DialogCentricMix,
    Aux,
    Aux0,
    Aux1,
    Aux2,
    Aux3,
    Aux4,
    Aux5,
    Aux6,
    Aux7,
    Aux8,
    Aux9,
    Aux10,
    Aux11,
    Aux12,
    Aux13,
    Aux14,
    Aux15,
}

ChannelId indicates the location or intent of a channel (left, right, LFE, etc.).

It supports the Display trait so that you can convert ChannelId::FrontLeft to "Front Left" for example.

Examples

println!("Layout: {}", ChannelId::FrontLeftCenter);

assert_eq!(format!("{}", ChannelId::MsMid), "Mid/Side Mid");

Variants

Invalid
FrontLeft

The more commonly supported ids.

FrontRight
FrontCenter
Lfe
BackLeft
BackRight
FrontLeftCenter
FrontRightCenter
BackCenter
SideLeft
SideRight
TopCenter
TopFrontLeft
TopFrontCenter
TopFrontRight
TopBackLeft
TopBackCenter
TopBackRight
BackLeftCenter

The less commonly supported ids.

BackRightCenter
FrontLeftWide
FrontRightWide
FrontLeftHigh
FrontCenterHigh
FrontRightHigh
TopFrontLeftCenter
TopFrontRightCenter
TopSideLeft
TopSideRight
LeftLfe
RightLfe
Lfe2
BottomCenter
BottomLeftCenter
BottomRightCenter
MsMid

Mid/side recording

MsSide
AmbisonicW

First order ambisonic channels

AmbisonicX
AmbisonicY
AmbisonicZ
XyX

X-Y Recording

XyY
HeadphonesLeft

The "other" channel ids

HeadphonesRight
ClickTrack
ForeignLanguage
HearingImpaired
Narration
Haptic
DialogCentricMix
Aux
Aux0
Aux1
Aux2
Aux3
Aux4
Aux5
Aux6
Aux7
Aux8
Aux9
Aux10
Aux11
Aux12
Aux13
Aux14
Aux15

Methods

impl ChannelId[src]

pub fn parse(id: &str) -> Option<ChannelId>[src]

Given UTF-8 encoded text which is the name of a channel such as "Front Left", "FL", or "front-left", return the corresponding ChannelId. Returns None for no match.

Examples

assert_eq!(ChannelId::parse("Front Left Center"), Some(ChannelId::FrontLeftCenter));
assert_eq!(ChannelId::parse("FLC"), Some(ChannelId::FrontLeftCenter));
assert_eq!(ChannelId::parse("front-left-of-center"), Some(ChannelId::FrontLeftCenter));
assert_eq!(ChannelId::parse("Shot is the best!"), None);

Trait Implementations

impl Clone for ChannelId[src]

impl Copy for ChannelId[src]

impl Debug for ChannelId[src]

impl Display for ChannelId[src]

impl Eq for ChannelId[src]

impl From<ChannelId> for SoundIoChannelId[src]

impl From<SoundIoChannelId> for ChannelId[src]

impl PartialEq<ChannelId> for ChannelId[src]

impl StructuralEq for ChannelId[src]

impl StructuralPartialEq for ChannelId[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.