Skip to main content

AudioEffectChorus

Inherits: AudioEffect < Resource < RefCounted < Object

Adds a chorus audio effect.

Description

Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.

Tutorials

Properties

floatdry1.0
floatvoice/1/cutoff_hz8000.0
floatvoice/1/delay_ms15.0
floatvoice/1/depth_ms2.0
floatvoice/1/level_db0.0
floatvoice/1/pan-0.5
floatvoice/1/rate_hz0.8
floatvoice/2/cutoff_hz8000.0
floatvoice/2/delay_ms20.0
floatvoice/2/depth_ms3.0
floatvoice/2/level_db0.0
floatvoice/2/pan0.5
floatvoice/2/rate_hz1.2
floatvoice/3/cutoff_hz
floatvoice/3/delay_ms
floatvoice/3/depth_ms
floatvoice/3/level_db
floatvoice/3/pan
floatvoice/3/rate_hz
floatvoice/4/cutoff_hz
floatvoice/4/delay_ms
floatvoice/4/depth_ms
floatvoice/4/level_db
floatvoice/4/pan
floatvoice/4/rate_hz
intvoice_count2
floatwet0.5

Methods

floatget_voice_cutoff_hz\ (\ voice_idx: int\ ) const
floatget_voice_delay_ms\ (\ voice_idx: int\ ) const
floatget_voice_depth_ms\ (\ voice_idx: int\ ) const
floatget_voice_level_db\ (\ voice_idx: int\ ) const
floatget_voice_pan\ (\ voice_idx: int\ ) const
floatget_voice_rate_hz\ (\ voice_idx: int\ ) const
voidset_voice_cutoff_hz\ (\ voice_idx: int, cutoff_hz: float\ )
voidset_voice_delay_ms\ (\ voice_idx: int, delay_ms: float\ )
voidset_voice_depth_ms\ (\ voice_idx: int, depth_ms: float\ )
voidset_voice_level_db\ (\ voice_idx: int, level_db: float\ )
voidset_voice_pan\ (\ voice_idx: int, pan: float\ )
voidset_voice_rate_hz\ (\ voice_idx: int, rate_hz: float\ )

Property Descriptions

float dry = 1.0 🔗

  • void set_dry\ (\ value: float\ )
  • float get_dry\ (\ )

The effect's raw signal.


float voice/1/cutoff_hz = 8000.0 🔗

  • void set_voice_cutoff_hz\ (\ voice_idx: int, cutoff_hz: float\ )
  • float get_voice_cutoff_hz\ (\ voice_idx: int\ ) const

The voice's cutoff frequency.


float voice/1/delay_ms = 15.0 🔗

  • void set_voice_delay_ms\ (\ voice_idx: int, delay_ms: float\ )
  • float get_voice_delay_ms\ (\ voice_idx: int\ ) const

The voice's signal delay.


float voice/1/depth_ms = 2.0 🔗

  • void set_voice_depth_ms\ (\ voice_idx: int, depth_ms: float\ )
  • float get_voice_depth_ms\ (\ voice_idx: int\ ) const

The voice filter's depth.


float voice/1/level_db = 0.0 🔗

  • void set_voice_level_db\ (\ voice_idx: int, level_db: float\ )
  • float get_voice_level_db\ (\ voice_idx: int\ ) const

The voice's volume.


float voice/1/pan = -0.5 🔗

  • void set_voice_pan\ (\ voice_idx: int, pan: float\ )
  • float get_voice_pan\ (\ voice_idx: int\ ) const

The voice's pan level.


float voice/1/rate_hz = 0.8 🔗

  • void set_voice_rate_hz\ (\ voice_idx: int, rate_hz: float\ )
  • float get_voice_rate_hz\ (\ voice_idx: int\ ) const

The voice's filter rate.


float voice/2/cutoff_hz = 8000.0 🔗

  • void set_voice_cutoff_hz\ (\ voice_idx: int, cutoff_hz: float\ )
  • float get_voice_cutoff_hz\ (\ voice_idx: int\ ) const

The voice's cutoff frequency.


float voice/2/delay_ms = 20.0 🔗

  • void set_voice_delay_ms\ (\ voice_idx: int, delay_ms: float\ )
  • float get_voice_delay_ms\ (\ voice_idx: int\ ) const

The voice's signal delay.


float voice/2/depth_ms = 3.0 🔗

  • void set_voice_depth_ms\ (\ voice_idx: int, depth_ms: float\ )
  • float get_voice_depth_ms\ (\ voice_idx: int\ ) const

The voice filter's depth.


float voice/2/level_db = 0.0 🔗

  • void set_voice_level_db\ (\ voice_idx: int, level_db: float\ )
  • float get_voice_level_db\ (\ voice_idx: int\ ) const

The voice's volume.


float voice/2/pan = 0.5 🔗

  • void set_voice_pan\ (\ voice_idx: int, pan: float\ )
  • float get_voice_pan\ (\ voice_idx: int\ ) const

The voice's pan level.


