Struct InputChannels 

pub struct InputChannels<'a, S> { /* private fields */ }

An InputPort’s channels’ data buffers, which contains samples of a given type S.

The sample type S is always going to be either f32 or f64, as returned by InputPort::channels.

Implementations

impl<'a, S> InputChannels<'a, S>

pub fn frames_count(&self) -> u32

Returns the number of frames to process in this block.

This will always match the number of samples of every audio channel buffer.

pub fn raw_data(&self) -> &'a [*mut S]

Returns the raw pointer data, as provided by the host.

In CLAP’s API, hosts provide a port’s audio data as an array of raw pointers, each of which points to the start of a sample array of type S and of frames_count length.

pub fn channel_count(&self) -> u32

The number of channels.

pub fn channel(&self, channel_index: u32) -> Option<&'a [S]>

Retrieves the sample buffer of the channel at a given index.

If there is no channel at the given index (i.e. channel_index is greater or equal than channel_count), this returns None.

pub fn iter(&self) -> InputChannelsIter<'a, S>

Gets an iterator over all the port’s channels’ sample buffers.

Trait Implementations

impl<'a, S: Clone> Clone for InputChannels<'a, S>

fn clone(&self) -> InputChannels<'a, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, S: Copy> Copy for InputChannels<'a, S>

impl<'a, T> IntoIterator for InputChannels<'a, T>

type Item = &'a [T]

The type of the elements being iterated over.

type IntoIter = InputChannelsIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a InputChannels<'a, T>

type Item = &'a [T]

The type of the elements being iterated over.

type IntoIter = InputChannelsIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.