W3cubDocs

/Godot 3.1

AudioEffectDelay

Inherits: AudioEffect < Resource < Reference < Object

Category: Core

Brief Description

Adds a Delay audio effect to an Audio bus. Plays input signal back after a period of time.

Two tap delay and feedback options.

Properties

float dry
bool feedback/active
float feedback/delay_ms
float feedback/level_db
float feedback/lowpass
bool tap1/active
float tap1/delay_ms
float tap1/level_db
float tap1/pan
bool tap2/active
float tap2/delay_ms
float tap2/level_db
float tap2/pan

Description

Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds.

Property Descriptions

float dry

Setter set_dry(value)
Getter get_dry()

Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: 1.

bool feedback/active

Setter set_feedback_active(value)
Getter is_feedback_active()

If true, feedback is enabled. Default value: false.

float feedback/delay_ms

Setter set_feedback_delay_ms(value)
Getter get_feedback_delay_ms()

Feedback delay time in milliseconds. Default value: 340.

float feedback/level_db

Setter set_feedback_level_db(value)
Getter get_feedback_level_db()

Sound level for tap1. Default value: -6 dB.

float feedback/lowpass

Setter set_feedback_lowpass(value)
Getter get_feedback_lowpass()

Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: 16000.

bool tap1/active

Setter set_tap1_active(value)
Getter is_tap1_active()

If true, tap1 will be enabled. Default value: true.

float tap1/delay_ms

Setter set_tap1_delay_ms(value)
Getter get_tap1_delay_ms()

Tap1 delay time in milliseconds. Default value: 250ms.

float tap1/level_db

Setter set_tap1_level_db(value)
Getter get_tap1_level_db()

Sound level for tap1. Default value: -6 dB.

float tap1/pan

Setter set_tap1_pan(value)
Getter get_tap1_pan()

Pan position for tap1. Value can range from -1 (fully left) to 1 (fully right). Default value: 0.2.

bool tap2/active

Setter set_tap2_active(value)
Getter is_tap2_active()

If true, tap2 will be enabled. Default value: true.

float tap2/delay_ms

Setter set_tap2_delay_ms(value)
Getter get_tap2_delay_ms()

Tap2 delay time in milliseconds. Default value: 500ms.

float tap2/level_db

Setter set_tap2_level_db(value)
Getter get_tap2_level_db()

Sound level for tap2. Default value: -12 dB.

float tap2/pan

Setter set_tap2_pan(value)
Getter get_tap2_pan()

Pan position for tap2. Value can range from -1 (fully left) to 1 (fully right). Default value: -0.4.

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