Struct songbird::input::Input

pub struct Input {
    pub metadata: Box<Metadata>,
    pub stereo: bool,
    pub reader: Reader,
    pub kind: Codec,
    pub container: Container,
    // some fields omitted
}

Data and metadata needed to correctly parse a Reader’s audio bytestream.

See the module root for more information.

Fields

metadata: Box<Metadata>

Information about the played source.

stereo: bool

Indicates whether source is stereo or mono.

reader: Reader

Underlying audio data bytestream.

kind: Codec

Decoder used to parse the output of reader.

container: Container

Framing strategy needed to identify frames of compressed audio.

Implementations

impl Input

pub fn float_pcm(is_stereo: bool, reader: Reader) -> Input

Creates a floating-point PCM Input from a given reader.

pub fn new(
    stereo: bool,
    reader: Reader,
    kind: Codec,
    container: Container,
    metadata: Option<Metadata>
) -> Self

Creates a new Input using (at least) the given reader, codec, and container.

pub fn is_seekable(&self) -> bool

Returns whether the inner Reader implements Seek.

pub fn is_stereo(&self) -> bool

Returns whether the read audio signal is stereo (or mono).

pub fn get_type(&self) -> CodecType

Returns the type of the inner Codec.

pub fn mix(&mut self, float_buffer: &mut [f32; 1920], volume: f32) -> usize

Mixes the output of this stream into a 20ms stereo audio buffer.

pub fn seek_time(&mut self, time: Duration) -> Option<Duration>

Seeks the stream to the given time, if possible.

Returns the actual time reached.

Trait Implementations

impl Debug for Input

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Compressed> for Input

fn from(src: Compressed) -> Self

Performs the conversion.

impl From<Restartable> for Input

fn from(src: Restartable) -> Self

Performs the conversion.

impl Read for Input

fn read(&mut self, buffer: &mut [u8]) -> IoResult<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

pub unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

pub fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

pub fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

pub fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Seek for Input

fn seek(&mut self, pos: SeekFrom) -> IoResult<u64>

Seek to an offset, in bytes, in a stream.

pub fn stream_len(&mut self) -> Result<u64, Error>

🔬 This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

pub fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

impl TryFrom<Memory> for Input

type Error = Error

The type returned in the event of a conversion error.

fn try_from(src: Memory) -> Result<Self>

Performs the conversion.