VideoEffectsFeature interface

Paquete:

@azure/communication-calling

Interfaz de API para la característica VideoEffects

Extends

VideoStreamFeature

Propiedades

activeEffects

Lista de efectos activos actuales

Propiedades heredadas

name	Nombre de la característica.

Métodos

isSupported(VideoEffectProcessor)	Método para comprobar si se admite un efecto en el entorno actual.
off("effectsError", VideoEffectsFeatureErrorListener)	Funciones de cancelación de la suscripción: effectsError
off("effectsStarted", VideoEffectsFeatureListener)	Funciones de cancelación de la suscripción: effectsStarted
off("effectsStopped", VideoEffectsFeatureListener)	Funciones de cancelación de la suscripción: efectos Detenidos
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)	Funciones de cancelación de suscripción: fpsWarningThresholdReached
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)	Cancelar la suscripción de funciones: timeForEffectsWarningReached
on("effectsError", VideoEffectsFeatureErrorListener)	Funciones de suscripción: se desencadena en caso de error al usar efectos
on("effectsStarted", VideoEffectsFeatureListener)	Funciones de suscripción: se activa cuando se inician los efectos
on("effectsStopped", VideoEffectsFeatureListener)	Funciones de suscripción: se desencadena cuando se detienen los efectos
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)	Funciones de suscripción: se desencadena cuando el fps de secuencia es igual o menor que el valor de "fpsWarningThreshold".
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)	Funciones de suscripción: se desencadena cuando el tiempo necesario para iniciar efectos es mayor que el valor "effectInitTimeThresholdInMs".
startEffects(VideoEffectProcessor)	Efectos de inicio
stopEffects()	Efectos de detención

Métodos heredados

dispose()

Detalles de las propiedades

activeEffects

Lista de efectos activos actuales

activeEffects: VideoEffectName[]

Valor de propiedad

VideoEffectName[]

Detalles de las propiedades heredadas

name

Nombre de la característica.

name: string

Valor de propiedad

string

heredado deVideoStreamFeature.name

Detalles del método

isSupported(VideoEffectProcessor)

Método para comprobar si se admite un efecto en el entorno actual.

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

Parámetros

effect

VideoEffectProcessor

Instancia del efecto del que se va a comprobar la compatibilidad.

Devoluciones

Promise<boolean>

true si se admite el efecto en el entorno actual.

off("effectsError", VideoEffectsFeatureErrorListener)

Funciones de cancelación de la suscripción: effectsError

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

Parámetros

event

"effectsError"

Evento de tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureErrorListener

Devolución de llamada de un agente de escucha

off("effectsStarted", VideoEffectsFeatureListener)

Funciones de cancelación de la suscripción: effectsStarted

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

Parámetros

event

"effectsStarted"

Evento de tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Devolución de llamada de un agente de escucha

off("effectsStopped", VideoEffectsFeatureListener)

Funciones de cancelación de la suscripción: efectos Detenidos

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

Parámetros

event

"effectsStopped"

Evento de tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Devolución de llamada de un agente de escucha

off("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Funciones de cancelación de suscripción: fpsWarningThresholdReached

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

Parámetros

event

"fpsWarningThresholdReached"

Evento de tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Devolución de llamada de un agente de escucha

off("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Cancelar la suscripción de funciones: timeForEffectsWarningReached

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

Parámetros

event

"timeForEffectsWarningReached"

Evento de tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Devolución de llamada de un agente de escucha

on("effectsError", VideoEffectsFeatureErrorListener)

Funciones de suscripción: se desencadena en caso de error al usar efectos

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

Parámetros

event

"effectsError"

Evento de tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureErrorListener

Devolución de llamada de un agente de escucha

on("effectsStarted", VideoEffectsFeatureListener)

Funciones de suscripción: se activa cuando se inician los efectos

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

Parámetros

event

"effectsStarted"

Evento de tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Devolución de llamada de un agente de escucha

on("effectsStopped", VideoEffectsFeatureListener)

Funciones de suscripción: se desencadena cuando se detienen los efectos

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

Parámetros

event

"effectsStopped"

Evento de tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Devolución de llamada de un agente de escucha

on("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Funciones de suscripción: se desencadena cuando el fps de secuencia es igual o menor que el valor de "fpsWarningThreshold".

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

Parámetros

event

"fpsWarningThresholdReached"

Evento de tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Devolución de llamada de un agente de escucha

on("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Funciones de suscripción: se desencadena cuando el tiempo necesario para iniciar efectos es mayor que el valor "effectInitTimeThresholdInMs".

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

Parámetros

event

"timeForEffectsWarningReached"

Evento de tipo VideoEffectsFeatureEvent

listener

VideoEffectsFeatureListener

Devolución de llamada de un agente de escucha

startEffects(VideoEffectProcessor)

Efectos de inicio

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

Parámetros

effect

VideoEffectProcessor

Instancia del efecto

Devoluciones

Promise<void>

stopEffects()

Efectos de detención

function stopEffects(): Promise<void>

Devoluciones

Promise<void>

Detalles de los métodos heredados

dispose()

function dispose()

heredado deVideoStreamFeature.dispose