DeviceManager interface

パッケージ:

@azure/communication-calling

デバイス マネージャーは、カメラ、マイク、スピーカーなどのシステム メディア デバイスを処理するために使用されます。

プロパティ

isSpeakerSelectionAvailable	デバイス ホストがスピーカー出力を選択できるかどうか。
selectedMicrophone	使用されているマイク デバイス。
selectedSpeaker	使用されているスピーカー デバイス。

メソッド

askDevicePermission(PermissionConstraints)	指定したデバイスを使用するアクセス許可をフロントエンド ユーザーに求めるブラウザー プロンプトを表示します。
getCameras()	使用できるビデオ デバイスの一覧を取得します。
getMicrophones()	使用できるマイク デバイスの一覧を取得します。
getSpeakers()	使用できるスピーカー デバイスの一覧を取得します。
off("audioDevicesUpdated", CollectionUpdatedEvent<AudioDeviceInfo>)	audioDevicesUpdated イベントの Unsubscribe 関数。
off("selectedMicrophoneChanged", PropertyChangedEvent)	selectedMicrophoneChanged イベントの Unsubscribe 関数。
off("selectedSpeakerChanged", PropertyChangedEvent)	selectedSpeakerChanged イベントの Unsubscribe 関数。
off("videoDevicesUpdated", CollectionUpdatedEvent<VideoDeviceInfo>)	videoDevicesUpdated イベントの Unsubscribe 関数。
on("audioDevicesUpdated", CollectionUpdatedEvent<AudioDeviceInfo>)	audioDevicesUpdated の Subscribe 関数。
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 イベントの Unsubscribe 関数。

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

パラメーター

event

"audioDevicesUpdated"

イベント名。

listener

CollectionUpdatedEvent<AudioDeviceInfo>

このイベントのサブスクライブに使用されたコールバック fn。

off("selectedMicrophoneChanged", PropertyChangedEvent)

selectedMicrophoneChanged イベントの Unsubscribe 関数。

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

パラメーター

event

"selectedMicrophoneChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

off("selectedSpeakerChanged", PropertyChangedEvent)

selectedSpeakerChanged イベントの Unsubscribe 関数。

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

パラメーター

event

"selectedSpeakerChanged"

イベント名。

listener

PropertyChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

off("videoDevicesUpdated", CollectionUpdatedEvent<VideoDeviceInfo>)

videoDevicesUpdated イベントの Unsubscribe 関数。

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 イベントのサブスクライブ関数。

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>