#[non_exhaustive]
#[repr(i32)]
pub enum AudioChannelPosition {
Show 31 variants None = -3, Mono, Invalid, FrontLeft, FrontRight, FrontCenter, Lfe1, RearLeft, RearRight, FrontLeftOfCenter, FrontRightOfCenter, RearCenter, Lfe2, SideLeft, SideRight, TopFrontLeft, TopFrontRight, TopFrontCenter, TopCenter, TopRearLeft, TopRearRight, TopSideLeft, TopSideRight, TopRearCenter, BottomFrontCenter, BottomFrontLeft, BottomFrontRight, WideLeft, WideRight, SurroundLeft, SurroundRight = 27,
}
Expand description

Audio channel positions.

These are the channels defined in SMPTE 2036-2-2008 Table 1 for 22.2 audio systems with the Surround and Wide channels from DTS Coherent Acoustics (v.1.3.1) and 10.2 and 7.1 layouts. In the caps the actual channel layout is expressed with a channel count and a channel mask, which describes the existing channels. The positions in the bit mask correspond to the enum values. For negotiation it is allowed to have more bits set in the channel mask than the number of channels to specify the allowed channel positions but this is not allowed in negotiated caps. It is not allowed in any situation other than the one mentioned below to have less bits set in the channel mask than the number of channels.

Mono can only be used with a single mono channel that has no direction information and would be mixed into all directional channels. This is expressed in caps by having a single channel and no channel mask.

None can only be used if all channels have this position. This is expressed in caps by having a channel mask with no bits set.

As another special case it is allowed to have two channels without a channel mask. This implicitly means that this is a stereo stream with a front left and front right channel.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

None = -3

used for position-less channels, e.g. from a sound card that records 1024 channels; mutually exclusive with any other channel position

§

Mono

Mono without direction; can only be used with 1 channel

§

Invalid

invalid position

§

FrontLeft

Front left

§

FrontRight

Front right

§

FrontCenter

Front center

§

Lfe1

Low-frequency effects 1 (subwoofer)

§

RearLeft

Rear left

§

RearRight

Rear right

§

FrontLeftOfCenter

Front left of center

§

FrontRightOfCenter

Front right of center

§

RearCenter

Rear center

§

Lfe2

Low-frequency effects 2 (subwoofer)

§

SideLeft

Side left

§

SideRight

Side right

§

TopFrontLeft

Top front left

§

TopFrontRight

Top front right

§

TopFrontCenter

Top front center

§

TopCenter

Top center

§

TopRearLeft

Top rear left

§

TopRearRight

Top rear right

§

TopSideLeft

Top side right

§

TopSideRight

Top rear right

§

TopRearCenter

Top rear center

§

BottomFrontCenter

Bottom front center

§

BottomFrontLeft

Bottom front left

§

BottomFrontRight

Bottom front right

§

WideLeft

Wide left (between front left and side left)

§

WideRight

Wide right (between front right and side right)

§

SurroundLeft

Surround left (between rear left and side left)

§

SurroundRight = 27

Surround right (between rear right and side right)

Implementations§

source§

impl AudioChannelPosition

source

pub fn to_mask(self) -> u64

source

pub fn positions_to_mask( positions: &[Self], force_order: bool ) -> Result<u64, BoolError>

source

pub fn positions_from_mask( mask: u64, positions: &mut [Self] ) -> Result<(), BoolError>

source

pub fn positions_to_valid_order(positions: &mut [Self]) -> Result<(), BoolError>

source

pub fn fallback_mask(channels: u32) -> u64

source

pub fn check_valid_channel_positions( positions: &[Self], force_order: bool ) -> bool

Trait Implementations§

source§

impl Clone for AudioChannelPosition

source§

fn clone(&self) -> AudioChannelPosition

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for AudioChannelPosition

source§

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

Formats the value using the given formatter. Read more
source§

impl From<AudioChannelPosition> for Value

source§

fn from(v: AudioChannelPosition) -> Self

Converts to this type from the input type.
source§

impl<'a> FromValue<'a> for AudioChannelPosition

§

type Checker = GenericValueTypeChecker<AudioChannelPosition>

Value type checker.
source§

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value. Read more
source§

impl Hash for AudioChannelPosition

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for AudioChannelPosition

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for AudioChannelPosition

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for AudioChannelPosition

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl StaticType for AudioChannelPosition

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl ToValue for AudioChannelPosition

source§

fn to_value(&self) -> Value

Convert a value to a Value.
source§

fn value_type(&self) -> Type

Returns the type identifier of self. Read more
source§

impl TransparentType for AudioChannelPosition

source§

impl ValueType for AudioChannelPosition

§

type Type = AudioChannelPosition

Type to get the Type from. Read more
source§

impl Copy for AudioChannelPosition

source§

impl Eq for AudioChannelPosition

source§

impl StructuralPartialEq for AudioChannelPosition

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToSendValue for T
where T: Send + ToValue + ?Sized,

source§

fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.