LocalAudioStream class

参考

包:: @azure/communication-calling

表示本地 michrophone 设备的本地音频流

构造函数

LocalAudioStream(AudioDeviceInfo)	创建本地音频流
LocalAudioStream(MediaStream)

属性

mediaStreamType	获取此 LocalAudioStream 的媒体流类型
source	获取此 LocalAudioStream 的当前音频源

方法

dispose()	当 CallOptions 中未提供 LocalAudioStream 对象时，需要调用释放
feature<TFeature>(AudioStreamFeatureFactory<TFeature>)	使用扩展 API 检索已初始化和备忘录化的功能对象。检查对象 Features.* 中是否有此包中的所有可用扩展功能。当前支持 - Features.AudioEffects
getMediaStream()	获取媒体流。
getVolume()	需要在 audioSourceChanged 上调用 getVolume 以获取绑定到新源的新卷对象
off("audioSourceChanged", AudioSourceChangedEvent)	取消订阅 audioSourceChanged 事件的函数。
on("audioSourceChanged", AudioSourceChangedEvent)	订阅 audioSourceChanged 事件的函数。
setMediaStream(MediaStream)	切换到使用其他音频流
switchSource(AudioDeviceInfo)	切换到使用其他音频源

构造函数详细信息

LocalAudioStream(AudioDeviceInfo)

创建本地音频流

new LocalAudioStream(source: AudioDeviceInfo)

参数

source: AudioDeviceInfo

要使用的麦克风或媒体流源。

LocalAudioStream(MediaStream)

new LocalAudioStream(source: MediaStream)

参数

source: MediaStream

属性详细信息

mediaStreamType

获取此 LocalAudioStream 的媒体流类型

MediaStreamType mediaStreamType

属性值

MediaStreamType

source

获取此 LocalAudioStream 的当前音频源

AudioDeviceInfo source

属性值

AudioDeviceInfo

方法详细信息

dispose()

当 CallOptions 中未提供 LocalAudioStream 对象时，需要调用释放

function dispose()

feature<TFeature>(AudioStreamFeatureFactory<TFeature>)

使用扩展 API 检索已初始化和备忘录化的功能对象。检查对象 Features.* 中是否有此包中的所有可用扩展功能。当前支持 - Features.AudioEffects

function feature<TFeature>(factory: AudioStreamFeatureFactory<TFeature>): TFeature

参数

factory: AudioStreamFeatureFactory<TFeature>

提供扩展 API 的音频流功能构造函数的工厂

TFeature

getMediaStream()

获取媒体流。

function getMediaStream(): Promise<MediaStream>

Promise<MediaStream>

getVolume()

需要在 audioSourceChanged 上调用 getVolume 以获取绑定到新源的新卷对象

function getVolume(): Promise<Volume>

Promise<Volume>

off("audioSourceChanged", AudioSourceChangedEvent)

取消订阅 audioSourceChanged 事件的函数。

function off(event: "audioSourceChanged", listener: AudioSourceChangedEvent)

参数

event: "audioSourceChanged"

事件名称。

listener: AudioSourceChangedEvent

用于订阅此事件的回调 fn。

on("audioSourceChanged", AudioSourceChangedEvent)

订阅 audioSourceChanged 事件的函数。

function on(event: "audioSourceChanged", listener: AudioSourceChangedEvent)

参数

event: "audioSourceChanged"

事件名称。

listener: AudioSourceChangedEvent

将在音频源更改时调用的回调 fn。

setMediaStream(MediaStream)

切换到使用其他音频流

function setMediaStream(source: MediaStream): Promise<void>

参数

source: MediaStream

要使用的新音频流。

Promise<void>

switchSource(AudioDeviceInfo)

切换到使用其他音频源

function switchSource(source: AudioDeviceInfo): Promise<void>

参数

source: AudioDeviceInfo

要使用的新音频源。