Struct Spec

#[repr(C)]
pub struct Spec {
    pub format: Format,
    pub rate: u32,
    pub channels: u8,
}

A sample format and attribute specification.

Fields

format: Format

The sample format.

rate: u32

The sample rate. (e.g. 44100).

channels: u8

Audio channels. (1 for mono, 2 for stereo, …).

Implementations

impl Spec

pub const CHANNELS_MAX: u8 = 32u8

Maximum number of allowed channels.

pub const RATE_MAX: u32 = 768_000u32

Maximum allowed sample rate.

pub fn init(&mut self)

Initializes the specified sample spec.

The sample spec will have a defined state but is_valid() will fail for it.

pub fn is_valid(&self) -> bool

Checks if the whole sample type specification is valid.

pub fn format_is_valid(&self) -> bool

Checks only if the format attribute is valid.

Or in other words that the client library running on the end user system accepts it.

pub fn rate_is_valid(&self) -> bool

Checks only if the rate is within the supported range.

pub fn channels_are_valid(&self) -> bool

Checks only if the channel count is within the supported range.

pub fn bytes_per_second(&self) -> usize

Gets the amount of bytes that constitute playback of one second of audio, with the specified sample type.

pub fn frame_size(&self) -> usize

Gets the size of a frame.

pub fn sample_size(&self) -> usize

Gets the size of a sample.

pub fn bytes_to_usec(&self, length: u64) -> MicroSeconds

Calculates the time it would take to play a buffer of the specified size.

The return value will always be rounded down for non-integral return values.

Note, the underlying calculation may overflow for very large values.

pub fn usec_to_bytes(&self, t: MicroSeconds) -> usize

Calculates the size of a buffer required, for playback duration of the time specified.

The return value will always be rounded down for non-integral return values.

Note, the underlying calculation may overflow for very large values.

pub fn print(&self) -> String

Pretty prints a sample type specification to a string.

Trait Implementations

impl AsMut<pa_sample_spec> for Spec

fn as_mut(&mut self) -> &mut pa_sample_spec

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Spec> for pa_sample_spec

fn as_ref(&self) -> &Spec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<pa_sample_spec> for Spec

fn as_ref(&self) -> &pa_sample_spec

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Spec

fn clone(&self) -> Spec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spec

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

Formats the value using the given formatter.

impl From<pa_sample_spec> for Spec

fn from(s: pa_sample_spec) -> Self

Converts to this type from the input type.

impl PartialEq for Spec

fn eq(&self, other: &Self) -> 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 Copy for Spec

impl Eq for Spec