Extends

• EffectBase

Classes

Doppler

Doppler

Members

audioContext :AudioContext

effects/EffectBase.mjs, line 6

Overrides:

• EffectBase#audioContext

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:

• EffectBase#currentParameterValues

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:

• EffectBase#getInputNode

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

Overrides:

• EffectBase#getOutputNode

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.

Overrides:

• EffectBase#load

async update(initDistance, finalDistance, missDistance, duration, opt updateTime, opt timeConstant) → {Promise.<boolean>}

effects/Doppler.mjs, line 80

Updates the Doppler 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
initDistance	number		Starting distance in meters between an audio source and an observer
finalDistance	number		Final distance in meters between an audio source and an observer
missDistance	number		Distance in meters by which the audio source misses the observer
duration	number		Duration in seconds required for the audio source to travel from its starting to final location
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:

• EffectBase#update

static getParameters() → {Array.<EffectParameter>}

effects/Doppler.mjs, line 47

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:

• EffectParameter