Methods

static getEffectParameters(effectType) → {Array.<EffectParameter>}

modules/Effect.mjs, line 54

Returns a list of effect-specific EffectParameters for manipulation in the corresponding EffectType.

Note that the effectType parameter must be the numeric value associated with a certain EffectType, not a string-based key.

Parameters:

Name	Type	Description
effectType	number	EffectType for which to return a parameter list

Returns:

Array.<EffectParameter> -

List of effect-specific parameters available for updating

See:

• EffectType
• EffectParameter

async, static loadEffect(audioContext, effectName, effectType) → {Promise.<Effect>}

modules/Effect.mjs, line 72

Loads a pre-defined Effect capable of being applied to an individual Track or to the aggregate output of all tracks.

Parameters:

Name	Type	Description
audioContext	AudioContext	Reference to the global browser AudioContext
effectName	string	User-defined name to assign to the newly loaded effect
effectType	number	Numeric value corresponding to the desired EffectType

Returns:

Promise.<Effect> -

Newly created audio Effect

See:

• AudioContext
• EffectType
• Effect