AudioEffectsFeature interface

Balíček:

@azure/communication-calling

Poznámka

Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.

Rozhraní API pro funkci AudioEffects

Extends

AudioStreamFeature

Vlastnosti

activeEffects

Objekt jen pro čtení, který představuje aktuální aktivní zvukové efekty

Zděděné vlastnosti

name	Název funkce.

Metody

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)	Metoda, která zkontroluje, jestli je v aktuálním prostředí podporovaný efekt.
off("effectsError", AudioEffectsFeatureErrorListener)	Funkce zrušení odběru – aktivuje se při chybě při používání efektů.
off("effectsStarted", AudioEffectsFeatureListener)	Funkce pro odhlášení odběru – aktivuje se při spuštění efektů.
off("effectsStopped", AudioEffectsFeatureListener)	Funkce pro zrušení odběru – aktivuje se při zastavení efektů.
on("effectsError", AudioEffectsFeatureErrorListener)	Přihlášení k odběru funkcí – aktivuje se při chybě při používání efektů.
on("effectsStarted", AudioEffectsFeatureListener)	Přihlášení k odběru funkcí – aktivuje se při spuštění efektů.
on("effectsStopped", AudioEffectsFeatureListener)	Přihlášení k odběru funkcí – aktivuje se při zastavení efektů.
startEffects(AudioEffectsStartConfig)	Počáteční efekty
stopEffects(AudioEffectsStopConfig)	Efekty Stop

Zděděné metody

dispose()

Podrobnosti vlastnosti

activeEffects

Objekt jen pro čtení, který představuje aktuální aktivní zvukové efekty

activeEffects: ActiveAudioEffects

Hodnota vlastnosti

ActiveAudioEffects

Podrobnosti zděděných vlastností

name

Název funkce.

name: string

Hodnota vlastnosti

string

Zděděno zAudioStreamFeature.name

Podrobnosti metody

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

Poznámka

Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.

Metoda, která zkontroluje, jestli je v aktuálním prostředí podporovaný efekt.

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

Parametry

effect

"BrowserNoiseSuppression" | DeepNoiseSuppressionEffect

Instance efektu nebo "Browser". účinek, který chcete zkontrolovat podporu.

Návraty

Promise<boolean>

true, pokud je v aktuálním prostředí podporován efekt.

off("effectsError", AudioEffectsFeatureErrorListener)

Funkce zrušení odběru – aktivuje se při chybě při používání efektů.

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

Parametry

event

"effectsError"

Událost typu AudioEffectsFeatureEvent

listener

AudioEffectsFeatureErrorListener

Zpětné volání naslouchacího procesu

off("effectsStarted", AudioEffectsFeatureListener)

Funkce pro odhlášení odběru – aktivuje se při spuštění efektů.

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

Parametry

event

"effectsStarted"

Událost typu AudioEffectsFeatureEvent

listener

AudioEffectsFeatureListener

Zpětné volání naslouchacího procesu

off("effectsStopped", AudioEffectsFeatureListener)

Funkce pro zrušení odběru – aktivuje se při zastavení efektů.

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

Parametry

event

"effectsStopped"

Událost typu AudioEffectsFeatureEvent

listener

AudioEffectsFeatureListener

Zpětné volání naslouchacího procesu

on("effectsError", AudioEffectsFeatureErrorListener)

Přihlášení k odběru funkcí – aktivuje se při chybě při používání efektů.

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

Parametry

event

"effectsError"

Událost typu AudioEffectsFeatureEvent

listener

AudioEffectsFeatureErrorListener

Zpětné volání naslouchacího procesu

on("effectsStarted", AudioEffectsFeatureListener)

Přihlášení k odběru funkcí – aktivuje se při spuštění efektů.

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

Parametry

event

"effectsStarted"

Událost typu AudioEffectsFeatureEvent

listener

AudioEffectsFeatureListener

Zpětné volání naslouchacího procesu

on("effectsStopped", AudioEffectsFeatureListener)

Přihlášení k odběru funkcí – aktivuje se při zastavení efektů.

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

Parametry

event

"effectsStopped"

Událost typu AudioEffectsFeatureEvent

listener

AudioEffectsFeatureListener

Zpětné volání naslouchacího procesu

startEffects(AudioEffectsStartConfig)

Počáteční efekty

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

Parametry

audioEffects

AudioEffectsStartConfig

Objekt představující zvukové efekty, které se mají spustit

Návraty

Promise<void>

stopEffects(AudioEffectsStopConfig)

Efekty Stop

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

Parametry

audioEffects

AudioEffectsStopConfig

Návraty

Promise<void>

Podrobnosti zděděných metod

dispose()

function dispose()

Zděděno zAudioStreamFeature.dispose