Enum PushStatus

pub enum PushStatus {
    Ok,
    OutputNotReady,
    OverflowOccurred {
        num_frames_pushed: usize,
    },
    UnderflowCorrected {
        num_zero_frames_pushed: usize,
    },
}

The status of pushing samples to ResamplingProd::push and ResamplingProd::push_interleaved.

Variants

Ok

All samples were successfully pushed to the channel.

OutputNotReady

The output stream is not yet ready to read samples from the channel.

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

No samples were pushed to the channel.

OverflowOccurred

An overflow occured due to the input stream running faster than the output stream. Some or all of the samples were not pushed to the channel.

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

Fields

num_frames_pushed: usize

The number of frames (samples in a single channel of audio) that were successfully pushed to the channel.

UnderflowCorrected

An underflow occured due to the output stream running faster than the input stream.

All of the samples were successfully pushed to the channel, however extra zero samples were also pushed to the channel to correct for the jitter.

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

Fields

num_zero_frames_pushed: usize

The number of zero frames that were pushed after the other samples were pushed.

Trait Implementations

impl Clone for PushStatus

fn clone(&self) -> PushStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PushStatus

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

Formats the value using the given formatter.

impl PartialEq for PushStatus

fn eq(&self, other: &PushStatus) -> 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 PushStatus

impl Eq for PushStatus

impl StructuralPartialEq for PushStatus