VideoEffectsFeature interface

套件:

@azure/communication-calling

VideoEffects 功能的 API 介面

Extends

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)	訂閱函式 - 當數據流 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)

訂閱函式 - 當數據流 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