Enum libpulse_binding::sample::Format
source · #[repr(C)]pub enum Format {
Show 14 variants
U8,
ALaw,
ULaw,
S16le,
S16be,
F32le,
F32be,
S32le,
S32be,
S24le,
S24be,
S24_32le,
S24_32be,
Invalid,
}
Expand description
Sample format.
Note, native-endian (endian-independent) associated constants are available on this type which should be preferred over direct use of the endian-specific variants, for improved flexibility and avoidance of mistakes.
Variants§
U8
Unsigned 8 Bit PCM.
ALaw
8 Bit a-Law.
ULaw
8 Bit mu-Law.
S16le
Signed 16 Bit PCM, little endian (PC).
S16be
Signed 16 Bit PCM, big endian.
F32le
32 Bit IEEE floating point, little endian (PC), range -1.0 to 1.0.
F32be
32 Bit IEEE floating point, big endian, range -1.0 to 1.0.
S32le
Signed 32 Bit PCM, little endian (PC).
S32be
Signed 32 Bit PCM, big endian.
S24le
Signed 24 Bit PCM packed, little endian (PC).
S24be
Signed 24 Bit PCM packed, big endian.
S24_32le
Signed 24 Bit PCM in LSB of 32 Bit words, little endian (PC).
S24_32be
Signed 24 Bit PCM in LSB of 32 Bit words, big endian.
Invalid
An invalid value.
Implementations§
source§impl Format
impl Format
sourcepub const FLOAT32NE: Self = self::ei_formats::SAMPLE_FLOAT32NE
pub const FLOAT32NE: Self = self::ei_formats::SAMPLE_FLOAT32NE
32-bit IEEE floating point, native endian.
sourcepub const S24NE: Self = self::ei_formats::SAMPLE_S24NE
pub const S24NE: Self = self::ei_formats::SAMPLE_S24NE
Signed 24-bit PCM packed, native endian.
sourcepub const S24_32NE: Self = self::ei_formats::SAMPLE_S24_32NE
pub const S24_32NE: Self = self::ei_formats::SAMPLE_S24_32NE
Signed 24-bit PCM in LSB of 32-bit words, native endian.
sourcepub const FLOAT32RE: Self = self::ei_formats::SAMPLE_FLOAT32RE
pub const FLOAT32RE: Self = self::ei_formats::SAMPLE_FLOAT32RE
32-bit IEEE floating point, reverse endian.
sourcepub const S24RE: Self = self::ei_formats::SAMPLE_S24RE
pub const S24RE: Self = self::ei_formats::SAMPLE_S24RE
Signed 24-bit PCM, packed reverse endian.
sourcepub const S24_32RE: Self = self::ei_formats::SAMPLE_S24_32RE
pub const S24_32RE: Self = self::ei_formats::SAMPLE_S24_32RE
Signed 24-bit PCM, in LSB of 32-bit words, reverse endian.
sourcepub fn size(&self) -> usize
pub fn size(&self) -> usize
Similar to Spec::sample_size()
but take a sample format instead of full sample spec.
sourcepub fn to_string(&self) -> Option<Cow<'static, str>>
pub fn to_string(&self) -> Option<Cow<'static, str>>
Gets a descriptive string for the specified sample format.
sourcepub fn parse(format: &str) -> Self
pub fn parse(format: &str) -> Self
Parses a sample format text. Inverse of to_string()
.
sourcepub fn is_le(&self) -> Option<bool>
pub fn is_le(&self) -> Option<bool>
Checks if format is little endian.
Returns true
when the specified format is little endian, false
if big endian. Returns
None
when endianness does not apply to this format, or if unknown.
sourcepub fn is_be(&self) -> Option<bool>
pub fn is_be(&self) -> Option<bool>
Checks if format is big endian.
Returns true
when the specified format is big endian, false
if little endian. Returns
None
when endianness does not apply to this format, or if unknown.
Trait Implementations§
source§impl From<Format> for pa_sample_format_t
impl From<Format> for pa_sample_format_t
source§impl From<pa_sample_format_t> for Format
impl From<pa_sample_format_t> for Format
source§fn from(f: pa_sample_format_t) -> Self
fn from(f: pa_sample_format_t) -> Self
source§impl FromPrimitive for Format
impl FromPrimitive for Format
source§fn from_i64(n: i64) -> Option<Self>
fn from_i64(n: i64) -> Option<Self>
i64
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned.source§fn from_u64(n: u64) -> Option<Self>
fn from_u64(n: u64) -> Option<Self>
u64
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned.source§fn from_isize(n: isize) -> Option<Self>
fn from_isize(n: isize) -> Option<Self>
isize
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned.source§fn from_i8(n: i8) -> Option<Self>
fn from_i8(n: i8) -> Option<Self>
i8
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned.source§fn from_i16(n: i16) -> Option<Self>
fn from_i16(n: i16) -> Option<Self>
i16
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned.source§fn from_i32(n: i32) -> Option<Self>
fn from_i32(n: i32) -> Option<Self>
i32
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned.source§fn from_i128(n: i128) -> Option<Self>
fn from_i128(n: i128) -> Option<Self>
i128
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read moresource§fn from_usize(n: usize) -> Option<Self>
fn from_usize(n: usize) -> Option<Self>
usize
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned.source§fn from_u8(n: u8) -> Option<Self>
fn from_u8(n: u8) -> Option<Self>
u8
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned.source§fn from_u16(n: u16) -> Option<Self>
fn from_u16(n: u16) -> Option<Self>
u16
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned.source§fn from_u32(n: u32) -> Option<Self>
fn from_u32(n: u32) -> Option<Self>
u32
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned.source§fn from_u128(n: u128) -> Option<Self>
fn from_u128(n: u128) -> Option<Self>
u128
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read moresource§impl PartialEq<Format> for Format
impl PartialEq<Format> for Format
source§impl ToPrimitive for Format
impl ToPrimitive for Format
source§fn to_i64(&self) -> Option<i64>
fn to_i64(&self) -> Option<i64>
self
to an i64
. If the value cannot be
represented by an i64
, then None
is returned.source§fn to_u64(&self) -> Option<u64>
fn to_u64(&self) -> Option<u64>
self
to a u64
. If the value cannot be
represented by a u64
, then None
is returned.source§fn to_isize(&self) -> Option<isize>
fn to_isize(&self) -> Option<isize>
self
to an isize
. If the value cannot be
represented by an isize
, then None
is returned.source§fn to_i8(&self) -> Option<i8>
fn to_i8(&self) -> Option<i8>
self
to an i8
. If the value cannot be
represented by an i8
, then None
is returned.source§fn to_i16(&self) -> Option<i16>
fn to_i16(&self) -> Option<i16>
self
to an i16
. If the value cannot be
represented by an i16
, then None
is returned.source§fn to_i32(&self) -> Option<i32>
fn to_i32(&self) -> Option<i32>
self
to an i32
. If the value cannot be
represented by an i32
, then None
is returned.source§fn to_i128(&self) -> Option<i128>
fn to_i128(&self) -> Option<i128>
self
to an i128
. If the value cannot be
represented by an i128
(i64
under the default implementation), then
None
is returned. Read moresource§fn to_usize(&self) -> Option<usize>
fn to_usize(&self) -> Option<usize>
self
to a usize
. If the value cannot be
represented by a usize
, then None
is returned.source§fn to_u8(&self) -> Option<u8>
fn to_u8(&self) -> Option<u8>
self
to a u8
. If the value cannot be
represented by a u8
, then None
is returned.source§fn to_u16(&self) -> Option<u16>
fn to_u16(&self) -> Option<u16>
self
to a u16
. If the value cannot be
represented by a u16
, then None
is returned.source§fn to_u32(&self) -> Option<u32>
fn to_u32(&self) -> Option<u32>
self
to a u32
. If the value cannot be
represented by a u32
, then None
is returned.source§fn to_u128(&self) -> Option<u128>
fn to_u128(&self) -> Option<u128>
self
to a u128
. If the value cannot be
represented by a u128
(u64
under the default implementation), then
None
is returned. Read more