Table of Contents

Class AudioEffectInstance

Manipulates the audio it receives for a given effect.

Inheritance
AudioEffectInstance
Derived

Remarks

An audio effect instance manipulates the audio it receives for a given effect. This instance is automatically created by an AudioEffect when it is added to a bus, and should usually not be created directly. If necessary, it can be fetched at run-time with AudioServer.get_bus_effect_instance.

See Also

Audio buses

Methods

_process(const void*, AudioFrame*, int)

Qualifiers: virtual

Called by the AudioServer to process this effect. When _process_silence is not overridden or it returns false, 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.

void _process(const void* src_buffer, AudioFrame* dst_buffer, int frame_count)

Parameters

src_buffer const void*
dst_buffer AudioFrame*
frame_count int

_process_silence

Qualifiers: virtualconst

Override this method to customize the processing behavior of this effect instance.

Should return true to force the AudioServer to always call AudioEffectInstance._process, even if the bus has been muted or cannot otherwise be heard.

bool _process_silence