Trait fon::Sink

pub trait Sink<Chan: Channel, const CH: usize>: Debug {
    fn sample_rate(&self) -> NonZeroU32;
    fn len(&self) -> usize;
    fn sink_with(&mut self, iter: &mut dyn Iterator<Item = Frame<Chan, CH>>);

    fn is_empty(&self) -> bool { ... }
}

Audio sink - a type that consumes audio samples.

Required methods

fn sample_rate(&self) -> NonZeroU32

Get the sample rate of the sink in hertz.

fn len(&self) -> usize

Get the length of the sink in frames.

Sinks must always have finite length.

fn sink_with(&mut self, iter: &mut dyn Iterator<Item = Frame<Chan, CH>>)

Sink audio samples from a frame iterator.

Warning: if used incorrectly, this method may introduce audio aliasing. To avoid that, make sure the sample rate of the frames from the iterator matches exactly the sample rate of the sink.

Provided methods

fn is_empty(&self) -> bool

Check if the sink is empty (length of zero).

Implementors

impl<'a, Chan: Channel, const CH: usize> Sink<Chan, CH> for AudioSink<'a, Chan, CH>

impl<Chan, C, S, const CH: usize, const N: usize> Sink<C, N> for &mut SinkTo<Chan, C, S, CH, N> where
    Chan: Channel + From<C>,
    C: Channel,
    S: Sink<Chan, CH>, 

impl<Chan, C, S, const CH: usize, const N: usize> Sink<C, N> for SinkTo<Chan, C, S, CH, N> where
    Chan: Channel + From<C>,
    C: Channel,
    S: Sink<Chan, CH>, 

impl<Chan: Channel, const CH: usize> Sink<Chan, CH> for &mut AudioSink<'_, Chan, CH>