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
}

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

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

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

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

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.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<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: &Rhs) -> bool

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

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.

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

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

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

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

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

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

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 = AudioChannelPosition

Type to get the Type from.

impl Copy for AudioChannelPosition

impl Eq for AudioChannelPosition

impl StructuralEq for AudioChannelPosition

impl StructuralPartialEq for AudioChannelPosition