DeviceManager interface

包:

@azure/communication-calling

设备管理器用于处理系统媒体设备，例如相机、麦克风和扬声器。

属性

isSpeakerSelectionAvailable	设备主机是否可以选择扬声器输出。
selectedMicrophone	正在使用的麦克风设备。
selectedSpeaker	正在使用的扬声器设备。

方法

askDevicePermission(PermissionConstraints)	显示浏览器提示，要求前端用户有权使用指定的设备。
getCameras()	获取要使用的可用视频设备的列表。
getMicrophones()	获取要使用的可用麦克风设备列表。
getSpeakers()	获取要使用的可用扬声器设备的列表。
off("audioDevicesUpdated", CollectionUpdatedEvent<AudioDeviceInfo>)	取消订阅 audioDevicesUpdated 事件的函数。
off("selectedMicrophoneChanged", PropertyChangedEvent)	取消订阅所选MicrophoneChanged 事件的函数。
off("selectedSpeakerChanged", PropertyChangedEvent)	取消订阅 selectedSpeakerChanged 事件的函数。
off("videoDevicesUpdated", CollectionUpdatedEvent<VideoDeviceInfo>)	取消订阅 videoDevicesUpdated 事件的函数。
on("audioDevicesUpdated", CollectionUpdatedEvent<AudioDeviceInfo>)	订阅 audioDevicesUpdated 的函数。
on("selectedMicrophoneChanged", PropertyChangedEvent)	为 selectedMicrophoneChanged 事件订阅函数。
on("selectedSpeakerChanged", PropertyChangedEvent)	订阅 selectedSpeakerChanged 事件的订阅函数。
on("videoDevicesUpdated", CollectionUpdatedEvent<VideoDeviceInfo>)	订阅 videoDevicesUpdated 事件的订阅函数。
selectMicrophone(AudioDeviceInfo)	选择要使用的麦克风设备。
selectSpeaker(AudioDeviceInfo)	选择要使用的扬声器设备。

属性详细信息

isSpeakerSelectionAvailable

设备主机是否可以选择扬声器输出。

isSpeakerSelectionAvailable: boolean

属性值

boolean

selectedMicrophone

正在使用的麦克风设备。

selectedMicrophone?: AudioDeviceInfo

属性值

AudioDeviceInfo

selectedSpeaker

正在使用的扬声器设备。

selectedSpeaker?: AudioDeviceInfo

属性值

AudioDeviceInfo

方法详细信息

askDevicePermission(PermissionConstraints)

显示浏览器提示，要求前端用户有权使用指定的设备。

function askDevicePermission(permissionConstraints: PermissionConstraints): Promise<DeviceAccess>

参数

permissionConstraints

PermissionConstraints

配置要请求的权限（音频/视频）。

返回

Promise<DeviceAccess>

用户授予的权限。

getCameras()

获取要使用的可用视频设备的列表。

function getCameras(): Promise<VideoDeviceInfo[]>

返回

Promise<VideoDeviceInfo[]>

getMicrophones()

获取要使用的可用麦克风设备列表。

function getMicrophones(): Promise<AudioDeviceInfo[]>

返回

Promise<AudioDeviceInfo[]>

getSpeakers()

获取要使用的可用扬声器设备的列表。

function getSpeakers(): Promise<AudioDeviceInfo[]>

返回

Promise<AudioDeviceInfo[]>

off("audioDevicesUpdated", CollectionUpdatedEvent<AudioDeviceInfo>)

取消订阅 audioDevicesUpdated 事件的函数。

function off(event: "audioDevicesUpdated", listener: CollectionUpdatedEvent<AudioDeviceInfo>)

参数

event

"audioDevicesUpdated"

事件名称。

listener

CollectionUpdatedEvent<AudioDeviceInfo>

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

off("selectedMicrophoneChanged", PropertyChangedEvent)

取消订阅所选MicrophoneChanged 事件的函数。

function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

参数

event

"selectedMicrophoneChanged"

事件名称。

listener

PropertyChangedEvent

回调 fn，将在此属性的值发生更改时调用。

off("selectedSpeakerChanged", PropertyChangedEvent)

取消订阅 selectedSpeakerChanged 事件的函数。

function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

参数

event

"selectedSpeakerChanged"

事件名称。

listener

PropertyChangedEvent

回调 fn，将在此属性的值发生更改时调用。

off("videoDevicesUpdated", CollectionUpdatedEvent<VideoDeviceInfo>)

取消订阅 videoDevicesUpdated 事件的函数。

function off(event: "videoDevicesUpdated", listener: CollectionUpdatedEvent<VideoDeviceInfo>)

参数

event

"videoDevicesUpdated"

事件名称。

listener

CollectionUpdatedEvent<VideoDeviceInfo>

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

on("audioDevicesUpdated", CollectionUpdatedEvent<AudioDeviceInfo>)

订阅 audioDevicesUpdated 的函数。

function on(event: "audioDevicesUpdated", listener: CollectionUpdatedEvent<AudioDeviceInfo>)

参数

event

"audioDevicesUpdated"

事件名称。

listener

CollectionUpdatedEvent<AudioDeviceInfo>

回调 fn，将在此集合更改时调用，它将传递已添加和删除元素的数组。

on("selectedMicrophoneChanged", PropertyChangedEvent)

为 selectedMicrophoneChanged 事件订阅函数。

function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

参数

event

"selectedMicrophoneChanged"

事件名称。

listener

PropertyChangedEvent

回调 fn，将在此属性的值发生更改时调用。

on("selectedSpeakerChanged", PropertyChangedEvent)

订阅 selectedSpeakerChanged 事件的订阅函数。

function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

参数

event

"selectedSpeakerChanged"

事件名称。

listener

PropertyChangedEvent

回调 fn，将在此属性的值发生更改时调用。

on("videoDevicesUpdated", CollectionUpdatedEvent<VideoDeviceInfo>)

订阅 videoDevicesUpdated 事件的订阅函数。

function on(event: "videoDevicesUpdated", listener: CollectionUpdatedEvent<VideoDeviceInfo>)

参数

event

"videoDevicesUpdated"

事件名称。

listener

CollectionUpdatedEvent<VideoDeviceInfo>

回调 fn，将在此集合更改时调用，它将传递已添加和删除元素的数组。

selectMicrophone(AudioDeviceInfo)

选择要使用的麦克风设备。

function selectMicrophone(microphoneDevice: AudioDeviceInfo): Promise<void>

参数

microphoneDevice

AudioDeviceInfo

麦克风设备信息。

返回

Promise<void>

selectSpeaker(AudioDeviceInfo)

选择要使用的扬声器设备。

function selectSpeaker(speakerDevice: AudioDeviceInfo): Promise<void>

参数

speakerDevice

AudioDeviceInfo

扬声器设备信息。

返回

Promise<void>