Chorus()

Class representing a Chorus effect.

A Chorus effect is an audio modulation effect that replicates an audio signal and modulates and delays the result, such that it comes directly after and alters the original signal's pitch. This effect is used to thicken the tone of an audio signal and create an epic feeling.

new Chorus()
effects/Chorus.mjs, line 13

Constructs a new Chorus effect object.

Extends

Classes

Chorus
Chorus

Members

audioContext :AudioContext
effects/EffectBase.mjs, line 6

Overrides:

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()

Overrides:

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

Overrides:
See:

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

Overrides:
See:

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.

Overrides:

async update(rate, shape, delay, feedback, intensity, opt updateTime, opt timeConstant) → {Promise.<boolean>}
effects/Chorus.mjs, line 122

Updates the Chorus effect according to the specified parameters 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
rate number

Frequency at which an oscillator modulates the delayed chorus signal in Hertz between [0, 10]
shape string

Waveform shape used to modulate the delayed chorus signal from ['sine', 'square', 'sawtooth', 'triangle']
delay number

Number of seconds delay between the original signal and the modulated chorus signal between [0.0001, 0.1]
feedback number

Percentage of processed signal to be fed back into the chorus circuit between [0, 0.95]
intensity number

Amount of modulation to apply as a percentage between [0, 1]
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

Overrides:

static getParameters() → {Array.<EffectParameter>}
effects/Chorus.mjs, line 84

Returns a list of all available parameters for manipulation in the effectOptions parameter of the update() function for this Effect.

Returns:
Array.<EffectParameter> -

List of effect-specific parameters for use in the effect's update() function

See: