Enum gstreamer_audio::AudioChannelPosition

[−] Show declaration

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
}

[−] 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.

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

AudioChannelPosition::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 implicitely means that this is a stereo stream with a front left and front right channel.

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

Methods

impl AudioChannelPosition[−]

pub fn to_mask(self) -> u64

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

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

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

pub fn get_fallback_mask(channels: u32) -> u64

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

Trait Implementations

impl Clone for AudioChannelPosition[+]

[+] Show hidden undocumented items

fn clone(&self) -> AudioChannelPosition[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for AudioChannelPosition

impl Debug for AudioChannelPosition[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Eq for AudioChannelPosition

impl<'a> FromValue<'a> for AudioChannelPosition[+]

[+] Show hidden undocumented items

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

impl<'a> FromValueOptional<'a> for AudioChannelPosition[+]

[+] Show hidden undocumented items

unsafe fn from_value_optional(value: &Value) -> Option<Self>

impl Hash for AudioChannelPosition[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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

This method returns an [Ordering] between self and other.

[+] Expand attributes

#[must_use] fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use] fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

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

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

Restrict a value to a certain interval.

impl PartialEq<AudioChannelPosition> for AudioChannelPosition[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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

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

fn lt(&self, other: &AudioChannelPosition) -> bool[−]

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

fn le(&self, other: &AudioChannelPosition) -> bool[−]

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

fn gt(&self, other: &AudioChannelPosition) -> bool[−]

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

fn ge(&self, other: &AudioChannelPosition) -> bool[−]

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

impl SetValue for AudioChannelPosition[+]

[+] Show hidden undocumented items

unsafe fn set_value(value: &mut Value, this: &Self)

impl StaticType for AudioChannelPosition[+]

[+] Show hidden undocumented items

fn static_type() -> Type[−]

Returns the type identifier of Self.

impl StructuralEq for AudioChannelPosition

impl StructuralPartialEq for AudioChannelPosition