CallWithChatAdapter interface

パッケージ:: @azure/communication-react

CallWithChatComposite アダプターインターフェイスをします。

Extends: CallWithChatAdapterManagement,AdapterState<CallWithChatAdapterState>,Disposable,CallWithChatAdapterSubscriptions

継承されたプロパティ

forbidAudio	指定したユーザー ID の音声を禁止します。
forbidOthersAudio	ローカルユーザーを除く Teams 会議の出席者の音声を禁止します。
forbidOthersVideo	ローカルユーザー以外の Teams 会議出席者のビデオを禁止します。
forbidVideo	指定したユーザーIDの動画を禁止します。
permitAudio	指定したユーザー ID のオーディオを許可します。
permitOthersAudio	ローカルユーザーを除く Teams 会議の出席者のオーディオを許可します。
permitOthersVideo	ローカルユーザーを除く Teams 会議の出席者に対してビデオを許可します。
permitVideo	指定したユーザー ID のビデオを許可します。
sendDtmfTone	DTMF トーンを 1:1 通話で通話の別の参加者に送信する
sendRealTimeText	リアルタイムのテキストを送信

継承されたメソッド

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	新しい参加者を通話に追加します。
askDevicePermission(PermissionConstraints)	デバイスのアクセス許可を要求します。
createStreamView(string, VideoStreamOptions)	ストリームの HTML ビューを作成します。
createTogetherModeStreamView(TogetherModeStreamOptions)	togethermode ストリームの html ビューを作成します。
deleteMessage(string)	スレッド内のメッセージを削除します。
dispose()	複合の破棄
disposeLocalVideoStreamView()	ローカルビデオストリームの html ビューを破棄します
disposeRemoteVideoStreamView(string)	リモートビデオストリームのhtmlビューを破棄します
disposeScreenShareStreamView(string)	画面共有ストリームの html ビューを破棄します
disposeStreamView(string, VideoStreamOptions)	ストリームの html ビューを破棄します。
disposeTogetherModeStreamView()	togethermode ストリームの html ビューを破棄します。
downloadResourceToCache(ResourceDetails)
fetchInitialData()	チャットアダプターの初期状態をフェッチします。 ChatComposite メソッドと API メソッドに必要な最小限のフェッチを実行します。
getState()	現在の状態を取得する
holdCall()	通話をローカルホールドにします。
joinCall(boolean)	最初にマイクをオン/オフにして通話に参加します。
joinCall(JoinCallOptions)	通話に参加するときにマイク/カメラの初期状態を設定するオプションバッグを使用して通話に参加します true = 通話に参加するときにデバイスをオンにします false = 通話に参加するときにデバイスの電源を切ります 'keep'/undefined = デバイスの事前通話状態を保持します
leaveCall(boolean)	通話を終了します。
loadPreviousChatMessages(number)	チャットスレッド履歴に以前のメッセージをさらに読み込みます。
lowerHand()	ローカルユーザーのためのローハンド。
mute()	通話中に現在のユーザーをミュートするか、ローカルでマイクを無効にします。
muteAllRemoteParticipants()	参加者をミュートする
muteParticipant(string)	参加者をミュートする
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
off("callEnded", CallEndedListener)
off("callError", (e: AdapterError) => void)
off("callIdChanged", CallIdChangedListener)
off("callParticipantsJoined", ParticipantsJoinedListener)
off("callParticipantsLeft", ParticipantsLeftListener)
off("capabilitiesChanged", CapabilitiesChangedListener)
off("captionsReceived", CaptionsReceivedListener)
off("chatError", (e: AdapterError) => void)
off("chatInitialized", ChatInitializedListener)
off("chatParticipantsAdded", ParticipantsAddedListener)
off("chatParticipantsRemoved", ParticipantsRemovedListener)
off("displayNameChanged", DisplayNameChangedListener)
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
off("isMutedChanged", IsMutedChangedListener)
off("isSpeakingChanged", IsSpeakingChangedListener)
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
off("messageDeleted", MessageReceivedListener)
off("messageEdited", MessageReceivedListener)
off("messageRead", MessageReadListener)
off("messageReceived", MessageReceivedListener)
off("messageSent", MessageReceivedListener)
off("realTimeTextReceived", RealTimeTextReceivedListener)
off("selectedMicrophoneChanged", PropertyChangedEvent)
off("selectedSpeakerChanged", PropertyChangedEvent)
off("spotlightChanged", SpotlightChangedListener)
offStateChange((state: CallWithChatAdapterState) => void)	ハンドラーを stateChanged イベントの登録を解除します。
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
on("callEnded", CallEndedListener)
on("callError", (e: AdapterError) => void)
on("callIdChanged", CallIdChangedListener)
on("callParticipantsJoined", ParticipantsJoinedListener)
on("callParticipantsLeft", ParticipantsLeftListener)
on("capabilitiesChanged", CapabilitiesChangedListener)
on("captionsReceived", CaptionsReceivedListener)
on("chatError", (e: AdapterError) => void)
on("chatInitialized", ChatInitializedListener)
on("chatParticipantsAdded", ParticipantsAddedListener)
on("chatParticipantsRemoved", ParticipantsRemovedListener)
on("displayNameChanged", DisplayNameChangedListener)
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
on("isMutedChanged", IsMutedChangedListener)
on("isSpeakingChanged", IsSpeakingChangedListener)
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
on("messageDeleted", MessageReceivedListener)
on("messageEdited", MessageReceivedListener)
on("messageRead", MessageReadListener)
on("messageReceived", MessageReceivedListener)
on("messageSent", MessageReceivedListener)
on("realTimeTextReceived", RealTimeTextReceivedListener)
on("selectedMicrophoneChanged", PropertyChangedEvent)
on("selectedSpeakerChanged", PropertyChangedEvent)
on("spotlightChanged", SpotlightChangedListener)
onReactionClick(Reaction)	進行中の会議にリアクションを送信します。
onStateChange((state: CallWithChatAdapterState) => void)	ハンドラーを stateChanged イベントにサブスクライブします。
queryCameras()	使用可能なカメラデバイスのクエリを実行します。
queryMicrophones()	使用可能なマイクデバイスのクエリを実行します。
querySpeakers()	使用可能なマイクデバイスのクエリを実行します。
raiseHand()	ローカルユーザーのために手を挙げます。
removeParticipant(CommunicationIdentifier)	通話から参加者を削除します。
removeParticipant(string)	通話から参加者を削除します。
removeResourceFromCache(ResourceDetails)
resumeCall()	LocalHold 状態から呼び出しを再開します。
returnFromBreakoutRoom()	ブレイクアウトルームの発信元に戻る
sendMessage(string, SendMessageOptions)	スレッドでメッセージを送信します。
sendReadReceipt(string)	メッセージの開封確認メッセージを送信します。
sendTypingIndicator()	スレッドで入力インジケーターを送信します。
setCamera(VideoDeviceInfo, VideoStreamOptions)	通話で使用するカメラを設定します。
setCaptionLanguage(string)	キャプション言語を設定する機能
setMicrophone(AudioDeviceInfo)	通話で使用するマイクを設定します。
setSpeaker(AudioDeviceInfo)	通話で使用するスピーカーを設定します。
setSpokenLanguage(string)	音声言語を設定する機能
setTogetherModeSceneSize(number, number)	Together モードの着座位置を再計算します。
startCall((CommunicationUserIdentifier \| PhoneNumberIdentifier \| MicrosoftTeamsUserIdentifier \| MicrosoftTeamsAppIdentifier \| UnknownIdentifier)[], StartCallOptions)	呼び出しを開始します。
startCall(string[], StartCallOptions)	呼び出しを開始します。
startCamera(VideoStreamOptions)	カメラを起動します。このメソッドは、呼び出しがアクティブでない場合にローカルカメラビューのレンダリングを開始します。
startCaptions(StartCaptionsAdapterOptions)	キャプションを開始する機能
startNoiseSuppressionEffect()	ノイズ抑制効果を開始します。
startScreenShare()	通話中に画面の共有を開始します。
startSpotlight(string[])	スポットライトを開始
startTogetherMode()	一緒に開始モード。
startVideoBackgroundEffect(VideoBackgroundEffect)	ビデオの背景効果を開始します。
stopAllSpotlight()	すべてのスポットライトを止める
stopCamera()	カメラを停止します。このメソッドは、呼び出しがアクティブでない場合、ローカルカメラビューのレンダリングを停止します。
stopCaptions(StopCaptionsAdapterOptions)	キャプションを停止する機能
stopNoiseSuppressionEffect()	ノイズ抑制効果を開始します。
stopScreenShare()	画面の共有を停止します。
stopSpotlight(string[])	スポットライトを止める
stopVideoBackgroundEffects()	ビデオの背景効果を停止します。
submitSurvey(CallSurvey)	通話終了の調査結果を送信する
unmute()	通話中に現在のユーザーのミュートを解除するか、ローカルでマイクを有効にします。
updateBackgroundPickerImages(VideoBackgroundImage[])	背景ピッカーの画像を上書きして、背景の置換効果を得ます。
updateMessage(string, string, Record<string, string>)	メッセージの内容を更新します。
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	選択したビデオの背景効果を更新する

