AudioFilterInfo

View source
backend.AudioFilterInfo (Class)

Internal metadata for audio filters attached to a bus.

This structure tracks the state and components needed for real-time audio filter processing in the Clay backend. It bridges between the high-level AudioFilter API and the low-level worklet processing system.

Instance Members

clay
id: Int

Unique identifier for this filter instance. Used to reference the filter in add/remove operations.

clay
paramsDirty: Bool

Flag indicating whether filter parameters need to be synchronized to the worklet on the next audio process cycle. Set to true when filterParamsChanged() is called.

The instantiated worklet that performs the actual audio processing. Created lazily on first use in the audio thread. On web, this runs in an AudioWorklet. On native, it runs in the audio callback.

The class type of the worklet to instantiate. Retrieved from the filter's workletClass() method.

The high-level filter instance that contains the parameters and configuration for this audio effect.

clay
new(id: Int, ?paramsDirty: Null<Bool>, ?worklet: Null<ceramic.AudioFilterWorklet>, workletClass: Class<ceramic.AudioFilterWorklet>, filter: ceramic.AudioFilter): Void
Name Type Default Description
id Int * Unique identifier for this filter instance. Used to reference the filter in add/remove operations.
paramsDirty Null<Bool> (optional) * Flag indicating whether filter parameters need to be synchronized to the worklet on the next audio process cycle. Set to true when filterParamsChanged() is called.
worklet Null<ceramic.AudioFilterWorklet> (optional) * The instantiated worklet that performs the actual audio processing. Created lazily on first use in the audio thread. On web, this runs in an AudioWorklet. On native, it runs in the audio callback.
workletClass Class<ceramic.AudioFilterWorklet> * The class type of the worklet to instantiate. Retrieved from the filter's workletClass() method.
filter ceramic.AudioFilter * The high-level filter instance that contains the parameters and configuration for this audio effect.

Metadata

Name Parameters
:structInit -