Enum audrey::read::Reader

pub enum Reader<R> where
    R: Read + Seek,  {
    Flac(FlacReader<R>),
    OggVorbis(OggStreamReader<R>),
    Wav(WavReader<R>),
    CafAlac(AlacReader<R>),
}

Returned by the read function, enumerates the various supported readers.

Variants

Flac(FlacReader<R>)OggVorbis(OggStreamReader<R>)Wav(WavReader<R>)CafAlac(AlacReader<R>)

Methods

impl<R> Reader<R> where
    R: Read + Seek, 

fn new(reader: R) -> Result<Self, ReadError>

Attempts to read the format of the audio read by the given reader and returns the associated Reader variant.

The format is determined by attempting to construct each specific format reader until one is successful.

fn format(&self) -> Format

The format from which the audio will be read.

fn description(&self) -> Description

A basic description of the audio being read.

fn samples<S>(&mut self) -> Samples<R, S> where
    S: Sample, 

Produce an iterator that reads samples from the underlying reader, converts them to the sample type S if not already in that format and yields them.

When reading from multiple channels, samples are interleaved.

fn frames<F>(&mut self) -> Frames<R, F> where
    F: Frame,
    F::Sample: Sample, 

Produce an iterator that yields read frames from the underlying Reader.

This method currently expects that the frame type F has the same number of channels as stored in the underlying audio format.

TODO: Should consider changing this behaviour to check the audio file's actual number of channels and automatically convert to F's number of channels while reading.