VideoEffectsFeature interface

Interfaccia API per la funzionalità VideoEffects

Extends

Proprietà

activeEffects

Elenco degli effetti attivi correnti

Proprietà ereditate

name

Nome della funzionalità.

Metodi

isSupported(VideoEffectProcessor)

Metodo per verificare se un effetto è supportato nell'ambiente corrente.

off("effectsError", VideoEffectsFeatureErrorListener)

Funzioni di annullamento della sottoscrizione - effectsError

off("effectsStarted", VideoEffectsFeatureListener)

Annullare la sottoscrizione delle funzioni - effectsStarted

off("effectsStopped", VideoEffectsFeatureListener)

Annullare la sottoscrizione delle funzioni - effectsStopped

off("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Funzioni di annullamento della sottoscrizione - fpsWarningThresholdReached

off("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Funzioni di annullamento della sottoscrizione - timeForEffectsWarningReached

on("effectsError", VideoEffectsFeatureErrorListener)

Sottoscrivi le funzioni: genera un errore durante l'uso degli effetti

on("effectsStarted", VideoEffectsFeatureListener)

Sottoscrivi le funzioni: viene attivato all'avvio degli effetti

on("effectsStopped", VideoEffectsFeatureListener)

Funzioni di sottoscrizione: viene attivato quando gli effetti vengono arrestati

on("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Sottoscrivi le funzioni: viene attivato quando il fps del flusso è uguale a/minore del valore "fpsWarningThreshold"

on("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Sottoscrivi le funzioni: viene generato quando il tempo impiegato per iniziare gli effetti è maggiore del valore 'effectInitTimeThresholdInMs'

startEffects(VideoEffectProcessor)

Effetti iniziali

stopEffects()

Effetti di arresto

Metodi ereditati

dispose()

Dettagli proprietà

activeEffects

Elenco degli effetti attivi correnti

activeEffects: VideoEffectName[]

Valore della proprietà

Dettagli proprietà ereditate

name

Nome della funzionalità.

name: string

Valore della proprietà

string

ereditato daVideoStreamFeature.name

Dettagli metodo

isSupported(VideoEffectProcessor)

Metodo per verificare se un effetto è supportato nell'ambiente corrente.

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

Parametri

effect
VideoEffectProcessor

Istanza dell'effetto di cui controllare il supporto.

Restituisce

Promise<boolean>

true se l'effetto è supportato nell'ambiente corrente.

off("effectsError", VideoEffectsFeatureErrorListener)

Funzioni di annullamento della sottoscrizione - effectsError

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

Parametri

event

"effectsError"

Evento di tipo VideoEffectsFeatureEvent

listener
VideoEffectsFeatureErrorListener

Callback del listener

off("effectsStarted", VideoEffectsFeatureListener)

Annullare la sottoscrizione delle funzioni - effectsStarted

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

Parametri

event

"effectsStarted"

Evento di tipo VideoEffectsFeatureEvent

listener
VideoEffectsFeatureListener

Callback del listener

off("effectsStopped", VideoEffectsFeatureListener)

Annullare la sottoscrizione delle funzioni - effectsStopped

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

Parametri

event

"effectsStopped"

Evento di tipo VideoEffectsFeatureEvent

listener
VideoEffectsFeatureListener

Callback del listener

off("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Funzioni di annullamento della sottoscrizione - fpsWarningThresholdReached

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

Parametri

event

"fpsWarningThresholdReached"

Evento di tipo VideoEffectsFeatureEvent

listener
VideoEffectsFeatureListener

Callback del listener

off("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Funzioni di annullamento della sottoscrizione - timeForEffectsWarningReached

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

Parametri

event

"timeForEffectsWarningReached"

Evento di tipo VideoEffectsFeatureEvent

listener
VideoEffectsFeatureListener

Callback del listener

on("effectsError", VideoEffectsFeatureErrorListener)

Sottoscrivi le funzioni: genera un errore durante l'uso degli effetti

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

Parametri

event

"effectsError"

Evento di tipo VideoEffectsFeatureEvent

listener
VideoEffectsFeatureErrorListener

Callback del listener

on("effectsStarted", VideoEffectsFeatureListener)

Sottoscrivi le funzioni: viene attivato all'avvio degli effetti

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

Parametri

event

"effectsStarted"

Evento di tipo VideoEffectsFeatureEvent

listener
VideoEffectsFeatureListener

Callback del listener

on("effectsStopped", VideoEffectsFeatureListener)

Funzioni di sottoscrizione: viene attivato quando gli effetti vengono arrestati

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

Parametri

event

"effectsStopped"

Evento di tipo VideoEffectsFeatureEvent

listener
VideoEffectsFeatureListener

Callback del listener

on("fpsWarningThresholdReached", VideoEffectsFeatureListener)

Sottoscrivi le funzioni: viene attivato quando il fps del flusso è uguale a/minore del valore "fpsWarningThreshold"

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

Parametri

event

"fpsWarningThresholdReached"

Evento di tipo VideoEffectsFeatureEvent

listener
VideoEffectsFeatureListener

Callback del listener

on("timeForEffectsWarningReached", VideoEffectsFeatureListener)

Sottoscrivi le funzioni: viene generato quando il tempo impiegato per iniziare gli effetti è maggiore del valore 'effectInitTimeThresholdInMs'

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

Parametri

event

"timeForEffectsWarningReached"

Evento di tipo VideoEffectsFeatureEvent

listener
VideoEffectsFeatureListener

Callback del listener

startEffects(VideoEffectProcessor)

Effetti iniziali

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

Parametri

effect
VideoEffectProcessor

Istanza dell'effetto

Restituisce

Promise<void>

stopEffects()

Effetti di arresto

function stopEffects(): Promise<void>

Restituisce

Promise<void>

Dettagli dei metodi ereditati

dispose()

function dispose()

ereditato daVideoStreamFeature.dispose