Index · Object → RefCounted → Resource → AudioEffect → AudioEffectDelay

AudioEffectDelay

Adds a delay audio effect to an audio bus.

Emulates an echo by playing the input audio back after a period of time.

Class Description

A "delay" effect plays the input audio signal back after a period of time. Each repetition is called a "delay tap" or simply "tap". Delay taps may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo to a pronounced blending of previous sounds with new sounds.

See also AudioEffectReverb for a blurry, continuous echo.

Properties

var dry: float = 1.0

The volume ratio of the original audio. Value can range from 0 to 1.

var feedback_active: bool = false

If true, feedback is enabled, repeating taps after they are played.

var feedback_delay_ms: float = 340.0

Feedback delay time in milliseconds. Value can range from 0 to 1500.

var feedback_level_db: float = -6.0

Gain for feedback, in dB. Value can range from -60 to 0.

var feedback_lowpass: float = 16000.0

Low-pass filter for feedback, in Hz. Frequencies above this value are filtered out. Value can range from 1 to 16000.

var tap1_active: bool = true

If true, the first tap will be enabled.

var tap1_delay_ms: float = 250.0

First tap delay time in milliseconds, compared to the original audio. Value can range from 0 to 1500.

var tap1_level_db: float = -6.0

Gain for the first tap, in dB. Value can range from -60 to 0.

var tap1_pan: float = 0.2

Pan position for the first tap. Negative values pan the sound to the left, positive pan to the right. Value can range from -1 to 1.

var tap2_active: bool = true

If true, the second tap will be enabled.

var tap2_delay_ms: float = 500.0

Second tap delay time in milliseconds, compared to the original audio. Value can range from 0 to 1500.

var tap2_level_db: float = -12.0

Gain for the second tap, in dB. Value can range from -60 to 0.

var tap2_pan: float = -0.4

Pan position for the second tap. Negative values pan the sound to the left, positive pan to the right. Value can range from -1 to 1.

Inherited from Resource (4)

Methods

Inherited from AudioEffect (1)
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)