BandRejectFilter()

Class representing a Band-Reject Filter effect.

A Band-Reject Filter is defined by a lower and upper cutoff frequency between which audio signals are reduced or eliminated completely, while all frequencies outside of this range are allowed to pass without alteration.

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

Constructs a new BandRejectFilter effect object.

Extends

Classes

BandRejectFilter
BandRejectFilter

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(lowerCutoffFrequency, upperCutoffFrequency, opt updateTime, opt timeConstant) → {Promise.<boolean>}
effects/BandRejectFilter.mjs, line 69

Updates the BandRejectFilter 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
lowerCutoffFrequency number

Frequency above which audio content will be reduced between [1, 22050]
upperCutoffFrequency number

Frequency below which audio content will be reduced between [1, 22050]
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/BandRejectFilter.mjs, line 42

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: