Struct OutputChannels 

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

An OutputPort’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 OutputPort::channels.

Implementations

impl<S> OutputChannels<'_, 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) -> &[*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<&[S]>

Retrieves the sample buffer of the channel at a given index, as a read-only slice.

pub fn channel_mut(&mut self, channel_index: u32) -> Option<&mut [S]>

Retrieves the sample buffer of the channel at a given index, as a mutable slice.

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

Gets a read-only iterator over all the port’s channels’ sample buffers.

pub fn iter_mut(&mut self) -> OutputChannelsIter<'_, S>

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

pub fn split_at_mut( &mut self, mid: u32, ) -> (OutputChannels<'_, S>, OutputChannels<'_, S>)

Divides the output channels into two at an index.

The first will contain all channels with indices from [0, mid) (excluding the index mid itself) and the second will contain all channels with indices from [mid, channel_count).

Unlike slice::split_at_mut, this method does not panic if mid is larger than channel_count. The second OutputChannels will only be empty in this case.

Trait Implementations

impl<'a, T> IntoIterator for &'a OutputChannels<'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 mut OutputChannels<'a, T>

type Item = &'a mut [T]

The type of the elements being iterated over.

type IntoIter = OutputChannelsIter<'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 OutputChannels<'a, T>

type Item = &'a mut [T]

The type of the elements being iterated over.

type IntoIter = OutputChannelsIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.