AudioEffectsFeature interface

Pakket:

@azure/communication-calling

API-interface voor de functie AudioEffects

Uitbreiding

AudioStreamFeature

Eigenschappen

activeEffects

Alleen-lezenobject dat de huidige actieve audio-effecten vertegenwoordigt

Overgenomen eigenschappen

name	De functienaam.

Methoden

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)	Methode om te controleren of een effect wordt ondersteund in de huidige omgeving.
off("effectsError", AudioEffectsFeatureErrorListener)	Afmeldingsfuncties: wordt geactiveerd bij fouten tijdens het gebruik van effecten
off("effectsStarted", AudioEffectsFeatureListener)	Afmeldingsfuncties - brandt wanneer effecten worden gestart
off("effectsStopped", AudioEffectsFeatureListener)	Afmeldingsfuncties - brandt wanneer effecten worden gestopt
on("effectsError", AudioEffectsFeatureErrorListener)	Abonneren functies - wordt geactiveerd op fout tijdens het gebruik van effecten
on("effectsStarted", AudioEffectsFeatureListener)	Functies abonneren - wordt geactiveerd wanneer effecten worden gestart
on("effectsStopped", AudioEffectsFeatureListener)	Abonneren functies - wordt geactiveerd wanneer effecten worden gestopt
startEffects(AudioEffectsStartConfig)	Begineffecten
stopEffects(AudioEffectsStopConfig)	Effecten stoppen

Overgenomen methoden

dispose()

Eigenschapdetails

activeEffects

Alleen-lezenobject dat de huidige actieve audio-effecten vertegenwoordigt

activeEffects: ActiveAudioEffects

Waarde van eigenschap

ActiveAudioEffects

Details van overgenomen eigenschap

name

De functienaam.

name: string

Waarde van eigenschap

string

overgenomen vanAudioStreamFeature.name

Methodedetails

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Methode om te controleren of een effect wordt ondersteund in de huidige omgeving.

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

Parameters

effect

"BrowserNoiseSuppression" | DeepNoiseSuppressionEffect

Exemplaar van het effect of de browser.' effect om de ondersteuning van te controleren.

Retouren

Promise<boolean>

waar als effect wordt ondersteund in de huidige omgeving.

off("effectsError", AudioEffectsFeatureErrorListener)

Afmeldingsfuncties: wordt geactiveerd bij fouten tijdens het gebruik van effecten

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

Parameters

event

"effectsError"

Gebeurtenis van het type AudioEffectsFeatureEvent

listener

AudioEffectsFeatureErrorListener

Een callback van een listener

off("effectsStarted", AudioEffectsFeatureListener)

Afmeldingsfuncties - brandt wanneer effecten worden gestart

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

Parameters

event

"effectsStarted"

Gebeurtenis van het type AudioEffectsFeatureEvent

listener

AudioEffectsFeatureListener

Een callback van een listener

off("effectsStopped", AudioEffectsFeatureListener)

Afmeldingsfuncties - brandt wanneer effecten worden gestopt

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

Parameters

event

"effectsStopped"

Gebeurtenis van het type AudioEffectsFeatureEvent

listener

AudioEffectsFeatureListener

Een callback van een listener

on("effectsError", AudioEffectsFeatureErrorListener)

Abonneren functies - wordt geactiveerd op fout tijdens het gebruik van effecten

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

Parameters

event

"effectsError"

Gebeurtenis van het type AudioEffectsFeatureEvent

listener

AudioEffectsFeatureErrorListener

Een callback van een listener

on("effectsStarted", AudioEffectsFeatureListener)

Functies abonneren - wordt geactiveerd wanneer effecten worden gestart

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

Parameters

event

"effectsStarted"

Gebeurtenis van het type AudioEffectsFeatureEvent

listener

AudioEffectsFeatureListener

Een callback van een listener

on("effectsStopped", AudioEffectsFeatureListener)

Abonneren functies - wordt geactiveerd wanneer effecten worden gestopt

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

Parameters

event

"effectsStopped"

Gebeurtenis van het type AudioEffectsFeatureEvent

listener

AudioEffectsFeatureListener

Een callback van een listener

startEffects(AudioEffectsStartConfig)

Begineffecten

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

Parameters

audioEffects

AudioEffectsStartConfig

Object dat de audio-effecten aangeeft die moeten worden gestart

Retouren

Promise<void>

stopEffects(AudioEffectsStopConfig)

Effecten stoppen

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

Parameters

audioEffects

AudioEffectsStopConfig

Retouren

Promise<void>

Details overgenomen methode

dispose()

function dispose()

overgenomen vanAudioStreamFeature.dispose