Description

The baseResource for every audio effect. In the editor, an audio effect can be added to the current bus layout through the Audio panel. At run-time, it is also possible to manipulate audio effects throughAudioServer.add_bus_effect(),AudioServer.remove_bus_effect(), andAudioServer.get_bus_effect().

When applied on a bus, an audio effect creates a correspondingAudioEffectInstance. The instance is directly responsible for manipulating the sound, based on the original audio effect's properties.

Tutorials

• Audio buses

• Audio Microphone Record Demo

Methods

Method Descriptions

AudioEffectInstance_instantiate()virtual🔗

Override this method to customize theAudioEffectInstance created when this effect is applied on a bus in the editor's Audio panel, or throughAudioServer.add_bus_effect().

extendsAudioEffect@exportvarstrength=4.0func_instantiate():vareffect=CustomAudioEffectInstance.new()effect.base=selfreturneffect

Note: It is recommended to keep a reference to the originalAudioEffect in the new instance. Depending on the implementation this allows the effect instance to listen for changes at run-time and be modified accordingly.