Trait audio_core::Frame

pub trait Frame {
    type Sample: Copy;
    type Frame<'this>: Frame<Sample = Self::Sample>
       where Self: 'this;
    type Iter<'this>: Iterator<Item = Self::Sample>
       where Self: 'this;

    // Required methods
    fn as_frame(&self) -> Self::Frame<'_>;
    fn len(&self) -> usize;
    fn get(&self, channel: usize) -> Option<Self::Sample>;
    fn iter(&self) -> Self::Iter<'_>;

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

The buffer of a single frame.

Required Associated Types

type Sample: Copy

The sample of a channel.

type Frame<'this>: Frame<Sample = Self::Sample> where Self: 'this

The type the frame assumes when coerced into a reference.

type Iter<'this>: Iterator<Item = Self::Sample> where Self: 'this

A borrowing iterator over the channel.

Required Methods

fn as_frame(&self) -> Self::Frame<'_>

Reborrow the current frame as a reference.

fn len(&self) -> usize

Get the length which indicates number of samples in the current frame.

fn get(&self, channel: usize) -> Option<Self::Sample>

Get the sample at the given channel in the frame.

fn iter(&self) -> Self::Iter<'_>

Construct an iterator over the frame.

Provided Methods

fn is_empty(&self) -> bool

Test if the current frame is empty.

Object Safety

This trait is not object safe.

Implementors