Enum ReadStatus

pub enum ReadStatus {
    Ok,
    InputNotReady,
    UnderflowOccurred {
        num_frames_read: usize,
    },
    OverflowCorrected {
        num_frames_discarded: usize,
    },
}

The status of reading data from ResamplingCons::read and ResamplingCons::read_interleaved.

Variants

Ok

The output buffer was fully filled with samples from the channel.

InputNotReady

The input stream is not yet ready to push samples to the channel.

Note, this can also happen when the channel is reset.

The output buffer was filled with zeros.

UnderflowOccurred

An underflow occured due to the output stream running faster than the input stream. Some or all of the samples in the output buffer have been filled with zeros on the end. This may result in audible audio glitches.

If this occurs, then it may mean that ResamplingChannelConfig::latency_seconds is too low and should be increased.

Fields

num_frames_read: usize

The number of frames (samples in a single channel of audio) that were successfully read from the channel. All frames past this have been filled with zeros.

OverflowCorrected

An overflow occured due to the input stream running faster than the output stream

All of the samples in the output buffer were successfully filled with samples, however a number of frames have also been discarded to correct for the jitter.

If this occurs, then it may mean that ResamplingChannelConfig::capacity_seconds is too low and should be increased.

Fields

num_frames_discarded: usize

The number of frames that were discarded from the channel (after the frames have been read into the output buffer).

Trait Implementations

impl Clone for ReadStatus

fn clone(&self) -> ReadStatus

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReadStatus

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

Formats the value using the given formatter.

impl PartialEq for ReadStatus

fn eq(&self, other: &ReadStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ReadStatus

impl Eq for ReadStatus

impl StructuralPartialEq for ReadStatus