Class FrequencyShifterEffect

Equal-Hz frequency translation that deliberately breaks harmonic ratios.

Hierarchy

WorkletEffect<FrequencyShifterOptions>
- FrequencyShifterEffect

Index

Constructors

Properties

Methods

build toParameterData

Constructors

constructor

new FrequencyShifterEffect(
host: WorkletEffectHost,
options?: FrequencyShifterOptions,
): FrequencyShifterEffect
Parameters
- host: WorkletEffectHost
- options: FrequencyShifterOptions = {}
Returns FrequencyShifterEffect
Overrides WorkletEffect<FrequencyShifterOptions>.constructor
- Defined in src/effects.ts:667

Properties

`Protected` `Readonly`host

host: WorkletEffectHost

`Protected` `Readonly`options

options: FrequencyShifterOptions

Methods

build

build(context: BaseContext): Promise<AudioWorkletNode>
Parameters
- context: BaseContext
Returns Promise<AudioWorkletNode>
Inherited from WorkletEffect.build
- Defined in src/effects.ts:112

`Protected`toParameterData

toParameterData(options: FrequencyShifterOptions): Record<string, number>
Translate the construction options into worklet parameterData. Default: pass through as a numeric record (the worklet validates/clamps downstream).
Parameters
- options: FrequencyShifterOptions
Returns Record<string, number>
Inherited from WorkletEffect.toParameterData
- Defined in src/effects.ts:108