AudioEffectsFeature interface

包:

@azure/communication-calling

AudioEffects 功能的 API 接口

扩展

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