Enum Position

#[repr(C)]
pub enum Position {
    Invalid = -1,
    Mono = 0,
    FrontLeft = 1,
    FrontRight = 2,
    FrontCenter = 3,
    RearCenter = 4,
    RearLeft = 5,
    RearRight = 6,
    Lfe = 7,
    FrontLeftOfCenter = 8,
    FrontRightOfCenter = 9,
    SideLeft = 10,
    SideRight = 11,
    Aux0 = 12,
    Aux1 = 13,
    Aux2 = 14,
    Aux3 = 15,
    Aux4 = 16,
    Aux5 = 17,
    Aux6 = 18,
    Aux7 = 19,
    Aux8 = 20,
    Aux9 = 21,
    Aux10 = 22,
    Aux11 = 23,
    Aux12 = 24,
    Aux13 = 25,
    Aux14 = 26,
    Aux15 = 27,
    Aux16 = 28,
    Aux17 = 29,
    Aux18 = 30,
    Aux19 = 31,
    Aux20 = 32,
    Aux21 = 33,
    Aux22 = 34,
    Aux23 = 35,
    Aux24 = 36,
    Aux25 = 37,
    Aux26 = 38,
    Aux27 = 39,
    Aux28 = 40,
    Aux29 = 41,
    Aux30 = 42,
    Aux31 = 43,
    TopCenter = 44,
    TopFrontLeft = 45,
    TopFrontRight = 46,
    TopFrontCenter = 47,
    TopRearLeft = 48,
    TopRearRight = 49,
    TopRearCenter = 50,
}

A list of channel labels.

Note, certain aliases, specifically Left, Right, Center and Subwoofer, available in the equivalent C enum are not provided here, since Rust does not allow aliases.

Variants

Invalid = -1

Invalid.

Mono = 0

Mono.

FrontLeft = 1

Apple, Dolby call this ‘Left’.

FrontRight = 2

Apple, Dolby call this ‘Right’.

FrontCenter = 3

Apple, Dolby call this ‘Center’.

RearCenter = 4

Microsoft calls this ‘Back Center’, Apple calls this ‘Center Surround’, Dolby calls this ‘Surround Rear Center’.

RearLeft = 5

Microsoft calls this ‘Back Left’, Apple calls this ‘Left Surround’, Dolby calls this ‘Surround Rear Left’.

RearRight = 6

Microsoft calls this ‘Back Right’, Apple calls this ‘Right Surround’, Dolby calls this ‘Surround Rear Right’.

Lfe = 7

Aka subwoofer. Microsoft calls this ‘Low Frequency’, Apple calls this ‘LFEScreen’.

FrontLeftOfCenter = 8

Apple, Dolby call this ‘Left Center’.

FrontRightOfCenter = 9

Apple, Dolby call this ‘Right Center’.

SideLeft = 10

Apple calls this ‘Left Surround Direct’, Dolby calls this ‘Surround Left’.

SideRight = 11

Apple calls this ‘Right Surround Direct’, Dolby calls this ‘Surround Right’.

Aux0 = 12

Auxillary 0.

Aux1 = 13

Auxillary 1.

Aux2 = 14

Auxillary 2.

Aux3 = 15

Auxillary 3.

Aux4 = 16

Auxillary 4.

Aux5 = 17

Auxillary 5.

Aux6 = 18

Auxillary 6.

Aux7 = 19

Auxillary 7.

Aux8 = 20

Auxillary 8.

Aux9 = 21

Auxillary 9.

Aux10 = 22

Auxillary 10.

Aux11 = 23

Auxillary 11.

Aux12 = 24

Auxillary 12.

Aux13 = 25

Auxillary 13.

Aux14 = 26

Auxillary 14.

Aux15 = 27

Auxillary 15.

Aux16 = 28

Auxillary 16.

Aux17 = 29

Auxillary 17.

Aux18 = 30

Auxillary 18.

Aux19 = 31

Auxillary 19.

Aux20 = 32

Auxillary 20.

Aux21 = 33

Auxillary 21.

Aux22 = 34

Auxillary 22.

Aux23 = 35

Auxillary 23.

Aux24 = 36

Auxillary 24.

Aux25 = 37

Auxillary 25.

Aux26 = 38

Auxillary 26.

Aux27 = 39

Auxillary 27.

Aux28 = 40

Auxillary 28.

Aux29 = 41

Auxillary 29.

Aux30 = 42

Auxillary 30.

Aux31 = 43

Auxillary 31.

TopCenter = 44

Apple calls this ‘Top Center Surround’.

TopFrontLeft = 45

Apple calls this ‘Vertical Height Left’.

TopFrontRight = 46

Apple calls this ‘Vertical Height Right’.

TopFrontCenter = 47

Apple calls this ‘Vertical Height Center’.

TopRearLeft = 48

Microsoft and Apple call this ‘Top Back Left’.

TopRearRight = 49

Microsoft and Apple call this ‘Top Back Right’.

TopRearCenter = 50

Microsoft and Apple call this ‘Top Back Center’.

Implementations

impl Position

pub const fn to_mask(self) -> PositionMask

Makes a bit mask from a channel position.

pub fn to_string(pos: Self) -> Option<Cow<'static, str>>

Gets a text label for the specified channel position.

pub fn to_pretty_string(pos: Self) -> Option<String>

Gets a human readable text label for the specified channel position.

pub fn from_string(s: &str) -> Self

Creates a new instance from a string representation, as given by to_string().

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Position

Returns the “default value” for a type.

impl From<Position> for pa_channel_position_t

fn from(p: Position) -> Self

Converts to this type from the input type.

impl From<pa_channel_position_t> for Position

fn from(p: pa_channel_position_t) -> Self

Converts to this type from the input type.

impl FromPrimitive for Position

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl PartialEq for Position

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

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl Copy for Position

impl Eq for Position

impl StructuralPartialEq for Position