CallWithChatAdapterManagement interface

パッケージ:

@azure/communication-react

チャットを使用して現在の通話を管理するための機能。

メソッド

askDevicePermission(PermissionConstraints)	デバイスのアクセス許可を要求します。
createStreamView(string, VideoStreamOptions)	ストリームの HTML ビューを作成します。
deleteMessage(string)	スレッド内のメッセージを削除します。
disposeStreamView(string, VideoStreamOptions)	ストリームの html ビューを破棄します。
fetchInitialData()	チャット アダプターの初期状態をフェッチします。 ChatComposite メソッドと API メソッドに必要な最小限のフェッチを実行します。
joinCall(boolean)	最初にマイクをオン/オフにして通話に参加します。
leaveCall(boolean)	通話を終了します。
loadPreviousChatMessages(number)	チャット スレッド履歴に以前のメッセージをさらに読み込みます。
mute()	通話中に現在のユーザーをミュートするか、ローカルでマイクを無効にします。
queryCameras()	使用可能なカメラ デバイスのクエリを実行します。
queryMicrophones()	使用可能なマイク デバイスのクエリを実行します。
querySpeakers()	使用可能なマイク デバイスのクエリを実行します。
removeParticipant(string)	通話から参加者を削除します。
sendMessage(string, SendMessageOptions)	スレッドでメッセージを送信します。
sendReadReceipt(string)	メッセージの開封確認メッセージを送信します。
sendTypingIndicator()	スレッドで入力インジケーターを送信します。
setCamera(VideoDeviceInfo, VideoStreamOptions)	通話で使用するカメラを設定します。
setMicrophone(AudioDeviceInfo)	通話で使用するマイクを設定します。
setSpeaker(AudioDeviceInfo)	通話で使用するスピーカーを設定します。
startCall(string[], StartCallOptions)	呼び出しを開始します。
startCamera(VideoStreamOptions)	カメラを起動します。 このメソッドは、呼び出しがアクティブでない場合にローカル カメラ ビューのレンダリングを開始します。
startScreenShare()	通話中に画面の共有を開始します。
stopCamera()	カメラを停止します。 このメソッドは、呼び出しがアクティブでない場合、ローカル カメラ ビューのレンダリングを停止します。
stopScreenShare()	画面の共有を停止します。
unmute()	通話中に現在のユーザーのミュートを解除するか、ローカルでマイクを有効にします。
updateMessage(string, string, Record<string, string>)	メッセージの内容を更新します。

メソッドの詳細

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>

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>

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>

注釈

このメソッドは通常、増分フェッチ/無限スクロールを制御するために使用されます。

mute()

通話中に現在のユーザーをミュートするか、ローカルでマイクを無効にします。

function mute(): Promise<void>

戻り値

Promise<void>

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 によって返されたものを選択します

options

VideoStreamOptions

カメラ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

戻り値

Promise<void>

setMicrophone(AudioDeviceInfo)

通話で使用するマイクを設定します。

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

パラメーター

sourceInfo

AudioDeviceInfo

選択するマイクデバイスは、queryMicrophones によって返されたものを選択

戻り値

Promise<void>

setSpeaker(AudioDeviceInfo)

通話で使用するスピーカーを設定します。

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

パラメーター

sourceInfo

AudioDeviceInfo

選択するスピーカー デバイスで、querySpeakers によって返されたものを選択します

戻り値

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>