VideoEffectsFeature interface
Interface de API para o recurso VideoEffects
- Extends
Propriedades
active |
Lista de efeitos ativos atuais |
Propriedades Herdadas
name | O nome do recurso. |
Métodos
is |
Método para verificar se um efeito é suportado no ambiente atual. |
off("effects |
Cancelar inscrição de funções - effectsError |
off("effects |
Cancelar assinatura de funções - effectsStarted |
off("effects |
Funções de cancelamento de inscrição - effectsStopped |
off("fps |
Funções de cancelamento de inscrição - fpsWarningThresholdReached |
off("time |
Cancelar inscrição de funções - timeForEffectsWarningReached |
on("effects |
Funções de assinatura - dispara em erro ao usar efeitos |
on("effects |
Funções de subscrição - incêndios quando os efeitos são iniciados |
on("effects |
Funções de subscrição - dispara quando os efeitos são interrompidos |
on("fps |
Funções de assinatura - é acionado quando o fluxo fps é igual a/menor que o valor 'fpsWarningThreshold' |
on("time |
Funções de assinatura - é acionado quando o tempo necessário para iniciar os efeitos é maior do que o valor 'effectInitTimeThresholdInMs' |
start |
Efeitos de início |
stop |
Efeitos finais |
Métodos Herdados
dispose() |
Detalhes de Propriedade
activeEffects
Lista de efeitos ativos atuais
activeEffects: VideoEffectName[]
Valor de Propriedade
Detalhes da Propriedade Herdada
name
Detalhes de Método
isSupported(VideoEffectProcessor)
Método para verificar se um efeito é suportado no ambiente atual.
function isSupported(effect: VideoEffectProcessor): Promise<boolean>
Parâmetros
- effect
- VideoEffectProcessor
Instância do efeito para verificar o suporte de.
Devoluções
Promise<boolean>
true se o efeito for suportado no ambiente atual.
off("effectsError", VideoEffectsFeatureErrorListener)
Cancelar inscrição de funções - effectsError
function off(event: "effectsError", listener: VideoEffectsFeatureErrorListener)
Parâmetros
- event
-
"effectsError"
Evento do tipo VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureErrorListener
Um retorno de chamada do ouvinte
off("effectsStarted", VideoEffectsFeatureListener)
Cancelar assinatura de funções - effectsStarted
function off(event: "effectsStarted", listener: VideoEffectsFeatureListener)
Parâmetros
- event
-
"effectsStarted"
Evento do tipo VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Um retorno de chamada do ouvinte
off("effectsStopped", VideoEffectsFeatureListener)
Funções de cancelamento de inscrição - effectsStopped
function off(event: "effectsStopped", listener: VideoEffectsFeatureListener)
Parâmetros
- event
-
"effectsStopped"
Evento do tipo VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Um retorno de chamada do ouvinte
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)
Funções de cancelamento de inscrição - fpsWarningThresholdReached
function off(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)
Parâmetros
- event
-
"fpsWarningThresholdReached"
Evento do tipo VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Um retorno de chamada do ouvinte
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)
Cancelar inscrição de funções - timeForEffectsWarningReached
function off(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)
Parâmetros
- event
-
"timeForEffectsWarningReached"
Evento do tipo VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Um retorno de chamada do ouvinte
on("effectsError", VideoEffectsFeatureErrorListener)
Funções de assinatura - dispara em erro ao usar efeitos
function on(event: "effectsError", listener: VideoEffectsFeatureErrorListener)
Parâmetros
- event
-
"effectsError"
Evento do tipo VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureErrorListener
Um retorno de chamada do ouvinte
on("effectsStarted", VideoEffectsFeatureListener)
Funções de subscrição - incêndios quando os efeitos são iniciados
function on(event: "effectsStarted", listener: VideoEffectsFeatureListener)
Parâmetros
- event
-
"effectsStarted"
Evento do tipo VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Um retorno de chamada do ouvinte
on("effectsStopped", VideoEffectsFeatureListener)
Funções de subscrição - dispara quando os efeitos são interrompidos
function on(event: "effectsStopped", listener: VideoEffectsFeatureListener)
Parâmetros
- event
-
"effectsStopped"
Evento do tipo VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Um retorno de chamada do ouvinte
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)
Funções de assinatura - é acionado quando o fluxo fps é igual a/menor que o valor 'fpsWarningThreshold'
function on(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)
Parâmetros
- event
-
"fpsWarningThresholdReached"
Evento do tipo VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Um retorno de chamada do ouvinte
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)
Funções de assinatura - é acionado quando o tempo necessário para iniciar os efeitos é maior do que o valor 'effectInitTimeThresholdInMs'
function on(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)
Parâmetros
- event
-
"timeForEffectsWarningReached"
Evento do tipo VideoEffectsFeatureEvent
- listener
- VideoEffectsFeatureListener
Um retorno de chamada do ouvinte
startEffects(VideoEffectProcessor)
Efeitos de início
function startEffects(effect: VideoEffectProcessor): Promise<void>
Parâmetros
- effect
- VideoEffectProcessor
Exemplo do efeito
Devoluções
Promise<void>
stopEffects()
Efeitos finais
function stopEffects(): Promise<void>
Devoluções
Promise<void>
Detalhes do Método Herdado
dispose()
function dispose()
herdado deVideoStreamFeature.dispose