継承されたプロパティの詳細

forbidAudio

指定したユーザー ID の音声を禁止します。

forbidAudio: (userIds: string[]) => Promise<void>

プロパティ値

(userIds: string[]) => Promise<void>

CallWithChatAdapterManagement.forbidAudioから継承されます

forbidOthersAudio

ローカルユーザーを除く Teams 会議の出席者の音声を禁止します。

forbidOthersAudio: () => Promise<void>

プロパティ値

() => Promise<void>

CallWithChatAdapterManagement.forbidOthersAudioから継承

forbidOthersVideo

ローカルユーザー以外の Teams 会議出席者のビデオを禁止します。

forbidOthersVideo: () => Promise<void>

プロパティ値

() => Promise<void>

CallWithChatAdapterManagement.forbidOthersVideoから継承

forbidVideo

指定したユーザーIDの動画を禁止します。

forbidVideo: (userIds: string[]) => Promise<void>

プロパティ値

(userIds: string[]) => Promise<void>

CallWithChatAdapterManagement.forbidVideoから継承

permitAudio

指定したユーザー ID のオーディオを許可します。

permitAudio: (userIds: string[]) => Promise<void>

プロパティ値

(userIds: string[]) => Promise<void>

CallWithChatAdapterManagement.permitAudioから継承されます

