Struct ChorusEffect 

pub struct ChorusEffect { /* private fields */ }

Stereo chorus effect with an filtered, interpolated delay-line.

Implementations

impl ChorusEffect

pub const EFFECT_NAME: &str = "Chorus"

pub const RATE: FloatParameter

pub const PHASE: FloatParameter

pub const DEPTH: FloatParameter

pub const FEEDBACK: FloatParameter

pub const DELAY: FloatParameter

pub const WET_MIX: FloatParameter

pub const FILTER_TYPE: EnumParameter

pub const FILTER_FREQ: FloatParameter

pub const FILTER_RESONANCE: FloatParameter

pub fn new() -> Self

Creates a new ChorusEffect with default parameter values.

pub fn with_parameters( rate: f32, phase: f32, depth: f32, feedback: f32, delay: f32, wet_mix: f32, filter_type: ChorusEffectFilterType, filter_freq: f32, filter_resonance: f32, ) -> Self

Creates a new ChorusEffect with the given parameters.

Trait Implementations

impl Default for ChorusEffect

fn default() -> Self

Returns the “default value” for a type.

impl Effect for ChorusEffect

fn name(&self) -> &'static str

A unique, static name for the effect.

fn weight(&self) -> usize

Return a rough estimate of the processing costs for this effect in range ~1..10, where 1 means pretty lightweight and 10 very CPU intensive. This is used in parallel processing to distribute work loads evenly before or without actual CPU measurements.

fn parameters(&self) -> Vec<&dyn Parameter>

Returns a list of parameter descriptors for this effect.

fn initialize( &mut self, sample_rate: u32, channel_count: usize, _max_frames: usize, ) -> Result<(), Error>

Initializes the effect with the audio output’s properties.

fn process(&mut self, output: &mut [f32], _time: &EffectTime)

Processes an audio buffer in-place, applying the effect.

fn process_tail(&self) -> Option<usize>

Returns the number of audible sample frames this effect will produce, after it received silence.

fn process_message( &mut self, message: &EffectMessagePayload, ) -> Result<(), Error>

Handles optional effect-specific messages in the real-time thread. This can be used to pass payloads to the effects, which can or should not be expressed as a trivial parameter change.

fn process_parameter_update( &mut self, id: FourCC, value: &ParameterValueUpdate, ) -> Result<(), Error>

Handles a parameter update in the real-time thread.

fn into_box(self) -> Box<dyn Effect>

where Self: Sized,

Convert the Effect impl into a boxed dyn Effect.

fn process_started(&mut self)

Called in the real-time thread before audio processing starts.

fn process_stopped(&mut self)

Called in the real-time thread after processing stopped.

fn process_parameter_updates( &mut self, values: &[(FourCC, ParameterValueUpdate)], ) -> Result<(), Error>

Handles multiple parameter updates in a batch in the real-time thread.