Enum awedio::NextSample

pub enum NextSample {
    Sample(i16),
    MetadataChanged,
    Paused,
    Finished,
}

The result of Sound::next_sample

Variants

Sample(i16)

A sample for one channel. Channels are interleaved. The first sample is for the first channel and so forth and repeats (e.g. L-R-L-R-L-R).

MetadataChanged

The number of channels or the sample rate has changed. Continue to retrieve samples afterward. The next sample will always be for the first track regardless of what track was next

Paused

No more samples for now. More might come later. It is expected that the Sound will not be pulled again during this batch of samples.

Finished

All samples have been retrieved and no more will come.

Trait Implementations

impl Clone for NextSample

fn clone(&self) -> NextSample

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NextSample

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

Formats the value using the given formatter.

impl Ord for NextSample

fn cmp(&self, other: &NextSample) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for NextSample

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for NextSample

fn partial_cmp(&self, other: &NextSample) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for NextSample

impl Eq for NextSample

impl StructuralEq for NextSample

impl StructuralPartialEq for NextSample