VideoEffectsFeature interface
API-Schnittstelle für das VideoEffects-Feature
- Extends
Eigenschaften
| active |
Liste der aktuellen aktiven Effekte |
Geerbte Eigenschaften
| name | Der Featurename. |
Methoden
| is |
Methode, um zu überprüfen, ob ein Effekt in der aktuellen Umgebung unterstützt wird. |
| off("effects |
Abmelden von Funktionen – effectsError |
| off("effects |
Abmelden von Funktionen – effectsStarted |
| off("effects |
Abmelden von Funktionen – effectsStopped |
| off("fps |
Abonnementfunktionen – fpsWarningThresholdReached |
| off("time |
Abonnementfunktionen – timeForEffectsWarningReached |
| on("effects |
Abonnieren von Funktionen – wird beim Verwenden von Effekten auf Fehler ausgelöst |
| on("effects |
Abonnieren von Funktionen – wird ausgelöst, wenn Effekte gestartet werden |
| on("effects |
Abonnieren von Funktionen – wird ausgelöst, wenn Effekte beendet werden |
| on("fps |
Subscribe functions - fires when the stream fps is equal to/less than 'fpsWarningThreshold' value |
| on("time |
Abonnieren von Funktionen – wird ausgelöst, wenn die Zeit für den Start von Effekten mehr als der Wert "effectInitTimeThresholdInMs" ist. |
| start |
Starteffekte |
| stop |
Stoppeffekte |
Geerbte Methoden
| dispose() |
Details zur Eigenschaft
activeEffects
Liste der aktuellen aktiven Effekte
activeEffects: VideoEffectName[]Eigenschaftswert
Geerbte Eigenschaftsdetails
name
Details zur Methode
isSupported(VideoEffectProcessor)
Methode, um zu überprüfen, ob ein Effekt in der aktuellen Umgebung unterstützt wird.
function isSupported(effect: VideoEffectProcessor): Promise<boolean>Parameter
- effect
- VideoEffectProcessor
Instanz des Effekts zur Überprüfung der Unterstützung.
Gibt zurück
Promise<boolean>
"true", wenn der Effekt in der aktuellen Umgebung unterstützt wird.
off("effectsError", VideoEffectsFeatureErrorListener)
Abmelden von Funktionen – effectsError
function off(event: "effectsError", listener: VideoEffectsFeatureErrorListener)Parameter
- event
-
"effectsError"
Ereignis vom Typ "VideoEffectsFeatureEvent"
- listener
- VideoEffectsFeatureErrorListener
Ein Listenerrückruf
off("effectsStarted", VideoEffectsFeatureListener)
Abmelden von Funktionen – effectsStarted
function off(event: "effectsStarted", listener: VideoEffectsFeatureListener)Parameter
- event
-
"effectsStarted"
Ereignis vom Typ "VideoEffectsFeatureEvent"
- listener
- VideoEffectsFeatureListener
Ein Listenerrückruf
off("effectsStopped", VideoEffectsFeatureListener)
Abmelden von Funktionen – effectsStopped
function off(event: "effectsStopped", listener: VideoEffectsFeatureListener)Parameter
- event
-
"effectsStopped"
Ereignis vom Typ "VideoEffectsFeatureEvent"
- listener
- VideoEffectsFeatureListener
Ein Listenerrückruf
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)
Abonnementfunktionen – fpsWarningThresholdReached
function off(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)Parameter
- event
-
"fpsWarningThresholdReached"
Ereignis vom Typ "VideoEffectsFeatureEvent"
- listener
- VideoEffectsFeatureListener
Ein Listenerrückruf
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)
Abonnementfunktionen – timeForEffectsWarningReached
function off(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)Parameter
- event
-
"timeForEffectsWarningReached"
Ereignis vom Typ "VideoEffectsFeatureEvent"
- listener
- VideoEffectsFeatureListener
Ein Listenerrückruf
on("effectsError", VideoEffectsFeatureErrorListener)
Abonnieren von Funktionen – wird beim Verwenden von Effekten auf Fehler ausgelöst
function on(event: "effectsError", listener: VideoEffectsFeatureErrorListener)Parameter
- event
-
"effectsError"
Ereignis vom Typ "VideoEffectsFeatureEvent"
- listener
- VideoEffectsFeatureErrorListener
Ein Listenerrückruf
on("effectsStarted", VideoEffectsFeatureListener)
Abonnieren von Funktionen – wird ausgelöst, wenn Effekte gestartet werden
function on(event: "effectsStarted", listener: VideoEffectsFeatureListener)Parameter
- event
-
"effectsStarted"
Ereignis vom Typ "VideoEffectsFeatureEvent"
- listener
- VideoEffectsFeatureListener
Ein Listenerrückruf
on("effectsStopped", VideoEffectsFeatureListener)
Abonnieren von Funktionen – wird ausgelöst, wenn Effekte beendet werden
function on(event: "effectsStopped", listener: VideoEffectsFeatureListener)Parameter
- event
-
"effectsStopped"
Ereignis vom Typ "VideoEffectsFeatureEvent"
- listener
- VideoEffectsFeatureListener
Ein Listenerrückruf
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)
Subscribe functions - fires when the stream fps is equal to/less than 'fpsWarningThreshold' value
function on(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)Parameter
- event
-
"fpsWarningThresholdReached"
Ereignis vom Typ "VideoEffectsFeatureEvent"
- listener
- VideoEffectsFeatureListener
Ein Listenerrückruf
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)
Abonnieren von Funktionen – wird ausgelöst, wenn die Zeit für den Start von Effekten mehr als der Wert "effectInitTimeThresholdInMs" ist.
function on(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)Parameter
- event
-
"timeForEffectsWarningReached"
Ereignis vom Typ "VideoEffectsFeatureEvent"
- listener
- VideoEffectsFeatureListener
Ein Listenerrückruf
startEffects(VideoEffectProcessor)
Starteffekte
function startEffects(effect: VideoEffectProcessor): Promise<void>Parameter
- effect
- VideoEffectProcessor
Instanz des Effekts
Gibt zurück
Promise<void>
stopEffects()
Stoppeffekte
function stopEffects(): Promise<void>Gibt zurück
Promise<void>
Details zur geerbten Methode
dispose()
function dispose()geerbt vonVideoStreamFeature.dispose