Struct AudioEffect 

pub struct AudioEffect<T: FloatType + Float> { /* private fields */ }

Shared pointer to an audio effect, using Arc for thread-safe access.

Trait Implementations

impl<T: FloatType + Float> AudioEffectImpl<T> for AudioEffect<T>

fn new<const N: usize>( name: &str, param_props: ParamPropDesk<'_, N>, processor: Box<dyn AudioEffectTrait<T>>, ) -> Self

Creates a new audio effect with the given name, parameter properties, and processor. The const generic N specifies the number of parameters.

fn use_filter_in(&mut self, use_filter: bool)

Enables or disables the input filter before processing.

fn use_filter_out(&mut self, use_filter: bool)

Enables or disables the output filter after processing.

fn is_using_filter_in(&self) -> bool

Checks if the input filter is enabled.

fn is_using_filter_out(&self) -> bool

Checks if the output filter is enabled.

fn get_name(&self) -> &str

Gets the name of the effect.

fn get_mix(&self) -> f32

Gets the current mix level.

fn set_mix(&mut self, mix: f32)

Sets the mix level (clamped between 0.0 and 1.0).

fn set_low_cut_in(&mut self, cut: f32)

Sets the low-cut frequency for the input filter (clamped between 10.0 and 22050.0 Hz).

fn get_low_cut_in(&self) -> f32

Gets the low-cut frequency for the input filter.

fn set_high_cut_in(&mut self, cut: f32)

Sets the high-cut frequency for the input filter (clamped between 10.0 and 22050.0 Hz).

fn get_high_cut_in(&self) -> f32

Gets the high-cut frequency for the input filter.

fn set_low_cut_out(&mut self, cut: f32)

Sets the low-cut frequency for the output filter (clamped between 10.0 and 22050.0 Hz).

fn get_low_cut_out(&self) -> f32

Gets the low-cut frequency for the output filter.

fn set_high_cut_out(&mut self, cut: f32)

Sets the high-cut frequency for the output filter (clamped between 10.0 and 22050.0 Hz).

fn get_high_cut_out(&self) -> f32

Gets the high-cut frequency for the output filter.

fn get_params(&self) -> &FxHashMap<String, EffectParamType>

Gets a reference to the map of all parameters and their types.

fn set_param( &mut self, name: &str, value: EffectParamValue<'_>, ) -> AudioEffectState

Sets a parameter by name. Returns the state after setting.

fn get_param( &self, name: &str, ) -> Result<EffectParamValue<'_>, AudioEffectState>

Gets a parameter value by name. Returns the value or an error state.

impl<T: Clone + FloatType + Float> Clone for AudioEffect<T>

fn clone(&self) -> AudioEffect<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.