Class AudioEffectChorus

Adds a chorus audio effect.

Inheritance

AudioEffect

Resource

RefCounted

Object

AudioEffectChorus

Remarks

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

See Also

Audio buses

Properties

dry

The effect's raw signal.

var dry : float = 1.0

Property Value

float

Remarks

• void set_dry(float value)
• float get_dry

voice/1/cutoff_hz

The voice's cutoff frequency.

var voice/1/cutoff_hz : float = 8000.0

Property Value

float

Remarks

• void set_voice_cutoff_hz(int voice_idx, float cutoff_hz)
• float get_voice_cutoff_hz(int voice_idx)

voice/1/delay_ms

The voice's signal delay.

var voice/1/delay_ms : float = 15.0

Property Value

float

Remarks

• void set_voice_delay_ms(int voice_idx, float delay_ms)
• float get_voice_delay_ms(int voice_idx)

voice/1/depth_ms

The voice filter's depth.

var voice/1/depth_ms : float = 2.0

Property Value

float

Remarks

• void set_voice_depth_ms(int voice_idx, float depth_ms)
• float get_voice_depth_ms(int voice_idx)

voice/1/level_db

The voice's volume.

var voice/1/level_db : float = 0.0

Property Value

float

Remarks

• void set_voice_level_db(int voice_idx, float level_db)
• float get_voice_level_db(int voice_idx)

voice/1/pan

The voice's pan level.

var voice/1/pan : float = -0.5

Property Value

float

Remarks

• void set_voice_pan(int voice_idx, float pan)
• float get_voice_pan(int voice_idx)

voice/1/rate_hz

The voice's filter rate.

var voice/1/rate_hz : float = 0.8

Property Value

float

Remarks

• void set_voice_rate_hz(int voice_idx, float rate_hz)
• float get_voice_rate_hz(int voice_idx)

voice/2/cutoff_hz

The voice's cutoff frequency.

var voice/2/cutoff_hz : float = 8000.0

Property Value

float

Remarks

• void set_voice_cutoff_hz(int voice_idx, float cutoff_hz)
• float get_voice_cutoff_hz(int voice_idx)

voice/2/delay_ms

The voice's signal delay.

var voice/2/delay_ms : float = 20.0

Property Value

float

Remarks

• void set_voice_delay_ms(int voice_idx, float delay_ms)
• float get_voice_delay_ms(int voice_idx)

voice/2/depth_ms

The voice filter's depth.

var voice/2/depth_ms : float = 3.0

Property Value

float

Remarks

• void set_voice_depth_ms(int voice_idx, float depth_ms)
• float get_voice_depth_ms(int voice_idx)

voice/2/level_db

The voice's volume.

var voice/2/level_db : float = 0.0

Property Value

float

Remarks

• void set_voice_level_db(int voice_idx, float level_db)
• float get_voice_level_db(int voice_idx)

voice/2/pan

The voice's pan level.

var voice/2/pan : float = 0.5

Property Value

float

Remarks

• void set_voice_pan(int voice_idx, float pan)
• float get_voice_pan(int voice_idx)

voice/2/rate_hz

The voice's filter rate.

var voice/2/rate_hz : float = 1.2

Property Value

float

Remarks

• void set_voice_rate_hz(int voice_idx, float rate_hz)
• float get_voice_rate_hz(int voice_idx)

voice/3/cutoff_hz

The voice's cutoff frequency.

var voice/3/cutoff_hz : float

Property Value

float

Remarks

• void set_voice_cutoff_hz(int voice_idx, float cutoff_hz)
• float get_voice_cutoff_hz(int voice_idx)

voice/3/delay_ms

The voice's signal delay.

var voice/3/delay_ms : float

Property Value

float

Remarks

• void set_voice_delay_ms(int voice_idx, float delay_ms)
• float get_voice_delay_ms(int voice_idx)

voice/3/depth_ms

The voice filter's depth.

var voice/3/depth_ms : float

Property Value

float

Remarks

• void set_voice_depth_ms(int voice_idx, float depth_ms)
• float get_voice_depth_ms(int voice_idx)

