Class Effector

Abstract base class for every DSP effect (e.g. Chorus, LowPassFilter, HardClip). Provides the common id/label/name bookkeeping, the audioWorkletNode slot, and the event system used to receive messages coming back from the AudioWorklet processor.

Effector cannot be instantiated directly — it is meant to be extended, with subclasses implementing initializeOnAttachment().

Example

import { Effector } from "@fluex/fluexgl-dsp";

// Effector is abstract - you use one of its subclasses instead:
// const effect = new Chorus({ mix: 0.4 });
// channel.addEffect(effect);

effect.addEventListener("incoming-processor-error", (message) => {
    console.error(message);
});

---

Constructor

Effector has no public constructor of its own beyond the implicit one inherited by subclasses (it is declared abstract and is always constructed through a concrete subclass such as Chorus or LowPassFilter).

---

Properties

id: string

A unique id, automatically generated when constructing the effect. Should NOT be changed.

label: string | null

A custom label for this effect. Subclasses typically default this to their own name (e.g. "Chorus").

name: string

Internal name of the effect. Defaults to "Effector" and is overridden by subclasses.

audioWorkletNode: AudioWorkletNode | null

The underlying AudioWorkletNode (or, for effects that wrap a native node such as Analyser, a node cast to this type) created during initializeOnAttachment(). null until the effect has been attached to a Channel or Master.

context: AudioContext | null

The AudioContext this effect was initialized with. null until attached.

---

Methods

initializeOnAttachment(context: AudioContext): Promise<void>

Abstract method every subclass must implement. Called automatically when the effect is attached to a Channel or Master (via addEffect/attachEffect); responsible for constructing the effect's audioWorkletNode.

Arguments

• context: AudioContext - The audio context to initialize the effect with.

Returns

• Promise<void>

addEventListener<K extends keyof EffectorEventMap>(event: K, cb: EffectorEventMap[K]): () => void

Registers a listener for processor events.

Arguments

• event: K (keyof EffectorEventMap) - Event name (e.g. "incoming-processor-message").
• cb: (message: IncomingProcessorMessage) => void - Callback function.

Returns

• () => void - Unsubscribe function to remove the listener.

once<K extends keyof EffectorEventMap>(event: K, cb: EffectorEventMap[K]): () => void

Registers a one-time event listener that automatically removes itself after the first call.

Arguments

• event: K (keyof EffectorEventMap) - Event name.
• cb: (message: IncomingProcessorMessage) => void - Callback function.

Returns

• () => void - Unsubscribe function to remove the listener.

removeEventListener<K extends keyof EffectorEventMap>(event: K, cb: EffectorEventMap[K]): Effector

Removes a specific listener from an event.

Arguments

• event: K (keyof EffectorEventMap) - Event name.
• cb: (message: IncomingProcessorMessage) => void - Callback function.

Returns

• Effector - The same instance, for chaining.

clearEventListeners(event?: keyof EffectorEventMap): Effector

Clears event listeners.

Arguments

• event?: keyof EffectorEventMap - If provided, clears listeners only for that event.

Returns

• Effector - The same instance, for chaining.

Events

All events carry an IncomingProcessorMessage payload, dispatched from messages posted back by the AudioWorklet processor.

"incoming-processor-message"

A generic message was received from the processor.

"incoming-processor-warning"

A warning message was received from the processor.

"incoming-processor-error"

An error message was received from the processor.

"processor-wasm-instantiated"

Fired once the processor reports that its WebAssembly module has been instantiated.

"initialized-on-channel-attachment"

Declared on EffectorEventMap but not currently dispatched anywhere in Effector itself.

---

Getters and setters

This class does not define public getters or setters.

---

Examples

Example: listening for processor messages on any effect

import { Chorus } from "@fluex/fluexgl-dsp";

const chorus = new Chorus({ mix: 0.4 });

const unsubscribe = chorus.addEventListener("incoming-processor-message", (message) => {
    console.log(message.message);
});

channel.addEffect(chorus);

// Later
unsubscribe();