Enum Format 

#[non_exhaustive]
#[repr(i32)]
pub enum Format {
    Unknown = -1,
    S8 = 0,
    U8 = 1,
    S16LE = 2,
    S16BE = 3,
    U16LE = 4,
    U16BE = 5,
    S24LE = 6,
    S24BE = 7,
    U24LE = 8,
    U24BE = 9,
    S32LE = 10,
    S32BE = 11,
    U32LE = 12,
    U32BE = 13,
    FloatLE = 14,
    FloatBE = 15,
    Float64LE = 16,
    Float64BE = 17,
    IEC958SubframeLE = 18,
    IEC958SubframeBE = 19,
    MuLaw = 20,
    ALaw = 21,
    ImaAdPCM = 22,
    MPEG = 23,
    GSM = 24,
    Special = 31,
    S243LE = 32,
    S243BE = 33,
    U243LE = 34,
    U243BE = 35,
    S203LE = 36,
    S203BE = 37,
    U203LE = 38,
    U203BE = 39,
    S183LE = 40,
    S183BE = 41,
    U183LE = 42,
    U183BE = 43,
    G72324 = 44,
    G723241B = 45,
    G72340 = 46,
    G723401B = 47,
    DSDU8 = 48,
    DSDU16LE = 49,
    DSDU32LE = 50,
    DSDU16BE = 51,
    DSDU32BE = 52,
}

Available on crate feature alsa only.

Defines the supported format of a stream.

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

S8 = 0

U8 = 1

S16LE = 2

S16BE = 3

U16LE = 4

U16BE = 5

S24LE = 6

S24BE = 7

U24LE = 8

U24BE = 9

S32LE = 10

S32BE = 11

U32LE = 12

U32BE = 13

FloatLE = 14

FloatBE = 15

Float64LE = 16

Float64BE = 17

IEC958SubframeLE = 18

IEC958SubframeBE = 19

MuLaw = 20

ALaw = 21

ImaAdPCM = 22

MPEG = 23

GSM = 24

Special = 31

S243LE = 32

S243BE = 33

U243LE = 34

U243BE = 35

S203LE = 36

S203BE = 37

U203LE = 38

U203BE = 39

S183LE = 40

S183BE = 41

U183LE = 42

U183BE = 43

G72324 = 44

G723241B = 45

G72340 = 46

G723401B = 47

DSDU8 = 48

DSDU16LE = 49

DSDU32LE = 50

DSDU16BE = 51

DSDU32BE = 52

Implementations

impl Format

pub fn from_value(value: i32) -> Option<Self>

Parse the given enum from a value.

impl Format

pub fn physical_width(self) -> Result<usize>

Return bits needed to store a PCM sample.

Examples

use audio_device::alsa;

assert_eq!(alsa::Format::U8.physical_width()?, 8);
assert_eq!(alsa::Format::S16LE.physical_width()?, 16);
assert_eq!(alsa::Format::S243LE.physical_width()?, 24);

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl Display for Format

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

Formats the value using the given formatter.

impl Hash for Format

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 Format

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Format

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Format

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Format

impl Eq for Format

impl StructuralPartialEq for Format