AudioEffect

A resource holding audio-bus effect parameters.

1.0.0

class AudioEffectReckfellSharpInherits Resource

AudioEffect holds processing settings; an AudioEffectInstance runs DSP. Add a resource to a bus with AudioServer.AddBusEffect(). Effects process the combined bus signal top to bottom before its fader and mute.

Changing a shared resource changes parameters everywhere it is used. Create separate resources for independent settings. Bus bypass skips the whole chain, including capture and analyzers; an individual effect's enable flag controls only that effect.

Working example.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AudioEffectConstructor

# AudioEffect

C#
public AudioEffect();

Methods1

_InstantiateAudioEffectInstance

# _Instantiate

public virtual AudioEffectInstance _Instantiate();

Override this method to customize the AudioEffectInstance created when this effect is applied on a bus in the editor's Audio panel, or through AudioServer.AddBusEffect.

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

Returns AudioEffectInstance

Reckfell Engine documentationBack to top ↑