Enum gstreamer_audio::AudioChannelPosition

#[non_exhaustive]
pub enum AudioChannelPosition {
    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)

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

pub fn to_mask(self) -> u64

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

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

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

pub fn fallback_mask(channels: u32) -> u64

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

Trait Implementations

impl Clone for AudioChannelPosition

fn clone(&self) -> AudioChannelPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioChannelPosition

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

Formats the value using the given formatter.

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

type Checker = GenericValueTypeChecker<Self>

Value type checker.

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

Get the contained value from a Value.

impl Hash for AudioChannelPosition

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for AudioChannelPosition

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<AudioChannelPosition> for AudioChannelPosition

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

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

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

This method tests for !=.

impl PartialOrd<AudioChannelPosition> for AudioChannelPosition

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl StaticType for AudioChannelPosition

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for AudioChannelPosition

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ValueType for AudioChannelPosition

type Type = Self

Type to get the Type from.

impl Copy for AudioChannelPosition

impl Eq for AudioChannelPosition

impl StructuralEq for AudioChannelPosition

impl StructuralPartialEq for AudioChannelPosition