Struct AuxOutput 

pub struct AuxOutput<'borrow, 'data, S: Sample = f32> { /* private fields */ }

Mutable view of an auxiliary output bus.

Provides access to output channels for a single auxiliary bus (e.g., aux sends, multi-out). Created via AuxiliaryBuffers::output().

Type Parameter

S is the sample type, defaulting to f32.

Lifetime Parameters

• 'borrow - The borrow lifetime (from &mut self on AuxiliaryBuffers)
• 'data - The underlying audio data lifetime

This separation is required because &'a mut [&'a mut T] is invariant in Rust, which prevents returning borrowed data from methods.

Example

if let Some(mut aux_out) = aux.output(0) {
    // Write to aux output
    for sample in aux_out.channel(0) {
        *sample = processed_signal;
    }
}

Implementations

impl<'borrow, 'data, S: Sample> AuxOutput<'borrow, 'data, 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(&mut self, index: usize) -> &mut [S]

Get a mutable channel by index.

Panics

Panics if the channel index is out of bounds.

pub fn channel_checked(&mut self, index: usize) -> Option<&mut [S]>

Try to get a mutable channel by index.

Returns None if the channel doesn’t exist.

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

Iterate over all channel slices mutably.

pub fn clear(&mut self)

Clear all channels to silence.

pub fn fill(&mut self, value: S)

Fill all channels with a constant value.