Enum gstreamer_audio::AudioChannelPosition[−][src]

#[non_exhaustive]
pub enum AudioChannelPosition {
Show variants    None,
    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,
    // some variants omitted
}

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.

Self::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.

Self::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

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

Surround right (between rear right and side right)

Implementations

`impl AudioChannelPosition`[src]

`pub fn to_mask(self) -> u64`[src]

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

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

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

`pub fn fallback_mask(channels: u32) -> u64`[src]

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

Trait Implementations

`impl Clone for AudioChannelPosition`[src]

`fn clone(&self) -> AudioChannelPosition`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl Debug for AudioChannelPosition`[src]

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

Formats the value using the given formatter. Read more

`impl<'a> FromValue<'a> for AudioChannelPosition`[src]

`type Checker = GenericValueTypeChecker<Self>`

Value type checker.

`unsafe fn from_value(value: &'a Value) -> Self`[src]

Get the contained value from a Value. Read more

`impl Hash for AudioChannelPosition`[src]

`fn hash<H: Hasher>(&self, state: &mut H)`[src]

Feeds this value into the given Hasher. Read more

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

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

`impl Ord for AudioChannelPosition`[src]

`fn cmp(&self, other: &AudioChannelPosition) -> Ordering`[src]

This method returns an Ordering between self and other. Read more

`#[must_use] fn max(self, other: Self) -> Self`1.21.0 [src]

Compares and returns the maximum of two values. Read more

`#[must_use] fn min(self, other: Self) -> Self`1.21.0 [src]

Compares and returns the minimum of two values. Read more

`#[must_use] fn clamp(self, min: Self, max: Self) -> Self`1.50.0 [src]

Restrict a value to a certain interval. Read more

`impl PartialEq<AudioChannelPosition> for AudioChannelPosition`[src]

`fn eq(&self, other: &AudioChannelPosition) -> bool`[src]

This method tests for self and other values to be equal, and is used by ==. Read more

`fn ne(&self, other: &AudioChannelPosition) -> bool`[src]

This method tests for !=.

`impl PartialOrd<AudioChannelPosition> for AudioChannelPosition`[src]

`fn partial_cmp(&self, other: &AudioChannelPosition) -> Option<Ordering>`[src]

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

`#[must_use] fn lt(&self, other: &Rhs) -> bool`1.0.0 [src]

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

`#[must_use] fn le(&self, other: &Rhs) -> bool`1.0.0 [src]

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

`#[must_use] fn gt(&self, other: &Rhs) -> bool`1.0.0 [src]

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

`#[must_use] fn ge(&self, other: &Rhs) -> bool`1.0.0 [src]

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

`impl StaticType for AudioChannelPosition`[src]

`fn static_type() -> Type`[src]

Returns the type identifier of Self.

`impl ToValue for AudioChannelPosition`[src]

`fn to_value(&self) -> Value`[src]

Convert a value to a Value.

`fn value_type(&self) -> Type`[src]

Returns the type identifer of self. Read more

`impl ValueType for AudioChannelPosition`[src]

`type Type = Self`

Type to get the Type from. Read more

`impl Copy for AudioChannelPosition`[src]

`impl Eq for AudioChannelPosition`[src]

`impl StructuralEq for AudioChannelPosition`[src]

`impl StructuralPartialEq for AudioChannelPosition`[src]

Auto Trait Implementations

`impl RefUnwindSafe for AudioChannelPosition`

`impl Send for AudioChannelPosition`

`impl Sync for AudioChannelPosition`

`impl Unpin for AudioChannelPosition`

`impl UnwindSafe for AudioChannelPosition`

Blanket Implementations

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

`pub fn type_id(&self) -> TypeId`[src]

Gets the TypeId of self. Read more

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

`pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

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

`pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

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

`pub fn from(t: T) -> T`[src]

Performs the conversion.

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

`pub fn into(self) -> U`[src]

Performs the conversion.

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

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

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

`pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

`impl<T> ToSendValue for T where T: Send + ToValue + ?Sized,` [src]

`pub fn to_send_value(&self) -> SendValue`[src]

Returns a SendValue clone of self.

`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.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

`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.

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.