VideoEffectsFeature interface
API-interface voor de functie VideoEffects
- Uitbreiding
Eigenschappen
| active |
Lijst met huidige actieve effecten |
Overgenomen eigenschappen
| name | De functienaam. |
Methoden
| is |
Methode om te controleren of een effect wordt ondersteund in de huidige omgeving. |
| off("effects |
Afmeldingsfuncties - effectsError |
| off("effects |
Afmeldingsfuncties - effectenStarted |
| off("effects |
Afmeldingsfuncties - effectenStopped |
| off("fps |
Afmeldingsfuncties - fpsWarningThresholdReached |
| off("time |
Afmeldingsfuncties - timeForEffectsWarningReached |
| on("effects |
Abonneren functies - wordt geactiveerd op fout tijdens het gebruik van effecten |
| on("effects |
Functies abonneren - wordt geactiveerd wanneer effecten worden gestart |
| on("effects |
Abonneren functies - wordt geactiveerd wanneer effecten worden gestopt |
| on("fps |
Abonneren functies - wordt geactiveerd wanneer de stream fps gelijk is aan/kleiner dan 'fpsWarningThreshold' waarde |
| on("time |
Abonneren op functies- wordt geactiveerd wanneer de tijd die nodig is om effecten te starten meer is dan de waarde 'effectInitTimeThresholdInMs' |
| start |
Begineffecten |
| stop |
Effecten stoppen |
Overgenomen methoden
| dispose() |
Eigenschapdetails
activeEffects
Lijst met huidige actieve effecten
activeEffects: VideoEffectName[]Waarde van eigenschap
Details van overgenomen eigenschap
name
Methodedetails
isSupported(VideoEffectProcessor)
Methode om te controleren of een effect wordt ondersteund in de huidige omgeving.
function isSupported(effect: VideoEffectProcessor): Promise<boolean>Parameters
- effect
- VideoEffectProcessor
Instantie van het effect om de ondersteuning van te controleren.
Retouren
Promise<boolean>
waar als effect wordt ondersteund in de huidige omgeving.
off("effectsError", VideoEffectsFeatureErrorListener)
Afmeldingsfuncties - effectsError
function off(event: "effectsError", listener: VideoEffectsFeatureErrorListener)Parameters
- event
-
"effectsError"
Gebeurtenis van het type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureErrorListener
Een callback van een listener
off("effectsStarted", VideoEffectsFeatureListener)
Afmeldingsfuncties - effectenStarted
function off(event: "effectsStarted", listener: VideoEffectsFeatureListener)Parameters
- event
-
"effectsStarted"
Gebeurtenis van het type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Een callback van een listener
off("effectsStopped", VideoEffectsFeatureListener)
Afmeldingsfuncties - effectenStopped
function off(event: "effectsStopped", listener: VideoEffectsFeatureListener)Parameters
- event
-
"effectsStopped"
Gebeurtenis van het type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Een callback van een listener
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)
Afmeldingsfuncties - fpsWarningThresholdReached
function off(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)Parameters
- event
-
"fpsWarningThresholdReached"
Gebeurtenis van het type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Een callback van een listener
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)
Afmeldingsfuncties - timeForEffectsWarningReached
function off(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)Parameters
- event
-
"timeForEffectsWarningReached"
Gebeurtenis van het type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Een callback van een listener
on("effectsError", VideoEffectsFeatureErrorListener)
Abonneren functies - wordt geactiveerd op fout tijdens het gebruik van effecten
function on(event: "effectsError", listener: VideoEffectsFeatureErrorListener)Parameters
- event
-
"effectsError"
Gebeurtenis van het type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureErrorListener
Een callback van een listener
on("effectsStarted", VideoEffectsFeatureListener)
Functies abonneren - wordt geactiveerd wanneer effecten worden gestart
function on(event: "effectsStarted", listener: VideoEffectsFeatureListener)Parameters
- event
-
"effectsStarted"
Gebeurtenis van het type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Een callback van een listener
on("effectsStopped", VideoEffectsFeatureListener)
Abonneren functies - wordt geactiveerd wanneer effecten worden gestopt
function on(event: "effectsStopped", listener: VideoEffectsFeatureListener)Parameters
- event
-
"effectsStopped"
Gebeurtenis van het type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Een callback van een listener
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)
Abonneren functies - wordt geactiveerd wanneer de stream fps gelijk is aan/kleiner dan 'fpsWarningThreshold' waarde
function on(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)Parameters
- event
-
"fpsWarningThresholdReached"
Gebeurtenis van het type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Een callback van een listener
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)
Abonneren op functies- wordt geactiveerd wanneer de tijd die nodig is om effecten te starten meer is dan de waarde 'effectInitTimeThresholdInMs'
function on(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)Parameters
- event
-
"timeForEffectsWarningReached"
Gebeurtenis van het type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Een callback van een listener
startEffects(VideoEffectProcessor)
Begineffecten
function startEffects(effect: VideoEffectProcessor): Promise<void>Parameters
- effect
- VideoEffectProcessor
Exemplaar van het effect
Retouren
Promise<void>
stopEffects()
Effecten stoppen
function stopEffects(): Promise<void>Retouren
Promise<void>
Details overgenomen methode
dispose()
function dispose()overgenomen vanVideoStreamFeature.dispose