Skip to main content

AudioEffect

voirs_cli::audio::effects

Trait AudioEffect 

Source 
pub trait AudioEffect: Send + Sync {
    // Required methods
    fn name(&self) -> &str;
    fn process(&mut self, samples: &mut [f32], sample_rate: u32) -> Result<()>;
    fn reset(&mut self) -> Result<()>;
    fn is_enabled(&self) -> bool;
    fn set_enabled(&mut self, enabled: bool);
    fn get_parameters(&self) -> HashMap<String, f32>;
    fn set_parameter(&mut self, name: &str, value: f32) -> Result<()>;
}
Expand description

Audio effect trait

Required Methods§

Source

fn name(&self) -> &str

Get effect name

Source

fn process(&mut self, samples: &mut [f32], sample_rate: u32) -> Result<()>

Process audio samples

Source

fn reset(&mut self) -> Result<()>

Reset effect state

Source

fn is_enabled(&self) -> bool

Check if effect is enabled

Source

fn set_enabled(&mut self, enabled: bool)

Set enabled state

Source

fn get_parameters(&self) -> HashMap<String, f32>

Get effect parameters

Source

fn set_parameter(&mut self, name: &str, value: f32) -> Result<()>

Set effect parameter

Implementors§