Classes

EffectBase

EffectBase

Members

audioContext :AudioContext

effects/EffectBase.mjs, line 6

Methods

currentParameterValues() → {Object}

effects/EffectBase.mjs, line 30

Returns the value of all effect parameters at the current time.

Returns:

Object -

Effect-specific parameter values with keys as returned by getAvailableEffectParameters()

getInputNode() → {AudioNode}

effects/EffectBase.mjs, line 53

Returns a reference to the AudioNode to which all source AudioNodes should be connected in order to activate this Effect.

Returns:

AudioNode -

Reference to the first AudioNode in the effect sequencing pipeline

See:

• AudioNode

getOutputNode() → {AudioNode}

effects/EffectBase.mjs, line 62

Returns a reference to the AudioNode from which all effect-modified output audio is produced.

Returns:

AudioNode -

Reference to the final AudioNode in the effect sequencing pipeline

See:

• AudioNode

async load()

effects/EffectBase.mjs, line 23

Loads the necessary data to implement the corresponding Effect, which can then be applied to an individual Track or to the aggregate output of all tracks.

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

effects/EffectBase.mjs, line 43

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