VideoEffectsFeature interface

Pacote:

@azure/communication-calling

Interface de API para a funcionalidade VideoEffects

Extends

VideoStreamFeature

Propriedades

activeEffects

Lista de efeitos ativos atuais

Propriedades Herdadas

name	O nome da funcionalidade.

Métodos

isSupported(VideoEffectProcessor)	Método para verificar se um efeito é suportado no ambiente atual.
off("effectsError", VideoEffectsFeatureErrorListener)	Anular a subscrição de funções – effectsError
off("effectsStarted", VideoEffectsFeatureListener)	Anular a subscrição de funções – efeitosIniciados
off("effectsStopped", VideoEffectsFeatureListener)	Anular a subscrição de funções – efeitosTopped
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)	Anular a subscrição de funções - fpsWarningThresholdReached
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)	Anular a subscrição de funções – timeForEffectsWarningReached
on("effectsError", VideoEffectsFeatureErrorListener)	Funções de subscrição – aciona o erro ao utilizar efeitos
on("effectsStarted", VideoEffectsFeatureListener)	Funções de subscrição – aciona quando os efeitos são iniciados
on("effectsStopped", VideoEffectsFeatureListener)	Funções de subscrição – aciona quando os efeitos são parados
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)	Funções de subscrição – é acionada quando o fps de fluxo é igual/inferior ao valor "fpsWarningThreshold"
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)	Funções de subscrição – aciona quando o tempo necessário para iniciar efeitos é superior ao valor "effectInitTimeThresholdInMs"
startEffects(VideoEffectProcessor)	Efeitos de início
stopEffects()	Efeitos de paragem

Métodos Herdados

dispose()

Detalhes de Propriedade

activeEffects

Lista de efeitos ativos atuais

activeEffects: VideoEffectName[]

Valor de Propriedade

VideoEffectName[]

Detalhes da Propriedade Herdada

name

O nome da funcionalidade.

name: string

Valor de Propriedade

string

Herdado deVideoStreamFeature.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.

Devoluções

Promise<boolean>

true se o efeito for suportado no ambiente atual.

off("effectsError", VideoEffectsFeatureErrorListener)

Anular a subscrição de funções – effectsError

function off(event: "effectsError", listener: VideoEffectsFeatureErrorListener)

Parâmetros

event

"effectsError"

Evento do tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureErrorListener

Uma chamada de retorno do serviço de escuta

off("effectsStarted", VideoEffectsFeatureListener)

Anular a subscrição de funções – efeitosIniciados

function off(event: "effectsStarted", listener: VideoEffectsFeatureListener)

Parâmetros

event

"effectsStarted"

Evento do tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

off("effectsStopped", VideoEffectsFeatureListener)

Anular a subscrição de funções – efeitosTopped

function off(event: "effectsStopped", listener: VideoEffectsFeatureListener)

Parâmetros

event

"effectsStopped"

Evento do tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

off("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Anular a subscrição de funções - fpsWarningThresholdReached

function off(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)

Parâmetros

event

"fpsWarningThresholdReached"

Evento do tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

off("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Anular a subscrição de funções – timeForEffectsWarningReached

function off(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)

Parâmetros

event

"timeForEffectsWarningReached"

Evento do tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

on("effectsError", VideoEffectsFeatureErrorListener)

Funções de subscrição – aciona o erro ao utilizar efeitos

function on(event: "effectsError", listener: VideoEffectsFeatureErrorListener)

Parâmetros

event

"effectsError"

Evento do tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureErrorListener

Uma chamada de retorno do serviço de escuta

on("effectsStarted", VideoEffectsFeatureListener)

Funções de subscrição – aciona quando os efeitos são iniciados

function on(event: "effectsStarted", listener: VideoEffectsFeatureListener)

Parâmetros

event

"effectsStarted"

Evento do tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

on("effectsStopped", VideoEffectsFeatureListener)

Funções de subscrição – aciona quando os efeitos são parados

function on(event: "effectsStopped", listener: VideoEffectsFeatureListener)

Parâmetros

event

"effectsStopped"

Evento do tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

on("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Funções de subscrição – é acionada quando o fps de fluxo é igual/inferior ao valor "fpsWarningThreshold"

function on(event: "fpsWarningThresholdReached", listener: VideoEffectsFeatureListener)

Parâmetros

event

"fpsWarningThresholdReached"

Evento do tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

on("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Funções de subscrição – aciona quando o tempo necessário para iniciar efeitos é superior ao valor "effectInitTimeThresholdInMs"

function on(event: "timeForEffectsWarningReached", listener: VideoEffectsFeatureListener)

Parâmetros

event

"timeForEffectsWarningReached"

Evento do tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Uma chamada de retorno do serviço de escuta

startEffects(VideoEffectProcessor)

Efeitos de início

function startEffects(effect: VideoEffectProcessor): Promise<void>

Parâmetros

effect

VideoEffectProcessor

Instância do efeito

Devoluções

Promise<void>

stopEffects()

Efeitos de paragem

function stopEffects(): Promise<void>

Devoluções

Promise<void>

Detalhes do Método Herdado

dispose()

function dispose()

Herdado deVideoStreamFeature.dispose