permitOthersAudio

ローカルユーザーを除く Teams 会議の出席者のオーディオを許可します。

permitOthersAudio: () => Promise<void>

プロパティ値

() => Promise<void>

CallWithChatAdapterManagement.permitOthersAudioから継承

permitOthersVideo

ローカルユーザーを除く Teams 会議の出席者に対してビデオを許可します。

permitOthersVideo: () => Promise<void>

プロパティ値

() => Promise<void>

CallWithChatAdapterManagement.permitOthersVideoから継承

permitVideo

指定したユーザー ID のビデオを許可します。

permitVideo: (userIds: string[]) => Promise<void>

プロパティ値

(userIds: string[]) => Promise<void>

CallWithChatAdapterManagement.permitVideoから継承

sendDtmfTone

DTMF トーンを 1:1 通話で通話の別の参加者に送信する

public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>

プロパティ値

(dtmfTone: DtmfTone) => Promise<void>

CallWithChatAdapterManagement.sendDtmfToneから継承

sendRealTimeText

リアルタイムのテキストを送信

sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

プロパティ値

(text: string, isFinalized: boolean) => Promise<void>

CallWithChatAdapterManagement.sendRealTimeTextから継承されます

継承済みメソッドの詳細

addParticipant(CommunicationUserIdentifier)

function addParticipant(participant: CommunicationUserIdentifier): Promise<void>

パラメーター

participant: CommunicationUserIdentifier

戻り値

Promise<void>

CallWithChatAdapterManagement.addParticipantから継承

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

新しい参加者を通話に追加します。

function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>

パラメーター

participant: PhoneNumberIdentifier

options: AddPhoneNumberOptions

戻り値

Promise<void>

CallWithChatAdapterManagement.addParticipantから継承

askDevicePermission(PermissionConstraints)

デバイスのアクセス許可を要求します。

function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>

パラメーター

constrain: PermissionConstraints

ローカルデバイスにアクセスするための制約を定義 <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

戻り値

Promise<DeviceAccess>

注釈

アクセス許可がまだ付与されていない場合は、ブラウザーのアクセス許可ウィンドウが表示されます。

CallWithChatAdapterManagement.askDevicePermissionから継承されます

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>

注釈

このメソッドは複合用に実装されています。

CallWithChatAdapterManagement.createStreamViewから継承されます

createTogetherModeStreamView(TogetherModeStreamOptions)

togethermode ストリームの html ビューを作成します。

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

パラメーター

options: TogetherModeStreamOptions

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

戻り値

Promise<void | TogetherModeStreamViewResult>

注釈

このメソッドは複合用に実装されています。

CallWithChatAdapterManagement.createTogetherModeStreamViewから継承されます

deleteMessage(string)

スレッド内のメッセージを削除します。

function deleteMessage(messageId: string): Promise<void>

パラメーター

messageId: string

戻り値

Promise<void>

継承元CallWithChatAdapterManagement.deleteMessage

dispose()

複合の破棄

function dispose()

継承元Disposable_2.dispose

disposeLocalVideoStreamView()

ローカルビデオストリームの html ビューを破棄します

function disposeLocalVideoStreamView(): Promise<void>

戻り値

Promise<void>

