Udostępnij za pośrednictwem

AudioEffectsFeature interface

  • Odwołanie
Pakiet:
@azure/communication-calling

Interfejs API dla funkcji AudioEffects

Rozszerzenie
AudioStreamFeature

Właściwości

activeEffects

Obiekt tylko do odczytu reprezentujący bieżące aktywne efekty dźwiękowe

Właściwości dziedziczone

name

Nazwa funkcji.

Metody

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Metoda sprawdzania, czy efekt jest obsługiwany w bieżącym środowisku.
off("effectsError", AudioEffectsFeatureErrorListener)

Anuluj subskrypcję funkcji — uruchamia się po błędzie podczas korzystania z efektów
off("effectsStarted", AudioEffectsFeatureListener)

Anuluj subskrypcję funkcji — uruchamia się po uruchomieniu efektów
off("effectsStopped", AudioEffectsFeatureListener)

Funkcje anulowania subskrypcji — wyzwalane po zatrzymaniu efektów
on("effectsError", AudioEffectsFeatureErrorListener)

Funkcje subskrybowania — uruchamia się po błędzie podczas korzystania z efektów
on("effectsStarted", AudioEffectsFeatureListener)

Funkcje subskrybowania — wyzwalane po uruchomieniu efektów
on("effectsStopped", AudioEffectsFeatureListener)

Funkcje subskrybowania — wyzwalane po zatrzymaniu efektów
startEffects(AudioEffectsStartConfig)

Efekty początkowe
stopEffects(AudioEffectsStopConfig)

Efekty zatrzymania

Metody dziedziczone

dispose()

Szczegóły właściwości

activeEffects

Obiekt tylko do odczytu reprezentujący bieżące aktywne efekty dźwiękowe

activeEffects: ActiveAudioEffects

Wartość właściwości

ActiveAudioEffects

Szczegóły właściwości dziedziczonej

name

Nazwa funkcji.

name: string

Wartość właściwości

string

dziedziczone zAudioStreamFeature.name

Szczegóły metody

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Metoda sprawdzania, czy efekt jest obsługiwany w bieżącym środowisku.

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

Parametry

effect

"BrowserNoiseSuppression" | DeepNoiseSuppressionEffect

Wystąpienie efektu lub "Przeglądarka". efektu w celu sprawdzenia obsługi.

Zwraca

Promise<boolean>

wartość true, jeśli efekt jest obsługiwany w bieżącym środowisku.

off("effectsError", AudioEffectsFeatureErrorListener)

Anuluj subskrypcję funkcji — uruchamia się po błędzie podczas korzystania z efektów

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

Parametry

event

"effectsError"

Zdarzenie typu AudioEffectsFeatureEvent

listener
AudioEffectsFeatureErrorListener

Wywołanie zwrotne odbiornika

off("effectsStarted", AudioEffectsFeatureListener)

Anuluj subskrypcję funkcji — uruchamia się po uruchomieniu efektów

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

Parametry

event

"effectsStarted"

Zdarzenie typu AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Wywołanie zwrotne odbiornika

off("effectsStopped", AudioEffectsFeatureListener)

Funkcje anulowania subskrypcji — wyzwalane po zatrzymaniu efektów

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

Parametry

event

"effectsStopped"

Zdarzenie typu AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Wywołanie zwrotne odbiornika

on("effectsError", AudioEffectsFeatureErrorListener)

Funkcje subskrybowania — uruchamia się po błędzie podczas korzystania z efektów

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

Parametry

event

"effectsError"

Zdarzenie typu AudioEffectsFeatureEvent

listener
AudioEffectsFeatureErrorListener

Wywołanie zwrotne odbiornika

on("effectsStarted", AudioEffectsFeatureListener)

Funkcje subskrybowania — wyzwalane po uruchomieniu efektów

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

Parametry

event

"effectsStarted"

Zdarzenie typu AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Wywołanie zwrotne odbiornika

on("effectsStopped", AudioEffectsFeatureListener)

Funkcje subskrybowania — wyzwalane po zatrzymaniu efektów

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

Parametry

event

"effectsStopped"

Zdarzenie typu AudioEffectsFeatureEvent

listener
AudioEffectsFeatureListener

Wywołanie zwrotne odbiornika

startEffects(AudioEffectsStartConfig)

Efekty początkowe

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

Parametry

audioEffects
AudioEffectsStartConfig

Obiekt reprezentujący efekty dźwiękowe do uruchomienia

Zwraca

Promise<void>

stopEffects(AudioEffectsStopConfig)

Efekty zatrzymania

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

Parametry

audioEffects
AudioEffectsStopConfig

Zwraca

Promise<void>

Szczegóły metody dziedziczonej

dispose() 

function dispose()

dziedziczone zAudioStreamFeature.dispose