VideoEffectsFeature interface

Pacote:

@azure/communication-calling

Interface de API para o recurso VideoEffects

Extends

VideoStreamFeature

Propriedades

activeEffects

Lista de efeitos ativos atuais

Propriedades herdadas

name	O nome do recurso.

Métodos

isSupported(VideoEffectProcessor)	Método para verificar se há suporte para um efeito no ambiente atual.
off("effectsError", VideoEffectsFeatureErrorListener)	Cancelar assinatura de funções – effectsError
off("effectsStarted", VideoEffectsFeatureListener)	Cancelar assinatura de funções – effectsStarted
off("effectsStopped", VideoEffectsFeatureListener)	Funções de cancelamento de assinatura – effectsStopped
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)	Cancelar assinatura de funções – fpsWarningThresholdReached
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)	Cancelar assinatura de funções – timeForEffectsWarningReached
on("effectsError", VideoEffectsFeatureErrorListener)	Funções de assinatura – aciona o erro ao usar efeitos
on("effectsStarted", VideoEffectsFeatureListener)	Funções de assinatura – é acionada quando os efeitos são iniciados
on("effectsStopped", VideoEffectsFeatureListener)	Funções de assinatura – é acionada quando os efeitos são interrompidos
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)	Funções de assinatura – é acionada quando os fps de fluxo são iguais/menores que o valor de 'fpsWarningThreshold'
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)	Funções de assinatura – aciona quando o tempo necessário para iniciar efeitos é maior do que o valor 'effectInitTimeThresholdInMs'
startEffects(VideoEffectProcessor)	Efeitos de início
stopEffects()	Efeitos de parada

Métodos herdados

dispose()

Detalhes da propriedade

activeEffects

Lista de efeitos ativos atuais

activeEffects: VideoEffectName[]

Valor da propriedade

VideoEffectName[]

Detalhes das propriedades herdadas

name

O nome do recurso.

name: string

Valor da propriedade

string

herdado deVideoStreamFeature.name

Detalhes do método

isSupported(VideoEffectProcessor)

Método para verificar se há suporte para um efeito no ambiente atual.

function isSupported(effect: VideoEffectProcessor): Promise<boolean>

Parâmetros

effect

VideoEffectProcessor

Instância do efeito da qual verificar o suporte.

Retornos

Promise<boolean>

true se houver suporte para efeito no ambiente atual.

off("effectsError", VideoEffectsFeatureErrorListener)

Cancelar assinatura 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 assinatura – 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)

Cancelar assinatura de funções – 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 assinatura 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 – aciona o 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 assinatura – é acionada 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 assinatura – é acionada 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 – é acionada quando os fps de fluxo são iguais/menores que o valor de '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 – aciona quando o tempo necessário para iniciar 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

Instância do efeito

Retornos

Promise<void>

stopEffects()

Efeitos de parada

function stopEffects(): Promise<void>

Retornos

Promise<void>

Detalhes do método herdado

dispose()

function dispose()

Herdado deVideoStreamFeature.dispose