VideoEffectsFeature interface

当前活动效果列表

activeEffects: VideoEffectName[]

属性值

功能名称。

name: string

属性值

继承自VideoStreamFeature.name 的

检查当前环境中是否支持效果的方法。

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

参数

返回

如果当前环境中支持效果，则为 true。

取消订阅函数 - effectsError

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

参数

取消订阅函数 - effectsStarted

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

参数

取消订阅函数 - effectsStopped

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

参数

取消订阅函数 - fpsWarningThresholdReached

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

参数

取消订阅函数 - timeForEffectsWarningReached

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

参数

订阅函数 - 在使用效果时触发错误

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

参数

订阅函数 - 在启动效果时触发

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

参数

订阅函数 - 在停止效果时触发

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

参数

订阅函数 - 当 stream fps 等于/小于“fpsWarningThreshold”值时触发

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

参数

订阅函数 - 当启动效果所需的时间大于“effectInitTimeThresholdInMs”值时触发

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

参数

开始效果

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

参数

返回

停止效果

function stopEffects(): Promise<void>

返回

function dispose()

继承自VideoStreamFeature.dispose