VideoEffectsFeature interface

API-gränssnitt för funktionen VideoEffects

Extends

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)

Funktioner för att avbryta prenumeration – effectsError

off("effectsStarted", VideoEffectsFeatureListener)

Funktioner för att avbryta prenumerationen – effekterStartat

off("effectsStopped", VideoEffectsFeatureListener)

Funktioner för att avbryta prenumerationen – effekter Toppade

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 effekterna 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()

Stoppeffekter

Ärvda metoder

dispose()

Egenskapsinformation

activeEffects

Lista över aktuella aktiva effekter

activeEffects: VideoEffectName[]

Egenskapsvärde

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)

Funktioner för att avbryta prenumeration – effectsError

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

Parametrar

event

"effectsError"

Händelse av typen VideoEffectsFeatureEvent

listener
VideoEffectsFeatureErrorListener

Ett återanrop 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 återanrop till lyssnaren

off("effectsStopped", VideoEffectsFeatureListener)

Funktioner för att avbryta prenumerationen – effekter Toppade

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

Parametrar

event

"effectsStopped"

Händelse av typen VideoEffectsFeatureEvent

listener
VideoEffectsFeatureListener

Ett återanrop 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 återanrop 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 återanrop 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 återanrop 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 återanrop till lyssnaren

on("effectsStopped", VideoEffectsFeatureListener)

Prenumerationsfunktioner – utlöses när effekterna stoppas

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

Parametrar

event

"effectsStopped"

Händelse av typen VideoEffectsFeatureEvent

listener
VideoEffectsFeatureListener

Ett återanrop 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 återanrop 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 återanrop till lyssnaren

startEffects(VideoEffectProcessor)

Starteffekter

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

Parametrar

effect
VideoEffectProcessor

Instans av effekten

Returer

Promise<void>

stopEffects()

Stoppeffekter

function stopEffects(): Promise<void>

Returer

Promise<void>

Ärvd metodinformation

dispose()

function dispose()

ärvs frånVideoStreamFeature.dispose