StatefulDeviceManager interface

包:

@azure/communication-react

定义由有状态在 <xref:%40azure%2Fcommunication-calling%23DeviceManager>之上添加的其他方法。

扩展

DeviceManager

属性

getUnparentedVideoStreams	获取无父视频流的列表。 这是尚未添加到 的视频 <xref:%40azure%2Fcommunication-calling%23Call>流列表。 这对于希望在开始通话之前与渲染的视频流进行交互的开发人员非常有用。 另请参阅 <xref:%40azure%2Fcommunication-react%23CallClient.createView>。
selectCamera	在 DeviceManagerState中设置 selectedCamera。 这是完全由开发人员驱动的，不会以任何方式绑定到 <xref:%40azure%2Fcommunication-calling%23DeviceManager>。 它完全包含在 StatefulDeviceManager中。 另请参阅 <xref:DeviceManagerState.selectedCamera>。

继承属性

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)	选择要使用的扬声器设备。
startPreheatDevices(StartPreheatDeviceParameters)	启动预热设备。
stopPreheatDevices(StopPreheatDeviceParameters)	停止预热设备。

属性详细信息

getUnparentedVideoStreams

获取无父视频流的列表。 这是尚未添加到 的视频 <xref:%40azure%2Fcommunication-calling%23Call>流列表。 这对于希望在开始通话之前与渲染的视频流进行交互的开发人员非常有用。 另请参阅 <xref:%40azure%2Fcommunication-react%23CallClient.createView>。

public getUnparentedVideoStreams: () => LocalVideoStream[]

属性值

() => LocalVideoStream[]

selectCamera

在 DeviceManagerState中设置 selectedCamera。 这是完全由开发人员驱动的，不会以任何方式绑定到 <xref:%40azure%2Fcommunication-calling%23DeviceManager>。 它完全包含在 StatefulDeviceManager中。 另请参阅 <xref:DeviceManagerState.selectedCamera>。

selectCamera: (device: VideoDeviceInfo) => void

属性值

(device: VideoDeviceInfo) => void

继承属性详细信息

isSpeakerSelectionAvailable

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

isSpeakerSelectionAvailable: boolean

属性值

boolean

继承自 DeviceManager.isSpeakerSelectionAvailable

selectedMicrophone

正在使用的麦克风设备。

selectedMicrophone?: AudioDeviceInfo

属性值

AudioDeviceInfo

继承自 DeviceManager.selectedMicrophone

selectedSpeaker

正在使用的扬声器设备。

selectedSpeaker?: AudioDeviceInfo

属性值

AudioDeviceInfo

继承自 DeviceManager.selectedSpeaker

继承的方法详细信息

askDevicePermission(PermissionConstraints)

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

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

参数

permissionConstraints

PermissionConstraints

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

返回

Promise<DeviceAccess>

用户授予的权限。

继承自 DeviceManager.askDevicePermission

getCameras()

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

function getCameras(): Promise<VideoDeviceInfo[]>

返回

Promise<VideoDeviceInfo[]>

继承自 DeviceManager.getCameras

getMicrophones()

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

function getMicrophones(): Promise<AudioDeviceInfo[]>

返回

Promise<AudioDeviceInfo[]>

继承自 DeviceManager.getMicrophones

getSpeakers()

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

function getSpeakers(): Promise<AudioDeviceInfo[]>

返回

Promise<AudioDeviceInfo[]>

继承自 DeviceManager.getSpeakers

off("audioDevicesUpdated", CollectionUpdatedEvent<AudioDeviceInfo>)

取消订阅 audioDevicesUpdated 事件的函数。

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

参数

event

"audioDevicesUpdated"

事件名称。

listener

CollectionUpdatedEvent<AudioDeviceInfo>

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

继承自 DeviceManager.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

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

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

参数

event

"selectedMicrophoneChanged"

事件名称。

listener

PropertyChangedEvent

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

继承自 DeviceManager.off

off("selectedSpeakerChanged", PropertyChangedEvent)

取消订阅 selectedSpeakerChanged 事件的函数。

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

参数

event

"selectedSpeakerChanged"

事件名称。

listener

PropertyChangedEvent

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

继承自 DeviceManager.off

off("videoDevicesUpdated", CollectionUpdatedEvent<VideoDeviceInfo>)

取消订阅 videoDevicesUpdated 事件的函数。

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

参数

event

"videoDevicesUpdated"

事件名称。

listener

CollectionUpdatedEvent<VideoDeviceInfo>

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

继承自 DeviceManager.off

on("audioDevicesUpdated", CollectionUpdatedEvent<AudioDeviceInfo>)

订阅 audioDevicesUpdated 的函数。

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

参数

event

"audioDevicesUpdated"

事件名称。

listener

CollectionUpdatedEvent<AudioDeviceInfo>

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

继承自 DeviceManager.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

为 selectedMicrophoneChanged 事件订阅函数。

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

参数

event

"selectedMicrophoneChanged"

事件名称。

listener

PropertyChangedEvent

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

继承自 DeviceManager.on

on("selectedSpeakerChanged", PropertyChangedEvent)

订阅 selectedSpeakerChanged 事件的订阅函数。

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

参数

event

"selectedSpeakerChanged"

事件名称。

listener

PropertyChangedEvent

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

继承自 DeviceManager.on

on("videoDevicesUpdated", CollectionUpdatedEvent<VideoDeviceInfo>)

订阅 videoDevicesUpdated 事件的订阅函数。

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

参数

event

"videoDevicesUpdated"

事件名称。

listener

CollectionUpdatedEvent<VideoDeviceInfo>

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

继承自 DeviceManager.on

selectMicrophone(AudioDeviceInfo)

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

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

参数

microphoneDevice

AudioDeviceInfo

麦克风设备信息。

返回

Promise<void>

继承自 DeviceManager.selectMicrophone

selectSpeaker(AudioDeviceInfo)

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

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

参数

speakerDevice

AudioDeviceInfo

扬声器设备信息。

返回

Promise<void>

继承自 DeviceManager.selectSpeaker

startPreheatDevices(StartPreheatDeviceParameters)

启动预热设备。

function startPreheatDevices(parameters: StartPreheatDeviceParameters): Promise<void>

参数

parameters

@azure/communication-calling.StartPreheatDeviceParameters

配置要预热的设备 （音频/视频）。

返回

Promise<void>

继承自 DeviceManager.startPreheatDevices

stopPreheatDevices(StopPreheatDeviceParameters)

停止预热设备。

function stopPreheatDevices(parameters: StopPreheatDeviceParameters)

参数

parameters

@azure/communication-calling.StopPreheatDeviceParameters

配置要停止预热的设备（音频/视频）。

继承自 DeviceManager.stopPreheatDevices