voice/3/level_db

The voice's volume.

var voice/3/level_db : float

Property Value

float

Remarks

• void set_voice_level_db(int voice_idx, float level_db)
• float get_voice_level_db(int voice_idx)

voice/3/pan

The voice's pan level.

var voice/3/pan : float

Property Value

float

Remarks

• void set_voice_pan(int voice_idx, float pan)
• float get_voice_pan(int voice_idx)

voice/3/rate_hz

The voice's filter rate.

var voice/3/rate_hz : float

Property Value

float

Remarks

• void set_voice_rate_hz(int voice_idx, float rate_hz)
• float get_voice_rate_hz(int voice_idx)

voice/4/cutoff_hz

The voice's cutoff frequency.

var voice/4/cutoff_hz : float

Property Value

float

Remarks

• void set_voice_cutoff_hz(int voice_idx, float cutoff_hz)
• float get_voice_cutoff_hz(int voice_idx)

voice/4/delay_ms

The voice's signal delay.

var voice/4/delay_ms : float

Property Value

float

Remarks

• void set_voice_delay_ms(int voice_idx, float delay_ms)
• float get_voice_delay_ms(int voice_idx)

voice/4/depth_ms

The voice filter's depth.

var voice/4/depth_ms : float

Property Value

float

Remarks

• void set_voice_depth_ms(int voice_idx, float depth_ms)
• float get_voice_depth_ms(int voice_idx)

voice/4/level_db

The voice's volume.

var voice/4/level_db : float

Property Value

float

Remarks

• void set_voice_level_db(int voice_idx, float level_db)
• float get_voice_level_db(int voice_idx)

voice/4/pan

The voice's pan level.

var voice/4/pan : float

Property Value

float

Remarks

• void set_voice_pan(int voice_idx, float pan)
• float get_voice_pan(int voice_idx)

voice/4/rate_hz

The voice's filter rate.

var voice/4/rate_hz : float

Property Value

float

Remarks

• void set_voice_rate_hz(int voice_idx, float rate_hz)
• float get_voice_rate_hz(int voice_idx)

voice_count

The number of voices in the effect.

var voice_count : int = 2

Property Value

int

Remarks

• void set_voice_count(int value)
• int get_voice_count

wet

The effect's processed signal.

var wet : float = 0.5

Property Value

float

Remarks

• void set_wet(float value)
• float get_wet

Methods

get_voice_cutoff_hz(int)

Qualifiers: const

float get_voice_cutoff_hz(int voice_idx)

Parameters

voice_idx int

get_voice_delay_ms(int)

Qualifiers: const

float get_voice_delay_ms(int voice_idx)

Parameters

voice_idx int

get_voice_depth_ms(int)

Qualifiers: const

float get_voice_depth_ms(int voice_idx)

Parameters

voice_idx int

get_voice_level_db(int)

Qualifiers: const

float get_voice_level_db(int voice_idx)

Parameters

voice_idx int

get_voice_pan(int)

Qualifiers: const

float get_voice_pan(int voice_idx)

Parameters

voice_idx int

get_voice_rate_hz(int)

Qualifiers: const

float get_voice_rate_hz(int voice_idx)

Parameters

voice_idx int

set_voice_cutoff_hz(int, float)

void set_voice_cutoff_hz(int voice_idx, float cutoff_hz)

Parameters

voice_idx int

cutoff_hz float

set_voice_delay_ms(int, float)

void set_voice_delay_ms(int voice_idx, float delay_ms)

Parameters

voice_idx int

delay_ms float

set_voice_depth_ms(int, float)

void set_voice_depth_ms(int voice_idx, float depth_ms)

Parameters

voice_idx int

depth_ms float

set_voice_level_db(int, float)

void set_voice_level_db(int voice_idx, float level_db)

Parameters

voice_idx int

level_db float

set_voice_pan(int, float)

void set_voice_pan(int voice_idx, float pan)

Parameters

voice_idx int

pan float

set_voice_rate_hz(int, float)

void set_voice_rate_hz(int voice_idx, float rate_hz)

Parameters

voice_idx int

rate_hz float