DeviceManager interface

套件:

@azure/communication-calling

設備管理器可用來處理系統媒體裝置，例如相機、麥克風和喇叭。

屬性

isSpeakerSelectionAvailable	裝置主機是否可以選取喇叭輸出。
selectedMicrophone	正在使用的麥克風裝置。
selectedSpeaker	正在使用的喇叭裝置。

方法

askDevicePermission(PermissionConstraints)	顯示瀏覽器提示，要求前端使用者取得使用指定裝置的許可權。
getCameras()	取得可用的視訊裝置清單以供使用。
getMicrophones()	取得可用的麥克風裝置清單以供使用。
getSpeakers()	取得可用的喇叭裝置清單以供使用。
off("audioDevicesUpdated", CollectionUpdatedEvent<AudioDeviceInfo>)	取消訂閱 audioDevicesUpdated 事件的函式。
off("selectedMicrophoneChanged", PropertyChangedEvent)	針對 selectedMicrophoneChanged 事件取消訂閱函式。
off("selectedSpeakerChanged", PropertyChangedEvent)	針對 selectedSpeakerChanged 事件取消訂閱函式。
off("videoDevicesUpdated", CollectionUpdatedEvent<VideoDeviceInfo>)	videoDevicesUpdated 事件的取消訂閱函式。
on("audioDevicesUpdated", CollectionUpdatedEvent<AudioDeviceInfo>)	audioDevicesUpdated 的 Subscribe 函式。
on("selectedMicrophoneChanged", PropertyChangedEvent)	SelectedMicrophoneChanged 事件的訂閱函式。
on("selectedSpeakerChanged", PropertyChangedEvent)	selectedSpeakerChanged 事件的訂閱函式。
on("videoDevicesUpdated", CollectionUpdatedEvent<VideoDeviceInfo>)	videoDevicesUpdated 事件的 Subscribe 函式。
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)

針對 selectedMicrophoneChanged 事件取消訂閱函式。

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 的 Subscribe 函式。

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 事件的 Subscribe 函式。

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>