Struct ao::SampleFormat [-] [+] [src]

pub struct SampleFormat<T, S> {
    pub sample_rate: usize,
    pub channels: usize,
    pub byte_order: Endianness,
    pub matrix: Option<S>,
    // some fields omitted
}

Describes audio sample formats.

Used to specify the format with which data will be fed to a Device.

Fields

sample_rate

Samples per second (per channel)

channels

Number of channels

byte_order

Byte order of samples.

matrix

Maps input channels to output locations in a comma-separated list.

For example, "L,R" specifies channel 0 as left and 1 as right, or "L,R,C,LFE,BR,BL" for a 5.1 FLAC file.

Refer to the matrix documentation for additional information and examples.

Methods

impl<T: Sample, S: AsRef<str>> SampleFormat<T, S>

fn new(sample_rate: usize, channels: usize, byte_order: Endianness, matrix: Option<S>) -> SampleFormat<T, S>

Construct a sample format specification.