VideoEffectsFeature interface
Interface API pour la fonctionnalité VideoEffects
- Extends
Propriétés
active |
Liste des effets actifs actuels |
Propriétés héritées
name | Nom de la fonctionnalité. |
Méthodes
is |
Méthode pour vérifier si un effet est pris en charge dans l’environnement actuel. |
off("effects |
Fonctions de désabonnement - effectsError |
off("effects |
Fonctions de désabonnement - effectsStarted |
off("effects |
Fonctions de désabonnement - effetsStopped |
off("fps |
Fonctions de désabonnement - fpsWarningThresholdReached |
off("time |
Fonctions de désabonnement - timeForEffectsWarningReached |
on("effects |
Fonctions d’abonnement : se déclenche en cas d’erreur lors de l’utilisation des effets |
on("effects |
Fonctions d’abonnement : se déclenche lorsque des effets sont démarrés |
on("effects |
Fonctions d’abonnement : se déclenche lorsque les effets sont arrêtés |
on("fps |
Fonctions d’abonnement : se déclenche lorsque le flux fps est égal à/inférieur à la valeur « fpsWarningThreshold » |
on("time |
Fonctions d’abonnement : se déclenche lorsque le temps nécessaire pour démarrer les effets est supérieur à la valeur ' effectInitTimeThresholdInMs' |
start |
Effets de début |
stop |
Arrêter les effets |
Méthodes héritées
dispose() |
Détails de la propriété
activeEffects
Liste des effets actifs actuels
activeEffects: VideoEffectName[]
Valeur de propriété
Détails de la propriété héritée
name
Détails de la méthode
isSupported(VideoEffectProcessor)
Méthode pour vérifier si un effet est pris en charge dans l’environnement actuel.
function isSupported(effect: VideoEffectProcessor): Promise<boolean>
Paramètres
- effect
- VideoEffectProcessor
Instance de l’effet pour vérifier la prise en charge de.
Retours
Promise<boolean>
true si l’effet est pris en charge dans l’environnement actuel.
off("effectsError", VideoEffectsFeatureErrorListener)
Fonctions de désabonnement - effectsError
function off(event: "effectsError", listener: VideoEffectsFeatureErrorListener)
Paramètres
- event
-
"effectsError"
Événement de type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureErrorListener
Rappel d’écouteur
off("effectsStarted", VideoEffectsFeatureListener)
Fonctions de désabonnement - effectsStarted
function off(event: "effectsStarted", listener: VideoEffectsFeatureListener)
Paramètres
- event
-
"effectsStarted"
Événement de type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Rappel d’écouteur
off("effectsStopped", VideoEffectsFeatureListener)
Fonctions de désabonnement - effetsStopped
function off(event: "effectsStopped", listener: VideoEffectsFeatureListener)
Paramètres
- event
-
"effectsStopped"
Événement de type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Rappel d’écouteur
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)
Fonctions de désabonnement - fpsWarningThresholdReached
function off(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)
Paramètres
- event
-
"fpsWarningThresholdReached"
Événement de type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Rappel d’écouteur
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)
Fonctions de désabonnement - timeForEffectsWarningReached
function off(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)
Paramètres
- event
-
"timeForEffectsWarningReached"
Événement de type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Rappel d’écouteur
on("effectsError", VideoEffectsFeatureErrorListener)
Fonctions d’abonnement : se déclenche en cas d’erreur lors de l’utilisation des effets
function on(event: "effectsError", listener: VideoEffectsFeatureErrorListener)
Paramètres
- event
-
"effectsError"
Événement de type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureErrorListener
Rappel d’écouteur
on("effectsStarted", VideoEffectsFeatureListener)
Fonctions d’abonnement : se déclenche lorsque des effets sont démarrés
function on(event: "effectsStarted", listener: VideoEffectsFeatureListener)
Paramètres
- event
-
"effectsStarted"
Événement de type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Rappel d’écouteur
on("effectsStopped", VideoEffectsFeatureListener)
Fonctions d’abonnement : se déclenche lorsque les effets sont arrêtés
function on(event: "effectsStopped", listener: VideoEffectsFeatureListener)
Paramètres
- event
-
"effectsStopped"
Événement de type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Rappel d’écouteur
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)
Fonctions d’abonnement : se déclenche lorsque le flux fps est égal à/inférieur à la valeur « fpsWarningThreshold »
function on(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)
Paramètres
- event
-
"fpsWarningThresholdReached"
Événement de type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Rappel d’écouteur
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)
Fonctions d’abonnement : se déclenche lorsque le temps nécessaire pour démarrer les effets est supérieur à la valeur ' effectInitTimeThresholdInMs'
function on(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)
Paramètres
- event
-
"timeForEffectsWarningReached"
Événement de type VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Rappel d’écouteur
startEffects(VideoEffectProcessor)
Effets de début
function startEffects(effect: VideoEffectProcessor): Promise<void>
Paramètres
- effect
- VideoEffectProcessor
Instance de l’effet
Retours
Promise<void>
stopEffects()
Arrêter les effets
function stopEffects(): Promise<void>
Retours
Promise<void>
Détails de la méthode héritée
dispose()
function dispose()
héritée deVideoStreamFeature.dispose