Struct Spec

pub struct Spec {
    pub channels: u16,
    pub channel_mask: u32,
    pub sample_rate: u32,
    pub bits_per_sample: u16,
    pub sample_format: SampleFormat,
}

• The spec info for a generic audio file.

Fields

channels: u16

• Num channels

channel_mask: u32

• The channel mask indicates the position of the speakers.

sample_rate: u32

• The sample rate. How many audio frames are to be played in a second.

bits_per_sample: u16

• For PCM, this indicates how many bits is for a sample.

sample_format: SampleFormat

• The roughly described sample format

Implementations

impl Spec

pub fn new() -> Self

pub fn get_sample_type(&self) -> WaveSampleType

• Get the concrete sample type

pub fn guess_channel_mask(&self) -> Result<u32, AudioError>

• Guess the channel mask

pub fn channel_mask_to_speaker_positions(&self) -> Vec<u32>

• Break down a channel mask to the speaker positions.

pub fn channel_mask_to_speaker_positions_descs(&self) -> Vec<&'static str>

• Break down a channel mask to the speaker position description strings.

pub fn verify_for_pcm(&self) -> Result<(), AudioError>

• Check if this spec is good for encoding PCM format.

pub fn is_channel_mask_valid(&self) -> bool

• Check if the channel mask matches the channel number.

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a copy 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 Default for Spec

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Spec