Trait Effect

pub trait Effect: Processor {
    // Required methods
    fn handle_parameters<P: States>(&mut self, parameters: P);
    fn process<P: BufferStates, I: Buffer, O: BufferMut>(
        &mut self,
        parameters: P,
        input: &I,
        output: &mut O,
    );
}

A trait for audio effects

An effect is a processor that processes audio, and has both an input and an output audio stream. It will receive information about the current state of the parameters specified by the crate::Component that created it.

Required Methods

fn handle_parameters<P: States>(&mut self, parameters: P)

Handle parameter changes without processing any audio data.

Must not allocate or block.

fn process<P: BufferStates, I: Buffer, O: BufferMut>( &mut self, parameters: P, input: &I, output: &mut O, )

Actually process audio data.

Must not allocate or block.

input and output will be the same length.

output will be received in an undetermined state and must be filled with audio by the processor during this call.

In addition to recieving the audio, this function also receives information about the state of the parameters throughout the buffer being processed.

In order to consume the parameters, you can use the crate::pzip macro to convert the parameters into an iterator of tuples that represent the state of the parameters at each sample.

The sample rate of the audio was provided in environment.sampling_rate in the call to crate::Component::create_processor.

Note that it’s guaranteed that output will be no longer than environment.max_samples_per_process_call provided in the call to crate::Component::create_processor.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors