Attention: Here be dragons
This is thelatest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
AudioEffectInstance
Inherits:RefCounted<Object
Inherited By:AudioEffectSpectrumAnalyzerInstance
Manipulates the audio it receives for a given effect.
Description
An audio effect instance manipulates the audio it receives for a given effect. This instance is automatically created by anAudioEffect when it is added to a bus, and should usually not be created directly. If necessary, it can be fetched at run-time withAudioServer.get_bus_effect_instance().
Tutorials
Methods
_process(src_buffer: | |
Method Descriptions
void_process(src_buffer:constvoid*, dst_buffer:AudioFrame*, frame_count:int)virtualrequired🔗
Called by theAudioServer to process this effect. When_process_silence() is not overridden or it returnsfalse, this method is called only when the bus is active.
Note: It is not useful to override this method in GDScript or C#. Only GDExtension can take advantage of it.
bool_process_silence()virtualconst🔗
Override this method to customize the processing behavior of this effect instance.
Should returntrue to force theAudioServer to always call_process(), even if the bus has been muted or cannot otherwise be heard.