Members

input

modules/Effect.mjs, line 101

Reference to an AudioNode to which all source AudioNodes should be connected.

name

modules/Effect.mjs, line 85

User-defined name of the Effect.

output

modules/Effect.mjs, line 110

Reference to an AudioNode from which all effect-modified output audio is produced, and which should be connected to all destination AudioNodes.

parameters

modules/Effect.mjs, line 118

List of effect-specific EffectParameters for manipulation in the effectOptions parameter of the update() function.

type

modules/Effect.mjs, line 92

Numeric value corresponding to the EffectType of the Effect.

Methods

currentParameterValues() → {Object}

modules/Effect.mjs, line 129

Retrieves the values for all effect-specific parameters at the current time, with keys as specified by the parameters member of this Effect.

Returns:

Object -

Effect-specific parameter values with keys as returned by parameters

async update(effectOptions, opt updateTime, opt timeConstant) → {Promise.<boolean>}

modules/Effect.mjs, line 146

Updates the parameters of the effect at the specified time.

Note that the updateTime parameter can be omitted to immediately cause the requested changes to take effect.

Parameters:

Name	Type	Attributes	Description
effectOptions	Object		Effect-specific options as returned by getAvailableEffectParameters()
updateTime	number	<optional>	Global API time at which to update the effect
timeConstant	number	<optional>	Time constant defining an exponential approach to the target

Returns:

Promise.<boolean> -

Whether the effect update was successfully applied