AudioEffectsFeature interface

Read-only object that represents the current active audio effects

activeEffects: ActiveAudioEffects

Property Value

The feature name.

name: string

Property Value

Inherited From AudioStreamFeature.name

Method to check if an effect is supported in the current environment.

function isSupported(effect: "BrowserNoiseSuppression" | DeepNoiseSuppressionEffect): Promise<boolean>

Parameters

Returns

true if effect is supported in the current environment.

Unsubscribe functions - fires on error while using effects

function off(event: "effectsError", listener: AudioEffectsFeatureErrorListener)

Parameters

Unsubscribe functions - fires when effects are started

function off(event: "effectsStarted", listener: AudioEffectsFeatureListener)

Parameters

Unsubscribe functions - fires when effects are stopped

function off(event: "effectsStopped", listener: AudioEffectsFeatureListener)

Parameters

Subscribe functions - fires on error while using effects

function on(event: "effectsError", listener: AudioEffectsFeatureErrorListener)

Parameters

Subscribe functions - fires when effects are started

function on(event: "effectsStarted", listener: AudioEffectsFeatureListener)

Parameters

Subscribe functions - fires when effects are stopped

function on(event: "effectsStopped", listener: AudioEffectsFeatureListener)

Parameters

Start effects

function startEffects(audioEffects: AudioEffectsStartConfig): Promise<void>

Parameters

Returns

Stop effects

function stopEffects(audioEffects: AudioEffectsStopConfig): Promise<void>

Parameters

Returns

function dispose()

Inherited From AudioStreamFeature.dispose