VideoEffectsFeature interface

Balíček:

@azure/communication-calling

Rozhraní API pro funkci VideoEffects

Extends

VideoStreamFeature

Vlastnosti

activeEffects

Seznam aktuálních aktivních efektů

Zděděné vlastnosti

name	Název funkce.

Metody

isSupported(VideoEffectProcessor)	Metoda pro kontrolu, jestli je v aktuálním prostředí podporovaný efekt.
off("effectsError", VideoEffectsFeatureErrorListener)	Funkce pro odhlášení odběru – effectsError
off("effectsStarted", VideoEffectsFeatureListener)	Funkce pro odhlášení odběru – effectsStarted
off("effectsStopped", VideoEffectsFeatureListener)	Funkce pro odhlášení odběru – efektyStopped
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)	Funkce pro odhlášení odběru – fpsWarningThresholdReached
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)	Funkce odhlášení odběru – timeForEffectsWarningReached
on("effectsError", VideoEffectsFeatureErrorListener)	Přihlášení k odběru funkcí – aktivuje se při chybě při používání efektů.
on("effectsStarted", VideoEffectsFeatureListener)	Přihlášení k odběru funkcí – aktivuje se při spuštění efektů.
on("effectsStopped", VideoEffectsFeatureListener)	Přihlášení k odběru funkcí – aktivuje se, když se zastaví efekty.
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)	Přihlásit funkce – aktivuje se, když je hodnota fps streamu rovna nebo menší než hodnota fpsWarningThreshold.
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)	Přihlášení funkcí – aktivuje se, když je doba potřebná k zahájení efektů delší než hodnota effectInitTimeThresholdInMs.
startEffects(VideoEffectProcessor)	Počáteční efekty
stopEffects()	Efekty Zastavení

Zděděné metody

dispose()

Podrobnosti vlastnosti

activeEffects

Seznam aktuálních aktivních efektů

activeEffects: VideoEffectName[]

Hodnota vlastnosti

VideoEffectName[]

Podrobnosti zděděných vlastností

name

Název funkce.

name: string

Hodnota vlastnosti

string

Zděděno zVideoStreamFeature.name

Podrobnosti metody

isSupported(VideoEffectProcessor)

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

function isSupported(effect: VideoEffectProcessor): Promise<boolean>

Parametry

effect

VideoEffectProcessor

Instance efektu, který chcete zkontrolovat podporu.

Návraty

Promise<boolean>

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

off("effectsError", VideoEffectsFeatureErrorListener)

Funkce pro odhlášení odběru – effectsError

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

Parametry

event

"effectsError"

Událost typu VideoEffectsFeatureEvent

listener

VideoEffectsFeatureErrorListener

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

off("effectsStarted", VideoEffectsFeatureListener)

Funkce pro odhlášení odběru – effectsStarted

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

Parametry

event

"effectsStarted"

Událost typu VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

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

off("effectsStopped", VideoEffectsFeatureListener)

Funkce pro odhlášení odběru – efektyStopped

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

Parametry

event

"effectsStopped"

Událost typu VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

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

off("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Funkce pro odhlášení odběru – fpsWarningThresholdReached

function off(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)

Parametry

event

"fpsWarningThresholdReached"

Událost typu VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

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

off("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Funkce odhlášení odběru – timeForEffectsWarningReached

function off(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)

Parametry

event

"timeForEffectsWarningReached"

Událost typu VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

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

on("effectsError", VideoEffectsFeatureErrorListener)

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

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

Parametry

event

"effectsError"

Událost typu VideoEffectsFeatureEvent

listener

VideoEffectsFeatureErrorListener

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

on("effectsStarted", VideoEffectsFeatureListener)

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

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

Parametry

event

"effectsStarted"

Událost typu VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

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

on("effectsStopped", VideoEffectsFeatureListener)

Přihlášení k odběru funkcí – aktivuje se, když se zastaví efekty.

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

Parametry

event

"effectsStopped"

Událost typu VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

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

on("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Přihlásit funkce – aktivuje se, když je hodnota fps streamu rovna nebo menší než hodnota fpsWarningThreshold.

function on(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)

Parametry

event

"fpsWarningThresholdReached"

Událost typu VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

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

on("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Přihlášení funkcí – aktivuje se, když je doba potřebná k zahájení efektů delší než hodnota effectInitTimeThresholdInMs.

function on(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)

Parametry

event

"timeForEffectsWarningReached"

Událost typu VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

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

startEffects(VideoEffectProcessor)

Počáteční efekty

function startEffects(effect: VideoEffectProcessor): Promise<void>

Parametry

effect

VideoEffectProcessor

Instance efektu

Návraty

Promise<void>

stopEffects()

Efekty Zastavení

function stopEffects(): Promise<void>

Návraty

Promise<void>

Podrobnosti zděděných metod

dispose()

function dispose()

Zděděno zVideoStreamFeature.dispose