W3cubDocs

/Godot 3.1

AudioEffectChorus

Inherits: AudioEffect < Resource < Reference < Object

Category: Core

Brief Description

Adds a chorus audio effect.

Properties

float dry
float voice/1/cutoff_hz
float voice/1/delay_ms
float voice/1/depth_ms
float voice/1/level_db
float voice/1/pan
float voice/1/rate_hz
float voice/2/cutoff_hz
float voice/2/delay_ms
float voice/2/depth_ms
float voice/2/level_db
float voice/2/pan
float voice/2/rate_hz
float voice/3/cutoff_hz
float voice/3/delay_ms
float voice/3/depth_ms
float voice/3/level_db
float voice/3/pan
float voice/3/rate_hz
float voice/4/cutoff_hz
float voice/4/delay_ms
float voice/4/depth_ms
float voice/4/level_db
float voice/4/pan
float voice/4/rate_hz
int voice_count
float wet

Description

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

Property Descriptions

float dry

Setter set_dry(value)
Getter get_dry()

The effect’s raw signal.

float voice/1/cutoff_hz

Setter set_voice_cutoff_hz(value)
Getter get_voice_cutoff_hz()

The voice’s cutoff frequency.

float voice/1/delay_ms

Setter set_voice_delay_ms(value)
Getter get_voice_delay_ms()

The voice’s signal delay.

float voice/1/depth_ms

Setter set_voice_depth_ms(value)
Getter get_voice_depth_ms()

The voice filter’s depth.

float voice/1/level_db

Setter set_voice_level_db(value)
Getter get_voice_level_db()

The voice’s volume.

float voice/1/pan

Setter set_voice_pan(value)
Getter get_voice_pan()

The voice’s pan level.

float voice/1/rate_hz

Setter set_voice_rate_hz(value)
Getter get_voice_rate_hz()

The voice’s filter rate.

float voice/2/cutoff_hz

Setter set_voice_cutoff_hz(value)
Getter get_voice_cutoff_hz()

The voice’s cutoff frequency.

float voice/2/delay_ms

Setter set_voice_delay_ms(value)
Getter get_voice_delay_ms()

The voice’s signal delay.

float voice/2/depth_ms

Setter set_voice_depth_ms(value)
Getter get_voice_depth_ms()

The voice filter’s depth.

float voice/2/level_db

Setter set_voice_level_db(value)
Getter get_voice_level_db()

The voice’s volume.

float voice/2/pan

Setter set_voice_pan(value)
Getter get_voice_pan()

The voice’s pan level.

float voice/2/rate_hz

Setter set_voice_rate_hz(value)
Getter get_voice_rate_hz()

The voice’s filter rate.

float voice/3/cutoff_hz

Setter set_voice_cutoff_hz(value)
Getter get_voice_cutoff_hz()

The voice’s cutoff frequency.

float voice/3/delay_ms

Setter set_voice_delay_ms(value)
Getter get_voice_delay_ms()

The voice’s signal delay.

float voice/3/depth_ms

Setter set_voice_depth_ms(value)
Getter get_voice_depth_ms()

The voice filter’s depth.

float voice/3/level_db

Setter set_voice_level_db(value)
Getter get_voice_level_db()

The voice’s volume.

float voice/3/pan

Setter set_voice_pan(value)
Getter get_voice_pan()

The voice’s pan level.

float voice/3/rate_hz

Setter set_voice_rate_hz(value)
Getter get_voice_rate_hz()

The voice’s filter rate.

float voice/4/cutoff_hz

Setter set_voice_cutoff_hz(value)
Getter get_voice_cutoff_hz()

The voice’s cutoff frequency.

float voice/4/delay_ms

Setter set_voice_delay_ms(value)
Getter get_voice_delay_ms()

The voice’s signal delay.

float voice/4/depth_ms

Setter set_voice_depth_ms(value)
Getter get_voice_depth_ms()

The voice filter’s depth.

float voice/4/level_db

Setter set_voice_level_db(value)
Getter get_voice_level_db()

The voice’s volume.

float voice/4/pan

Setter set_voice_pan(value)
Getter get_voice_pan()

The voice’s pan level.

float voice/4/rate_hz

Setter set_voice_rate_hz(value)
Getter get_voice_rate_hz()

The voice’s filter rate.

int voice_count

Setter set_voice_count(value)
Getter get_voice_count()

The amount of voices in the effect.

float wet

Setter set_wet(value)
Getter get_wet()

The effect’s processed signal.

© 2014–2019 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.1/classes/class_audioeffectchorus.html