Enum gstreamer_audio::AudioFormat

#[non_exhaustive]
pub enum AudioFormat {
    Unknown,
    Encoded,
    S8,
    U8,
    S16le,
    S16be,
    U16le,
    U16be,
    S2432le,
    S2432be,
    U2432le,
    U2432be,
    S32le,
    S32be,
    U32le,
    U32be,
    S24le,
    S24be,
    U24le,
    U24be,
    S20le,
    S20be,
    U20le,
    U20be,
    S18le,
    S18be,
    U18le,
    U18be,
    F32le,
    F32be,
    F64le,
    F64be,
    // some variants omitted
}

Enum value describing the most common audio formats.

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.

Unknown

unknown or unset audio format

Encoded

encoded audio format

S8

8 bits in 8 bits, signed

U8

8 bits in 8 bits, unsigned

S16le

16 bits in 16 bits, signed, little endian

S16be

16 bits in 16 bits, signed, big endian

U16le

16 bits in 16 bits, unsigned, little endian

U16be

16 bits in 16 bits, unsigned, big endian

S2432le

24 bits in 32 bits, signed, little endian

S2432be

24 bits in 32 bits, signed, big endian

U2432le

24 bits in 32 bits, unsigned, little endian

U2432be

24 bits in 32 bits, unsigned, big endian

S32le

32 bits in 32 bits, signed, little endian

S32be

32 bits in 32 bits, signed, big endian

U32le

32 bits in 32 bits, unsigned, little endian

U32be

32 bits in 32 bits, unsigned, big endian

S24le

24 bits in 24 bits, signed, little endian

S24be

24 bits in 24 bits, signed, big endian

U24le

24 bits in 24 bits, unsigned, little endian

U24be

24 bits in 24 bits, unsigned, big endian

S20le

20 bits in 24 bits, signed, little endian

S20be

20 bits in 24 bits, signed, big endian

U20le

20 bits in 24 bits, unsigned, little endian

U20be

20 bits in 24 bits, unsigned, big endian

S18le

18 bits in 24 bits, signed, little endian

S18be

18 bits in 24 bits, signed, big endian

U18le

18 bits in 24 bits, unsigned, little endian

U18be

18 bits in 24 bits, unsigned, big endian

F32le

32-bit floating point samples, little endian

F32be

32-bit floating point samples, big endian

F64le

64-bit floating point samples, little endian

F64be

64-bit floating point samples, big endian

Implementations

impl AudioFormat

pub fn from_string(format: &str) -> AudioFormat

impl AudioFormat

pub fn build_integer(
    sign: bool,
    endianness: AudioEndianness,
    width: i32,
    depth: i32
) -> Self

pub fn to_str<'a>(self) -> &'a str

pub fn iter_raw() -> AudioFormatIterator

Trait Implementations

impl Clone for AudioFormat

fn clone(&self) -> AudioFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioFormat

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

Formats the value using the given formatter.

impl Display for AudioFormat

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

Formats the value using the given formatter.

impl From<AudioFormat> for AudioFormatInfo

fn from(f: AudioFormat) -> Self

Performs the conversion.

impl FromStr for AudioFormat

type Err = BoolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'a> FromValue<'a> for AudioFormat

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 AudioFormat

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 AudioFormat

fn cmp(&self, other: &Self) -> 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<AudioFormat> for AudioFormat

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

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

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

This method tests for !=.

impl PartialOrd<AudioFormat> for AudioFormat

fn partial_cmp(&self, other: &Self) -> 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 AudioFormat

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for AudioFormat

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 AudioFormat

type Type = Self

Type to get the Type from.

impl Copy for AudioFormat

impl Eq for AudioFormat

impl StructuralEq for AudioFormat

impl StructuralPartialEq for AudioFormat