AudioFilterWorklet

The actual worklet class that will do the audio processing of a given AudioFilter.

AudioFilterWorklet is the base class for implementing custom audio effects and processors. Each worklet runs in the audio processing pipeline and can modify audio data in real-time.

Features:

• Thread-safe parameter access (atomic operations on native platforms)
• Automatic parameter management via @param metadata
• Support for boolean, int, and float parameters
• Per-bus audio processing

To create a custom filter:

1. Extend this class
2. Mark parameters with @param metadata
3. Override the process() method
4. Create an AudioFilter wrapper for public API

class MyEchoWorklet extends AudioFilterWorklet {
    var delayBuffer:Array<Float> = [];
    var writePos:Int = 0;
    override function process(buffer:AudioFilterBuffer, samples:Int,
                             channels:Int, sampleRate:Float, time:Float):Void {
        // Implement echo effect here
    }
}

Instance Members #

The id of the audio filter this worklet is associated with

The bus this filter is attached to (-1 if not attached)

Whether this filter is currently active

Return the number of parameters this filter has. (automatically generated from fields marked with @param, no need to override it)

Process audio buffer in place. Override this method to implement custom filtering. CAUTION: this may be called from a background thread

Creates a new audio filter worklet.

Private Members #

Internal storage for filter parameters.

A fixed-size vector, allocated by the worklet itself (the generated constructor) from the number of fields marked with @param.

Get a boolean parameter at the given position (0-based). Parameters are stored as floats where 0 = false, non-zero = true.

Get an int parameter at the given position (0-based). The float value is truncated to an integer.

Get a float parameter at the given position (0-based).