Class EffectsBus

Manages the effects bus with wet/dry routing, convolution reverb, and filters.

Index

Constructors

Methods

getOutputGain isInitialized ensureInitialized setMix getMix setReverb getActiveReverb setLowPass getLowPass setHighPass getHighPass getState transitionTo getConvolverNode setActiveImpulseKey updateWetMix destroy

Constructors

constructor

new EffectsBus(
    context: ContextManager,
    impulseLoader: ImpulseLoader,
    logger: Logger,
): EffectsBus
Parameters
- context: ContextManager
- impulseLoader: ImpulseLoader
- logger: Logger
Returns EffectsBus
- Defined in effects/effects-bus.ts:21

Methods

getOutputGain

getOutputGain(): GainNode | null
Gets the output gain node.

Returns GainNode | null
- Defined in effects/effects-bus.ts:30

isInitialized

isInitialized(): boolean
Checks if the effects bus is initialized.

Returns boolean
- Defined in effects/effects-bus.ts:37

ensureInitialized

ensureInitialized(): void
Lazily initializes the effects bus.

Returns void
- Defined in effects/effects-bus.ts:44

setMix

setMix(wet: number): void
Sets the wet/dry mix for the effects bus.
Parameters
- wet: number
Returns void
- Defined in effects/effects-bus.ts:98

getMix

getMix(): number
Gets the current wet/dry mix.

Returns number
- Defined in effects/effects-bus.ts:125

setReverb

setReverb(key: string | null): Promise<void>
Applies a reverb effect using a loaded impulse response.
Parameters
- key: string | null
Returns Promise<void>
- Defined in effects/effects-bus.ts:132

getActiveReverb

getActiveReverb(): string | null
Gets the key of the currently active reverb.

Returns string | null
- Defined in effects/effects-bus.ts:151

setLowPass

setLowPass(frequency: number, Q?: number): void
Sets the low-pass filter parameters.
Parameters
- frequency: number
- Q: number = 1
Returns void
- Defined in effects/effects-bus.ts:158

getLowPass

getLowPass(): FilterConfig | null
Gets the current low-pass filter configuration.

Returns FilterConfig | null
- Defined in effects/effects-bus.ts:182

setHighPass

setHighPass(frequency: number, Q?: number): void
Sets the high-pass filter parameters.
Parameters
- frequency: number
- Q: number = 1
Returns void
- Defined in effects/effects-bus.ts:195

getHighPass

getHighPass(): FilterConfig | null
Gets the current high-pass filter configuration.

Returns FilterConfig | null
- Defined in effects/effects-bus.ts:219

getState

getState(): {
    initialized: boolean;
    wetMix: number;
    activeReverb: string
    | null;
    lowPass: FilterConfig | null;
    highPass: FilterConfig | null;
    registeredImpulses: string[];
}
Gets comprehensive state information.

Returns {
    initialized: boolean;
    wetMix: number;
    activeReverb: string | null;
    lowPass: FilterConfig | null;
    highPass: FilterConfig | null;
    registeredImpulses: string[];
}
- Defined in effects/effects-bus.ts:232

transitionTo

transitionTo(
    wetMix: number,
    lowPass: FilterConfig,
    highPass: FilterConfig,
    durationSeconds: number,
): void
Transitions wet/dry mix and filter values over time. Used by environment transitions.
Parameters
- wetMix: number
- lowPass: FilterConfig
- highPass: FilterConfig
- durationSeconds: number
Returns void
- Defined in effects/effects-bus.ts:254

getConvolverNode

getConvolverNode(): ConvolverNode | null
Gets the convolver node for direct impulse response changes.

Returns ConvolverNode | null
- Defined in effects/effects-bus.ts:303

setActiveImpulseKey

setActiveImpulseKey(key: string | null): void
Sets the active impulse key (for tracking).
Parameters
- key: string | null
Returns void
- Defined in effects/effects-bus.ts:310

updateWetMix

updateWetMix(value: number): void
Updates the wet mix value (for tracking after transition).
Parameters
- value: number
Returns void
- Defined in effects/effects-bus.ts:317

destroy

destroy(): void
Destroys the effects bus.

Returns void
- Defined in effects/effects-bus.ts:324

Class EffectsBus

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EffectsBus

Methods

getOutputGain

Returns GainNode | null

isInitialized

Returns boolean

ensureInitialized

Returns void

setMix

Parameters

Returns void

getMix

Returns number

setReverb

Parameters

Returns Promise<void>

getActiveReverb

Returns string | null

setLowPass

Parameters

Returns void

getLowPass

Returns FilterConfig | null

setHighPass

Parameters

Returns void

getHighPass

Returns FilterConfig | null

getState

Returns { initialized: boolean; wetMix: number; activeReverb: string | null; lowPass: FilterConfig | null; highPass: FilterConfig | null; registeredImpulses: string[];}

transitionTo

Parameters

Returns void

getConvolverNode

Returns ConvolverNode | null

setActiveImpulseKey

Parameters

Returns void

updateWetMix

Parameters

Returns void

destroy

Returns void

Settings

On This Page

Returns {
initialized: boolean;
wetMix: number;
activeReverb: string | null;
lowPass: FilterConfig | null;
highPass: FilterConfig | null;
registeredImpulses: string[];
}