Struct VorbisSource 

pub struct VorbisSource<B: AsRef<[u8]>> { /* private fields */ }

An Ogg Vorbis file’s samples, decoded from its bytes as they are asked for. It borrows them or owns them, as B does: a worker that outlives its caller holds an Arc<[u8]>.

Implementations

impl<B: AsRef<[u8]>> VorbisSource<B>

pub fn new(bytes: B, limits: &Limits) -> Result<Self, Error>

A source of bytes, whose headers say what it holds, which must be within limits. It decodes no audio yet.

pub fn comments(&self) -> &[(String, String)]

The file’s comments, as it has them, each a name and its value.

pub fn comment(&self, name: &str) -> Option<&str>

The first comment called name, whatever its case, as Vorbis says names are compared.

pub fn vendor(&self) -> &str

The name of what encoded the file.

pub fn end_granule(&self) -> Option<u64>

What the file’s last page says is its end, in frames from the start of the sound, if it has such a page. Nothing has checked it yet.

pub fn position(&self) -> Option<u64>

Where the next frame read is, in frames from the start of the sound. After a seek it isn’t known until the end of a page has been decoded.

pub fn seek_page(&mut self, frame: u64) -> Result<(), Error>

Moves to the first page that ends at or past frame, or to the file’s end if none does, dropping what was decoded of the last packet. The module’s documentation says how to get from there to a sample. What it has decoded still counts against the limit.

Trait Implementations

impl<B: AsRef<[u8]>> Source for VorbisSource<B>

fn total_frames(&self) -> Option<u64>

Not known without decoding: the last page says, and a file can lie.

fn format(&self) -> PcmFormat

The rate and channels of what it yields.

fn read(&mut self, out: &mut [i16]) -> Result<usize, Error>

Fills out with the next whole frames, interleaved, and says how many frames that was. 0 means it has ended. Short of the end it gives at least one, and a buffer without room for one is Error::NoRoom.

fn rewind_to(&mut self, frame: u64) -> Result<(), Error>

Goes back, so that the next read gives frame frame, without waiting: what a mix asks at a loop’s join. A source that can’t says Error::NoRewind, as this does unless it is written otherwise.