Trait kira::mixer::effect::Effect[][src]

pub trait Effect: Send + Debug {
    fn process(
        &mut self,
        dt: f64,
        input: Frame,
        parameters: &Parameters
    ) -> Frame; fn init(&mut self, sample_rate: u32) { ... } }
Expand description

Receives input audio from a mixer track and outputs modified audio.

Required methods

fn process(&mut self, dt: f64, input: Frame, parameters: &Parameters) -> Frame[src]

Transforms an input frame.

  • dt is the time that’s elapsed since the previous frame (in seconds)
  • input is the input audio
  • parameters is a set of all parameter IDs and their corresponding values. This is useful in conjunction with CachedValues, which can respond to parameter changes and update their value accordingly.

Provided methods

fn init(&mut self, sample_rate: u32)[src]

Performs any required setup for the effect.

This is called once when the effect is first added to a track.

Implementors

impl Effect for Delay[src]

fn init(&mut self, sample_rate: u32)[src]

fn process(&mut self, dt: f64, input: Frame, parameters: &Parameters) -> Frame[src]

impl Effect for Distortion[src]

fn process(&mut self, _dt: f64, input: Frame, parameters: &Parameters) -> Frame[src]

impl Effect for Filter[src]

fn process(&mut self, dt: f64, input: Frame, parameters: &Parameters) -> Frame[src]

impl Effect for Reverb[src]

fn init(&mut self, sample_rate: u32)[src]

fn process(&mut self, _dt: f64, input: Frame, parameters: &Parameters) -> Frame[src]