VideoEffectsFeature interface

包:

@azure/communication-calling

VideoEffects 功能的 API 接口

扩展

VideoStreamFeature

属性

activeEffects

当前活动效果列表

继承属性

name

功能名称。

方法

isSupported(VideoEffectProcessor)	检查当前环境中是否支持效果的方法。
off("effectsError", VideoEffectsFeatureErrorListener)	取消订阅函数 - effectsError
off("effectsStarted", VideoEffectsFeatureListener)	取消订阅函数 - effectsStarted
off("effectsStopped", VideoEffectsFeatureListener)	取消订阅函数 - effectsStopped
off("fpsWarningThresholdReached", VideoEffectsFeatureListener)	取消订阅函数 - fpsWarningThresholdReached
off("timeForEffectsWarningReached", VideoEffectsFeatureListener)	取消订阅函数 - timeForEffectsWarningReached
on("effectsError", VideoEffectsFeatureErrorListener)	订阅函数 - 在使用效果时触发错误
on("effectsStarted", VideoEffectsFeatureListener)	订阅函数 - 在启动效果时触发
on("effectsStopped", VideoEffectsFeatureListener)	订阅函数 - 在停止效果时触发
on("fpsWarningThresholdReached", VideoEffectsFeatureListener)	订阅函数 - 当 stream fps 等于/小于“fpsWarningThreshold”值时触发
on("timeForEffectsWarningReached", VideoEffectsFeatureListener)	订阅函数 - 当启动效果所需的时间大于“effectInitTimeThresholdInMs”值时触发
startEffects(VideoEffectProcessor)	开始效果
stopEffects()	停止效果

继承的方法

dispose()

属性详细信息

activeEffects

当前活动效果列表

activeEffects: VideoEffectName[]

属性值

VideoEffectName[]

继承属性详细信息

name

功能名称。

name: string

属性值

string

继承自VideoStreamFeature.name 的

方法详细信息

isSupported(VideoEffectProcessor)

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

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

参数

effect

VideoEffectProcessor

要检查其支持的效果的实例。

返回

Promise<boolean>

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

off("effectsError", VideoEffectsFeatureErrorListener)

取消订阅函数 - effectsError

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

参数

event

"effectsError"

VideoEffectsFeatureEvent 类型的事件

listener

VideoEffectsFeatureErrorListener

侦听器回调

off("effectsStarted", VideoEffectsFeatureListener)

取消订阅函数 - effectsStarted

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

参数

event

"effectsStarted"

VideoEffectsFeatureEvent 类型的事件

listener

VideoEffectsFeatureListener

侦听器回调

off("effectsStopped", VideoEffectsFeatureListener)

取消订阅函数 - effectsStopped

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

参数

event

"effectsStopped"

VideoEffectsFeatureEvent 类型的事件

listener

VideoEffectsFeatureListener

侦听器回调

off("fpsWarningThresholdReached", VideoEffectsFeatureListener)

取消订阅函数 - fpsWarningThresholdReached

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

参数

event

"fpsWarningThresholdReached"

VideoEffectsFeatureEvent 类型的事件

listener

VideoEffectsFeatureListener

侦听器回调

off("timeForEffectsWarningReached", VideoEffectsFeatureListener)

取消订阅函数 - timeForEffectsWarningReached

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

参数

event

"timeForEffectsWarningReached"

VideoEffectsFeatureEvent 类型的事件

listener

VideoEffectsFeatureListener

侦听器回调

on("effectsError", VideoEffectsFeatureErrorListener)

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

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

参数

event

"effectsError"

VideoEffectsFeatureEvent 类型的事件

listener

VideoEffectsFeatureErrorListener

侦听器回调

on("effectsStarted", VideoEffectsFeatureListener)

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

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

参数

event

"effectsStarted"

VideoEffectsFeatureEvent 类型的事件

listener

VideoEffectsFeatureListener

侦听器回调

on("effectsStopped", VideoEffectsFeatureListener)

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

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

参数

event

"effectsStopped"

VideoEffectsFeatureEvent 类型的事件

listener

VideoEffectsFeatureListener

侦听器回调

on("fpsWarningThresholdReached", VideoEffectsFeatureListener)

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

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

参数

event

"fpsWarningThresholdReached"

VideoEffectsFeatureEvent 类型的事件

listener

VideoEffectsFeatureListener

侦听器回调

on("timeForEffectsWarningReached", VideoEffectsFeatureListener)

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

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

参数

event

"timeForEffectsWarningReached"

VideoEffectsFeatureEvent 类型的事件

listener

VideoEffectsFeatureListener

侦听器回调

startEffects(VideoEffectProcessor)

开始效果

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

参数

effect

VideoEffectProcessor

效果的实例

返回

Promise<void>

stopEffects()

停止效果

function stopEffects(): Promise<void>

返回

Promise<void>

继承的方法详细信息

dispose()

function dispose()

继承自VideoStreamFeature.dispose