AudioEffectsFeature interface

套件:

@azure/communication-calling

AudioEffects 功能的 API 介面

Extends

AudioStreamFeature

屬性

activeEffects

代表目前使用中音訊效果的唯讀物件

繼承的屬性

name

功能名稱。

方法

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)	檢查目前環境中是否支援效果的方法。
off("effectsError", AudioEffectsFeatureErrorListener)	取消訂閱函式 - 在使用效果時引發錯誤
off("effectsStarted", AudioEffectsFeatureListener)	取消訂閱函式 - 啟動效果時引發
off("effectsStopped", AudioEffectsFeatureListener)	取消訂閱函式 - 停止效果時引發
on("effectsError", AudioEffectsFeatureErrorListener)	訂閱函式 - 使用效果時發生錯誤
on("effectsStarted", AudioEffectsFeatureListener)	訂閱函式 - 啟動效果時引發
on("effectsStopped", AudioEffectsFeatureListener)	訂閱函式 - 停止效果時引發
startEffects(AudioEffectsStartConfig)	開始效果
stopEffects(AudioEffectsStopConfig)	停止效果

繼承的方法

dispose()

屬性詳細資料

activeEffects

代表目前使用中音訊效果的唯讀物件

activeEffects: ActiveAudioEffects

屬性值

ActiveAudioEffects

繼承的屬性詳細資料

name

功能名稱。

name: string

屬性值

string

繼承自AudioStreamFeature.name

方法詳細資料

isSupported("BrowserNoiseSuppression" | DeepNoiseSuppressionEffect)

檢查目前環境中是否支援效果的方法。

function isSupported(effect: "BrowserNoiseSuppression" | DeepNoiseSuppressionEffect): Promise<boolean>

參數

effect

"BrowserNoiseSuppression" | DeepNoiseSuppressionEffect

效果或 'Browser.' 的實例。 用來檢查 支援的效果。

傳回

Promise<boolean>

如果目前環境中支援效果，則為 true。

off("effectsError", AudioEffectsFeatureErrorListener)

取消訂閱函式 - 在使用效果時引發錯誤

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

參數

event

"effectsError"

AudioEffectsFeatureEvent 類型的事件

listener

AudioEffectsFeatureErrorListener

接聽程式回呼

off("effectsStarted", AudioEffectsFeatureListener)

取消訂閱函式 - 啟動效果時引發

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

參數

event

"effectsStarted"

AudioEffectsFeatureEvent 類型的事件

listener

AudioEffectsFeatureListener

接聽程式回呼

off("effectsStopped", AudioEffectsFeatureListener)

取消訂閱函式 - 停止效果時引發

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

參數

event

"effectsStopped"

AudioEffectsFeatureEvent 類型的事件

listener

AudioEffectsFeatureListener

接聽程式回呼

on("effectsError", AudioEffectsFeatureErrorListener)

訂閱函式 - 使用效果時發生錯誤

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

參數

event

"effectsError"

AudioEffectsFeatureEvent 類型的事件

listener

AudioEffectsFeatureErrorListener

接聽程式回呼

on("effectsStarted", AudioEffectsFeatureListener)

訂閱函式 - 啟動效果時引發

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

參數

event

"effectsStarted"

AudioEffectsFeatureEvent 類型的事件

listener

AudioEffectsFeatureListener

接聽程式回呼

on("effectsStopped", AudioEffectsFeatureListener)

訂閱函式 - 停止效果時引發

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

參數

event

"effectsStopped"

AudioEffectsFeatureEvent 類型的事件

listener

AudioEffectsFeatureListener

接聽程式回呼

startEffects(AudioEffectsStartConfig)

開始效果

function startEffects(audioEffects: AudioEffectsStartConfig): Promise<void>

參數

audioEffects

AudioEffectsStartConfig

物件，表示要啟動的音訊效果

傳回

Promise<void>

stopEffects(AudioEffectsStopConfig)

停止效果

function stopEffects(audioEffects: AudioEffectsStopConfig): Promise<void>

參數

audioEffects

AudioEffectsStopConfig

傳回

Promise<void>

繼承的方法的詳細資料

dispose()

function dispose()

繼承自AudioStreamFeature.dispose