CommonCallAdapter interface
CallComposite アダプター インターフェイス。
- Extends
メソッド
| join |
最初にマイクで通話に参加します。 |
| start |
呼び出しを開始します。 |
継承されたメソッド
メソッドの詳細
joinCall(boolean)
最初にマイクで通話に参加します。
function joinCall(microphoneOn?: boolean)パラメーター
- microphoneOn
-
boolean
マイクが最初に有効になっているかどうか
startCall(string[], StartCallOptions)
呼び出しを開始します。
function startCall(participants: string[], options?: StartCallOptions)パラメーター
- participants
-
string[]
参加する参加者 ID の配列
- options
- StartCallOptions
継承済みメソッドの詳細
askDevicePermission(PermissionConstraints)
デバイスのアクセス許可を要求します。
function askDevicePermission(constrain: PermissionConstraints): Promise<void>パラメーター
- constrain
- PermissionConstraints
ローカル デバイスにアクセスするための制約を定義する <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
戻り値
Promise<void>
注釈
アクセス許可がまだ付与されていない場合、ブラウザーのアクセス許可ウィンドウがポップアップ表示されます
createStreamView(string, VideoStreamOptions)
ストリームの html ビューを作成します。
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>パラメーター
- remoteUserId
-
string
レンダリングする参加者の ID。ローカル カメラ ビューを作成するには未定義のままにします
- options
- VideoStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void | CreateVideoStreamViewResult>
注釈
このメソッドは、複合
dispose()
disposeStreamView(string, VideoStreamOptions)
ストリームの html ビューを破棄します。
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>パラメーター
- remoteUserId
-
string
レンダリングする参加者の ID。ローカル カメラ ビューを破棄するには未定義のままにします
- options
- VideoStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void>
注釈
このメソッドは、複合
getState()
leaveCall(boolean)
通話を終了する
function leaveCall(forEveryone?: boolean): Promise<void>パラメーター
- forEveryone
-
boolean
退出時にすべての参加者を削除するかどうか
戻り値
Promise<void>
mute()
通話中に現在のユーザーをミュートするか、マイクをローカルで無効にする
function mute(): Promise<void>戻り値
Promise<void>
off("callEnded", CallEndedListener)
'callEnded' イベントの Unsubscribe 関数。
function off(event: "callEnded", listener: CallEndedListener)パラメーター
- event
-
"callEnded"
- listener
- CallEndedListener
off("callIdChanged", CallIdChangedListener)
'callIdChanged' イベントの Unsubscribe 関数。
function off(event: "callIdChanged", listener: CallIdChangedListener)パラメーター
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
off("diagnosticChanged", DiagnosticChangedEventListner)
'diagnosticChanged' イベントの Unsubscribe 関数。
function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)パラメーター
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
off("displayNameChanged", DisplayNameChangedListener)
'displayNameChanged' イベントの Unsubscribe 関数。
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)パラメーター
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
off("error", (e: AdapterError) => void)
'error' イベントの Unsubscribe 関数。
function off(event: "error", listener: (e: AdapterError) => void)パラメーター
- event
-
"error"
- listener
-
(e: AdapterError) => void
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
'isLocalScreenSharingActiveChanged' イベントの Unsubscribe 関数。
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)パラメーター
- event
-
"isLocalScreenSharingActiveChanged"
off("isMutedChanged", IsMutedChangedListener)
'isMutedChanged' イベントの Unsubscribe 関数。
function off(event: "isMutedChanged", listener: IsMutedChangedListener)パラメーター
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
off("isSpeakingChanged", IsSpeakingChangedListener)
'isSpeakingChanged' イベントの Unsubscribe 関数。
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)パラメーター
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
off("participantsJoined", ParticipantsJoinedListener)
'participantsJoined' イベントの Unsubscribe 関数。
function off(event: "participantsJoined", listener: ParticipantsJoinedListener)パラメーター
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
off("participantsLeft", ParticipantsLeftListener)
'participantsLeft' イベントの Unsubscribe 関数。
function off(event: "participantsLeft", listener: ParticipantsLeftListener)パラメーター
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
off("selectedMicrophoneChanged", PropertyChangedEvent)
'selectedMicrophoneChanged' イベントの Unsubscribe 関数。
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
off("selectedSpeakerChanged", PropertyChangedEvent)
'selectedSpeakerChanged' イベントの Unsubscribe 関数。
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
offStateChange((state: CallAdapterState) => void)
ハンドラーを stateChanged イベントにサブスクライブ解除します。
function offStateChange(handler: (state: CallAdapterState) => void)パラメーター
- handler
-
(state: CallAdapterState) => void
on("callEnded", CallEndedListener)
'callEnded' イベントの Subscribe 関数。
function on(event: "callEnded", listener: CallEndedListener)パラメーター
- event
-
"callEnded"
- listener
- CallEndedListener
on("callIdChanged", CallIdChangedListener)
'callIdChanged' イベントの Subscribe 関数。
function on(event: "callIdChanged", listener: CallIdChangedListener)パラメーター
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
注釈
イベントは、現在のユーザーの callId が変更されたときにトリガーされます。
on("diagnosticChanged", DiagnosticChangedEventListner)
'diagnosticChanged' イベントの Subscribe 関数。
このイベントは、進行中の呼び出しに関する診断に直面しているユーザーに変更があるたびに発生します。
function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)パラメーター
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
on("displayNameChanged", DisplayNameChangedListener)
'displayNameChanged' イベントの Subscribe 関数。
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)パラメーター
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
on("error", (e: AdapterError) => void)
'error' イベントのサブスクライブ関数。
function on(event: "error", listener: (e: AdapterError) => void)パラメーター
- event
-
"error"
- listener
-
(e: AdapterError) => void
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
'isLocalScreenSharingActiveChanged' イベントの Subscribe 関数。
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)パラメーター
- event
-
"isLocalScreenSharingActiveChanged"
on("isMutedChanged", IsMutedChangedListener)
'isMutedChanged' イベントの Subscribe 関数。
function on(event: "isMutedChanged", listener: IsMutedChangedListener)パラメーター
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
注釈
イベントは、現在のユーザーまたはリモート ユーザーのミュート状態が変更されるたびにトリガーされます
on("isSpeakingChanged", IsSpeakingChangedListener)
'isSpeakingChanged' イベントの Subscribe 関数。
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)パラメーター
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
on("participantsJoined", ParticipantsJoinedListener)
'participantsJoined' イベントの Subscribe 関数。
function on(event: "participantsJoined", listener: ParticipantsJoinedListener)パラメーター
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
on("participantsLeft", ParticipantsLeftListener)
'participantsLeft' イベントの Subscribe 関数。
function on(event: "participantsLeft", listener: ParticipantsLeftListener)パラメーター
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
on("selectedMicrophoneChanged", PropertyChangedEvent)
'selectedMicrophoneChanged' イベントの Subscribe 関数。
このイベントは、ユーザーが新しいマイク デバイスを選択するたびに発生します。
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
on("selectedSpeakerChanged", PropertyChangedEvent)
'selectedSpeakerChanged' イベントの Subscribe 関数。
このイベントは、ユーザーが新しいスピーカー デバイスを選択するたびに発生します。
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
onStateChange((state: CallAdapterState) => void)
ハンドラーを stateChanged イベントにサブスクライブします。
function onStateChange(handler: (state: CallAdapterState) => void)パラメーター
- handler
-
(state: CallAdapterState) => void
AdapterState.onStateChangeから継承されます
queryCameras()
使用可能なカメラ デバイスのクエリを実行します。
function queryCameras(): Promise<VideoDeviceInfo[]>戻り値
Promise<VideoDeviceInfo[]>
ビデオ デバイス情報エンティティの配列 <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
注釈
このメソッドは askDevicePermission() の後に呼び出す必要があります
queryMicrophones()
使用可能なマイク デバイスのクエリを実行します。
function queryMicrophones(): Promise<AudioDeviceInfo[]>戻り値
Promise<AudioDeviceInfo[]>
オーディオ デバイス情報エンティティの配列 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
注釈
このメソッドは askDevicePermission() の後に呼び出す必要があります
querySpeakers()
使用可能なマイク デバイスのクエリを実行します。
function querySpeakers(): Promise<AudioDeviceInfo[]>戻り値
Promise<AudioDeviceInfo[]>
オーディオ デバイス情報エンティティの配列 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
注釈
このメソッドは askDevicePermission() の後に呼び出す必要があります
removeParticipant(string)
通話から参加者を削除します。
function removeParticipant(userId: string): Promise<void>パラメーター
- userId
-
string
削除する参加者の ID
戻り値
Promise<void>
setCamera(VideoDeviceInfo, VideoStreamOptions)
通話で使用するカメラを設定します。
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>パラメーター
- sourceInfo
- VideoDeviceInfo
選択するカメラ デバイス、queryCameras によって返されたものを選択する
- options
- VideoStreamOptions
カメラ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void>
setMicrophone(AudioDeviceInfo)
通話で使用するマイクを設定します。
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>パラメーター
- sourceInfo
- AudioDeviceInfo
選択するマイク デバイス、queryMicrophones によって返される 1 つを選択する
戻り値
Promise<void>
setSpeaker(AudioDeviceInfo)
通話で使用するスピーカーを設定します。
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>パラメーター
- sourceInfo
- AudioDeviceInfo
選択するスピーカー デバイス、querySpeakers によって返される 1 つを選択する
戻り値
Promise<void>
startCamera(VideoStreamOptions)
カメラを起動する このメソッドは、呼び出しがアクティブでないときにローカル カメラ ビューのレンダリングを開始します
function startCamera(options?: VideoStreamOptions): Promise<void>パラメーター
- options
- VideoStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void>
startScreenShare()
通話中に画面の共有を開始します。
function startScreenShare(): Promise<void>戻り値
Promise<void>
stopCamera()
カメラを停止する このメソッドは、呼び出しがアクティブでない場合にローカル カメラ ビューのレンダリングを停止します
function stopCamera(): Promise<void>戻り値
Promise<void>
stopScreenShare()
画面の共有を停止する
function stopScreenShare(): Promise<void>戻り値
Promise<void>
unmute()
通話中に現在のユーザーのミュートを解除するか、マイクをローカルで有効にする
function unmute(): Promise<void>戻り値
Promise<void>