Struct AuxInput 

pub struct AuxInput<'a, S: Sample = f32> { /* private fields */ }

Immutable view of an auxiliary input bus.

Provides access to input channels for a single auxiliary bus (typically sidechain). Created via AuxiliaryBuffers::sidechain() or AuxiliaryBuffers::input().

Type Parameter

S is the sample type, defaulting to f32.

Example

if let Some(sidechain) = aux.sidechain() {
    // Calculate RMS of sidechain for keying
    let rms = sidechain.rms(0);

    // Or iterate over all channels
    for ch in sidechain.iter_channels() {
        // Process channel...
    }
}

Implementations

impl<'a, S: Sample> AuxInput<'a, S>

pub fn num_samples(&self) -> usize

Number of samples in each channel.

pub fn num_channels(&self) -> usize

Number of channels in this bus.

pub fn channel(&self, index: usize) -> &[S]

Get a channel by index.

Returns an empty slice if the channel doesn’t exist.

pub fn iter_channels(&self) -> impl Iterator<Item = &[S]> + '_

Iterate over all channel slices.

pub fn rms(&self, channel: usize) -> S

Calculate the RMS (root mean square) level of a channel.

Returns zero if the channel doesn’t exist or is empty.

pub fn peak(&self, channel: usize) -> S

Calculate the peak level of a channel.

Returns zero if the channel doesn’t exist or is empty.

pub fn average(&self, channel: usize) -> S

Calculate the average absolute level of a channel.

Returns zero if the channel doesn’t exist or is empty.