Struct claxon::frame::FrameReader
[−]
[src]
pub struct FrameReader<R: ReadBytes> { /* fields omitted */ }
Reads frames from a stream and exposes decoded blocks as an iterator.
TODO: for now, it is assumes that the reader starts at a frame header; no searching for a sync code is performed at the moment.
Methods
impl<R: ReadBytes> FrameReader<R>
[src]
fn new(input: R) -> FrameReader<R>
Creates a new frame reader that will yield at least one element.
fn read_next_or_eof(&mut self, buffer: Vec<i32>) -> FrameResult
Decodes the next frame or returns an error if the data was invalid.
The buffer is moved into the returned block, so that the same buffer may
be reused to decode multiple blocks, avoiding a heap allocation every
time. It can be retrieved again with block.into_buffer()
. If the
buffer is not large enough to hold all samples, a larger buffer is
allocated automatically.
TODO: I should really be consistent with 'read' and 'decode'.