CallWithChatAdapter interface
CallWithChatComposite アダプター インターフェイス。
- Extends
継承されたメソッド
継承済みメソッドの詳細
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>
注釈
このメソッドは複合用に実装されます。
deleteMessage(string)
スレッド内のメッセージを削除します。
function deleteMessage(messageId: string): Promise<void>パラメーター
- messageId
-
string
戻り値
Promise<void>
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>
注釈
このメソッドは複合用に実装されます。
fetchInitialData()
チャット アダプターの初期状態をフェッチします。
ChatComposite メソッドと API メソッドに必要な最小限のフェッチを実行します。
function fetchInitialData(): Promise<void>戻り値
Promise<void>
getState()
現在の状態を取得する
function getState(): CallWithChatAdapterState戻り値
joinCall(boolean)
最初にマイクで通話に参加します。
function joinCall(microphoneOn?: boolean): undefined | Callパラメーター
- microphoneOn
-
boolean
マイクが最初に有効になっているかどうか
戻り値
undefined | Call
leaveCall(boolean)
通話を終了します。
function leaveCall(forEveryone?: boolean): Promise<void>パラメーター
- forEveryone
-
boolean
退出時にすべての参加者を削除するかどうか
戻り値
Promise<void>
loadPreviousChatMessages(number)
チャット スレッド履歴に以前のメッセージをさらに読み込みます。
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>パラメーター
- messagesToLoad
-
number
戻り値
Promise<boolean>
注釈
このメソッドは通常、増分フェッチ/無限スクロールを制御するために使用されます。
CallWithChatAdapterManagement.loadPreviousChatMessagesから継承されます
mute()
通話中に現在のユーザーをミュートするか、マイクをローカルで無効にします。
function mute(): Promise<void>戻り値
Promise<void>
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)パラメーター
- event
-
"callEnded"
- listener
- CallEndedListener
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)パラメーター
- event
-
"callError"
- listener
-
(e: AdapterError) => void
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)パラメーター
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)パラメーター
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)パラメーター
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)パラメーター
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)パラメーター
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)パラメーター
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)パラメーター
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)パラメーター
- event
-
"isLocalScreenSharingActiveChanged"
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)パラメーター
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)パラメーター
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)パラメーター
- event
-
"messageRead"
- listener
- MessageReadListener
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)パラメーター
- event
-
"messageReceived"
- listener
- MessageReceivedListener
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)パラメーター
- event
-
"messageSent"
- listener
- MessageReceivedListener
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
offStateChange((state: CallWithChatAdapterState) => void)
ハンドラーを stateChanged イベントに登録解除します。
function offStateChange(handler: (state: CallWithChatAdapterState) => void)パラメーター
- handler
-
(state: CallWithChatAdapterState) => void
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)パラメーター
- event
-
"callEnded"
- listener
- CallEndedListener
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)パラメーター
- event
-
"callError"
- listener
-
(e: AdapterError) => void
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)パラメーター
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)パラメーター
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)パラメーター
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)パラメーター
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)パラメーター
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)パラメーター
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)パラメーター
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)パラメーター
- event
-
"isLocalScreenSharingActiveChanged"
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)パラメーター
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)パラメーター
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)パラメーター
- event
-
"messageRead"
- listener
- MessageReadListener
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)パラメーター
- event
-
"messageReceived"
- listener
- MessageReceivedListener
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)パラメーター
- event
-
"messageSent"
- listener
- MessageReceivedListener
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
onStateChange((state: CallWithChatAdapterState) => void)
ハンドラーを stateChanged イベントにサブスクライブします。
function onStateChange(handler: (state: CallWithChatAdapterState) => void)パラメーター
- handler
-
(state: CallWithChatAdapterState) => 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
削除する参加者の UserId。
戻り値
Promise<void>
sendMessage(string, SendMessageOptions)
スレッドでメッセージを送信します。
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>パラメーター
- content
-
string
- options
- SendMessageOptions
戻り値
Promise<void>
sendReadReceipt(string)
メッセージの開封確認メッセージを送信します。
function sendReadReceipt(chatMessageId: string): Promise<void>パラメーター
- chatMessageId
-
string
戻り値
Promise<void>
sendTypingIndicator()
スレッドで入力インジケーターを送信します。
function sendTypingIndicator(): Promise<void>戻り値
Promise<void>
setCamera(VideoDeviceInfo, VideoStreamOptions)
呼び出しで使用するカメラを設定します。
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>パラメーター
- sourceInfo
- VideoDeviceInfo
選択するカメラ デバイス、queryCameras によって返される 1 つを選択する
- 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>
startCall(string[], StartCallOptions)
呼び出しを開始します。
function startCall(participants: string[], options?: StartCallOptions): undefined | Callパラメーター
- participants
-
string[]
参加する参加者 ID の配列
- options
- StartCallOptions
戻り値
undefined | Call
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>
updateMessage(string, string, Record<string, string>)
メッセージの内容を更新します。
function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>パラメーター
- messageId
-
string
- content
-
string
- metadata
-
Record<string, string>
戻り値
Promise<void>