CallWithChatAdapterManagement.disposeLocalVideoStreamViewから継承

disposeRemoteVideoStreamView(string)

リモートビデオストリームのhtmlビューを破棄します

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

パラメーター

remoteUserId: string

廃棄する参加者のID

戻り値

Promise<void>

CallWithChatAdapterManagement.disposeRemoteVideoStreamViewから継承されます

disposeScreenShareStreamView(string)

画面共有ストリームの html ビューを破棄します

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

パラメーター

remoteUserId: string

画面共有ストリームビューを破棄する参加者の ID。

戻り値

Promise<void>

注釈

このメソッドは、複合

CallWithChatAdapterManagement.disposeScreenShareStreamViewから継承

disposeStreamView(string, VideoStreamOptions)

ストリームの html ビューを破棄します。

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

パラメーター

remoteUserId: string

レンダリングする参加者の ID。ローカルカメラビューを破棄するには未定義のままにします

options: VideoStreamOptions

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

戻り値

Promise<void>

注釈

このメソッドは複合用に実装されています。

CallWithChatAdapterManagement.disposeStreamViewから継承

disposeTogetherModeStreamView()

togethermode ストリームの html ビューを破棄します。

function disposeTogetherModeStreamView(): Promise<void>

戻り値

Promise<void>

注釈

このメソッドは複合用に実装されています。

CallWithChatAdapterManagement.disposeTogetherModeStreamViewから継承されます

downloadResourceToCache(ResourceDetails)

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

パラメーター

resourceDetails: ResourceDetails

戻り値

Promise<void>

CallWithChatAdapterManagement.downloadResourceToCacheから継承されます

fetchInitialData()

チャットアダプターの初期状態をフェッチします。

ChatComposite メソッドと API メソッドに必要な最小限のフェッチを実行します。

function fetchInitialData(): Promise<void>

戻り値

Promise<void>

CallWithChatAdapterManagement.fetchInitialDataから継承されます

getState()

現在の状態を取得する

function getState(): CallWithChatAdapterState

戻り値

CallWithChatAdapterState

継承元AdapterState.getState

holdCall()

通話をローカルホールドにします。

function holdCall(): Promise<void>

戻り値

Promise<void>

CallWithChatAdapterManagement.holdCallから継承されます

joinCall(boolean)

警告

この API は非推奨になりました。

Use joinCall(options?:JoinCallOptions) instead.

最初にマイクをオン/オフにして通話に参加します。

function joinCall(microphoneOn?: boolean): undefined | Call

パラメーター

microphoneOn: boolean

マイクが最初に有効になっているかどうか

戻り値

undefined | Call

CallWithChatAdapterManagement.joinCallから継承されます

joinCall(JoinCallOptions)

通話に参加するときにマイク/カメラの初期状態を設定するオプションバッグを使用して通話に参加します true = 通話に参加するときにデバイスをオンにします false = 通話に参加するときにデバイスの電源を切ります 'keep'/undefined = デバイスの事前通話状態を保持します

function joinCall(options?: JoinCallOptions): undefined | Call

パラメーター

options: JoinCallOptions

マイク/カメラを最初にオン/オフ/使用プレコール状態に設定するパラメータ。

戻り値

undefined | Call

CallWithChatAdapterManagement.joinCallから継承されます

leaveCall(boolean)

通話を終了します。

function leaveCall(forEveryone?: boolean): Promise<void>

パラメーター

forEveryone: boolean

退出時にすべての参加者を削除するかどうか

戻り値

Promise<void>

CallWithChatAdapterManagement.leaveCallから継承されます

loadPreviousChatMessages(number)

チャットスレッド履歴に以前のメッセージをさらに読み込みます。

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

パラメーター

messagesToLoad: number

戻り値

Promise<boolean>

注釈

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

CallWithChatAdapterManagement.loadPreviousChatMessagesから継承

lowerHand()

ローカルユーザーのためのローハンド。

function lowerHand(): Promise<void>

戻り値

Promise<void>

CallWithChatAdapterManagement.lowerHandから継承されます

mute()

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

function mute(): Promise<void>

戻り値

Promise<void>

CallWithChatAdapterManagement.muteから継承

muteAllRemoteParticipants()

参加者をミュートする

function muteAllRemoteParticipants(): Promise<void>

戻り値

Promise<void>

CallWithChatAdapterManagement.muteAllRemoteParticipantsから継承されます

muteParticipant(string)

参加者をミュートする

function muteParticipant(userId: string): Promise<void>

パラメーター

userId: string

戻り値

Promise<void>

継承元CallWithChatAdapterManagement.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)