VideoEffectsFeature interface

Paket:

@azure/communication-calling

API-gränssnittet för funktionen VideoEffects

Extends

VideoStreamFeature

Egenskaper

activeEffects

Lista över aktuella aktiva effekter

Ärvda egenskaper

name	Funktionsnamnet.

Metoder

isSupported(VideoEffectProcessor)	Metod för att kontrollera om en effekt stöds i den aktuella miljön.
off("effectsError", VideoEffectsFeatureErrorListener)	Avsluta prenumerationsfunktioner – effectsError
off("effectsStarted", VideoEffectsFeatureListener)	Funktioner för att avbryta prenumerationen – effekterStartat
off("effectsStopped", VideoEffectsFeatureListener)	Funktioner för att avbryta prenumerationen – effekter Som toppas
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)	Funktioner för att avbryta prenumerationen – fpsWarningThresholdReached
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)	Avsluta prenumerationsfunktioner – timeForEffectsWarningReached
on("effectsError", VideoEffectsFeatureErrorListener)	Prenumerationsfunktioner – utlöses vid fel vid användning av effekter
on("effectsStarted", VideoEffectsFeatureListener)	Prenumerationsfunktioner – utlöses när effekter startas
on("effectsStopped", VideoEffectsFeatureListener)	Prenumerationsfunktioner – utlöses när effekter stoppas
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)	Prenumerationsfunktioner – utlöses när dataströmmens fps är lika med/mindre än värdet "fpsWarningThreshold"
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)	Prenumerationsfunktioner – utlöses när den tid det tar att starta effekter är mer än värdet "effectInitTimeThresholdInMs"
startEffects(VideoEffectProcessor)	Starteffekter
stopEffects()	Stoppa effekter

Ärvda metoder

dispose()

Egenskapsinformation

activeEffects

Lista över aktuella aktiva effekter

activeEffects: VideoEffectName[]

Egenskapsvärde

VideoEffectName[]

Information om ärvda egenskaper

name

Funktionsnamnet.

name: string

Egenskapsvärde

string

Ärvd frånVideoStreamFeature.name

Metodinformation

isSupported(VideoEffectProcessor)

Metod för att kontrollera om en effekt stöds i den aktuella miljön.

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

Parametrar

effect

VideoEffectProcessor

Instans av effekten för att kontrollera stödet för.

Returer

Promise<boolean>

sant om effekten stöds i den aktuella miljön.

off("effectsError", VideoEffectsFeatureErrorListener)

Avsluta prenumerationsfunktioner – effectsError

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

Parametrar

event

"effectsError"

Händelse av typen VideoEffectsFeatureEvent

listener

VideoEffectsFeatureErrorListener

Ett uppringningsanrop till lyssnaren

off("effectsStarted", VideoEffectsFeatureListener)

Funktioner för att avbryta prenumerationen – effekterStartat

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

Parametrar

event

"effectsStarted"

Händelse av typen VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Ett uppringningsanrop till lyssnaren

off("effectsStopped", VideoEffectsFeatureListener)

Funktioner för att avbryta prenumerationen – effekter Som toppas

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

Parametrar

event

"effectsStopped"

Händelse av typen VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Ett uppringningsanrop till lyssnaren

off("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Funktioner för att avbryta prenumerationen – fpsWarningThresholdReached

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

Parametrar

event

"fpsWarningThresholdReached"

Händelse av typen VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Ett uppringningsanrop till lyssnaren

off("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Avsluta prenumerationsfunktioner – timeForEffectsWarningReached

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

Parametrar

event

"timeForEffectsWarningReached"

Händelse av typen VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Ett uppringningsanrop till lyssnaren

on("effectsError", VideoEffectsFeatureErrorListener)

Prenumerationsfunktioner – utlöses vid fel vid användning av effekter

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

Parametrar

event

"effectsError"

Händelse av typen VideoEffectsFeatureEvent

listener

VideoEffectsFeatureErrorListener

Ett uppringningsanrop till lyssnaren

on("effectsStarted", VideoEffectsFeatureListener)

Prenumerationsfunktioner – utlöses när effekter startas

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

Parametrar

event

"effectsStarted"

Händelse av typen VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Ett uppringningsanrop till lyssnaren

on("effectsStopped", VideoEffectsFeatureListener)

Prenumerationsfunktioner – utlöses när effekter stoppas

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

Parametrar

event

"effectsStopped"

Händelse av typen VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Ett uppringningsanrop till lyssnaren

on("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Prenumerationsfunktioner – utlöses när dataströmmens fps är lika med/mindre än värdet "fpsWarningThreshold"

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

Parametrar

event

"fpsWarningThresholdReached"

Händelse av typen VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Ett uppringningsanrop till lyssnaren

on("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Prenumerationsfunktioner – utlöses när den tid det tar att starta effekter är mer än värdet "effectInitTimeThresholdInMs"

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

Parametrar

event

"timeForEffectsWarningReached"

Händelse av typen VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Ett uppringningsanrop till lyssnaren

startEffects(VideoEffectProcessor)

Starteffekter

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

Parametrar

effect

VideoEffectProcessor

Instans av effekten

Returer

Promise<void>

stopEffects()

Stoppa effekter

function stopEffects(): Promise<void>

Returer

Promise<void>

Ärvd metodinformation

dispose()

function dispose()

Ärvd frånVideoStreamFeature.dispose