AudioEffectsFeature interface

  • Reference
Package:
@azure/communication-calling

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

API interface for the AudioEffects feature

Extends
AudioStreamFeature

Properties

activeEffects

Read-only object that represents the current active audio effects

Inherited Properties

name

The feature name.

Methods

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Method to check if an effect is supported in the current environment.
off("effectsError", AudioEffectsFeatureErrorListener)

Unsubscribe functions - fires on error while using effects
off("effectsStarted", AudioEffectsFeatureListener)

Unsubscribe functions - fires when effects are started
off("effectsStopped", AudioEffectsFeatureListener)

Unsubscribe functions - fires when effects are stopped
on("effectsError", AudioEffectsFeatureErrorListener)

Subscribe functions - fires on error while using effects
on("effectsStarted", AudioEffectsFeatureListener)

Subscribe functions - fires when effects are started
on("effectsStopped", AudioEffectsFeatureListener)

Subscribe functions - fires when effects are stopped
startEffects(AudioEffectsStartConfig)

Start effects
stopEffects(AudioEffectsStopConfig)

Stop effects

Inherited Methods

dispose()

Property Details

activeEffects

Read-only object that represents the current active audio effects

activeEffects: ActiveAudioEffects

Property Value

ActiveAudioEffects

Inherited Property Details

name

The feature name.

name: string

Property Value

string

Inherited From AudioStreamFeature.name

Method Details

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

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

Parameters

effect

"BrowserNoiseSuppression" | DeepNoiseSuppressionEffect

Instance of the effect or the 'Browser..' effect to check support of.

Returns

Promise<boolean>

true if effect is supported in the current environment.

off("effectsError", AudioEffectsFeatureErrorListener)

Unsubscribe functions - fires on error while using effects

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

Parameters

event

"effectsError"

Event of type AudioEffectsFeatureEvent

listener
AudioEffectsFeatureErrorListener

A listener callback

off("effectsStarted", AudioEffectsFeatureListener)

Unsubscribe functions - fires when effects are started

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

Parameters

event

"effectsStarted"

Event of type AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

A listener callback

off("effectsStopped", AudioEffectsFeatureListener)

Unsubscribe functions - fires when effects are stopped

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

Parameters

event

"effectsStopped"

Event of type AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

A listener callback

on("effectsError", AudioEffectsFeatureErrorListener)

Subscribe functions - fires on error while using effects

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

Parameters

event

"effectsError"

Event of type AudioEffectsFeatureEvent

listener
AudioEffectsFeatureErrorListener

A listener callback

on("effectsStarted", AudioEffectsFeatureListener)

Subscribe functions - fires when effects are started

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

Parameters

event

"effectsStarted"

Event of type AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

A listener callback

on("effectsStopped", AudioEffectsFeatureListener)

Subscribe functions - fires when effects are stopped

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

Parameters

event

"effectsStopped"

Event of type AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

A listener callback

startEffects(AudioEffectsStartConfig)

Start effects

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

Parameters

audioEffects
AudioEffectsStartConfig

Object representing the audio effects to start

Returns

Promise<void>

stopEffects(AudioEffectsStopConfig)

Stop effects

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

Parameters

audioEffects
AudioEffectsStopConfig

Returns

Promise<void>

Inherited Method Details

dispose() 

function dispose()

Inherited From AudioStreamFeature.dispose