float voice/2/rate_hz = 1.2 🔗

  • void set_voice_rate_hz\ (\ voice_idx: int, rate_hz: float\ )
  • float get_voice_rate_hz\ (\ voice_idx: int\ ) const

The voice's filter rate.


float voice/3/cutoff_hz 🔗

  • void set_voice_cutoff_hz\ (\ voice_idx: int, cutoff_hz: float\ )
  • float get_voice_cutoff_hz\ (\ voice_idx: int\ ) const

The voice's cutoff frequency.


float voice/3/delay_ms 🔗

  • void set_voice_delay_ms\ (\ voice_idx: int, delay_ms: float\ )
  • float get_voice_delay_ms\ (\ voice_idx: int\ ) const

The voice's signal delay.


float voice/3/depth_ms 🔗

  • void set_voice_depth_ms\ (\ voice_idx: int, depth_ms: float\ )
  • float get_voice_depth_ms\ (\ voice_idx: int\ ) const

The voice filter's depth.


float voice/3/level_db 🔗

  • void set_voice_level_db\ (\ voice_idx: int, level_db: float\ )
  • float get_voice_level_db\ (\ voice_idx: int\ ) const

The voice's volume.


float voice/3/pan 🔗

  • void set_voice_pan\ (\ voice_idx: int, pan: float\ )
  • float get_voice_pan\ (\ voice_idx: int\ ) const

The voice's pan level.


float voice/3/rate_hz 🔗

  • void set_voice_rate_hz\ (\ voice_idx: int, rate_hz: float\ )
  • float get_voice_rate_hz\ (\ voice_idx: int\ ) const

The voice's filter rate.


float voice/4/cutoff_hz 🔗

  • void set_voice_cutoff_hz\ (\ voice_idx: int, cutoff_hz: float\ )
  • float get_voice_cutoff_hz\ (\ voice_idx: int\ ) const

The voice's cutoff frequency.


float voice/4/delay_ms 🔗

  • void set_voice_delay_ms\ (\ voice_idx: int, delay_ms: float\ )
  • float get_voice_delay_ms\ (\ voice_idx: int\ ) const

The voice's signal delay.


float voice/4/depth_ms 🔗

  • void set_voice_depth_ms\ (\ voice_idx: int, depth_ms: float\ )
  • float get_voice_depth_ms\ (\ voice_idx: int\ ) const

The voice filter's depth.


float voice/4/level_db 🔗

  • void set_voice_level_db\ (\ voice_idx: int, level_db: float\ )
  • float get_voice_level_db\ (\ voice_idx: int\ ) const

The voice's volume.


float voice/4/pan 🔗

  • void set_voice_pan\ (\ voice_idx: int, pan: float\ )
  • float get_voice_pan\ (\ voice_idx: int\ ) const

The voice's pan level.


float voice/4/rate_hz 🔗

  • void set_voice_rate_hz\ (\ voice_idx: int, rate_hz: float\ )
  • float get_voice_rate_hz\ (\ voice_idx: int\ ) const

The voice's filter rate.


int voice_count = 2 🔗

  • void set_voice_count\ (\ value: int\ )
  • int get_voice_count\ (\ )

The number of voices in the effect.


float wet = 0.5 🔗

  • void set_wet\ (\ value: float\ )
  • float get_wet\ (\ )

The effect's processed signal.


Method Descriptions

float get_voice_cutoff_hz\ (\ voice_idx: int\ ) const 🔗

There is currently no description for this method. Please help us by contributing one!


float get_voice_delay_ms\ (\ voice_idx: int\ ) const 🔗

There is currently no description for this method. Please help us by contributing one!


float get_voice_depth_ms\ (\ voice_idx: int\ ) const 🔗

There is currently no description for this method. Please help us by contributing one!


float get_voice_level_db\ (\ voice_idx: int\ ) const 🔗

There is currently no description for this method. Please help us by contributing one!


float get_voice_pan\ (\ voice_idx: int\ ) const 🔗

There is currently no description for this method. Please help us by contributing one!


float get_voice_rate_hz\ (\ voice_idx: int\ ) const 🔗

There is currently no description for this method. Please help us by contributing one!


void set_voice_cutoff_hz\ (\ voice_idx: int, cutoff_hz: float\ ) 🔗

There is currently no description for this method. Please help us by contributing one!


void set_voice_delay_ms\ (\ voice_idx: int, delay_ms: float\ ) 🔗

There is currently no description for this method. Please help us by contributing one!


void set_voice_depth_ms\ (\ voice_idx: int, depth_ms: float\ ) 🔗

There is currently no description for this method. Please help us by contributing one!


void set_voice_level_db\ (\ voice_idx: int, level_db: float\ ) 🔗

There is currently no description for this method. Please help us by contributing one!


void set_voice_pan\ (\ voice_idx: int, pan: float\ ) 🔗

There is currently no description for this method. Please help us by contributing one!


void set_voice_rate_hz\ (\ voice_idx: int, rate_hz: float\ ) 🔗

There is currently no description for this method. Please help us by contributing one!