CallWithChatAdapterManagement interface
チャットを使用して現在の通話を管理するための機能。
プロパティ
| forbid |
指定したユーザー ID の音声を禁止します。 |
| forbid |
ローカル ユーザーを除く Teams 会議の出席者の音声を禁止します。 |
| forbid |
ローカル ユーザー以外の Teams 会議出席者のビデオを禁止します。 |
| forbid |
指定したユーザーIDの動画を禁止します。 |
| permit |
指定したユーザー ID のオーディオを許可します。 |
| permit |
ローカル ユーザーを除く Teams 会議の出席者のオーディオを許可します。 |
| permit |
ローカル ユーザーを除く Teams 会議の出席者に対してビデオを許可します。 |
| permit |
指定したユーザー ID のビデオを許可します。 |
| send |
DTMF トーンを 1:1 通話で通話の別の参加者に送信する |
| send |
リアルタイムのテキストを送信 |
メソッド
プロパティの詳細
forbidAudio
指定したユーザー ID の音声を禁止します。
forbidAudio: (userIds: string[]) => Promise<void>プロパティ値
(userIds: string[]) => Promise<void>
forbidOthersAudio
ローカル ユーザーを除く Teams 会議の出席者の音声を禁止します。
forbidOthersAudio: () => Promise<void>プロパティ値
() => Promise<void>
forbidOthersVideo
ローカル ユーザー以外の Teams 会議出席者のビデオを禁止します。
forbidOthersVideo: () => Promise<void>プロパティ値
() => Promise<void>
forbidVideo
指定したユーザーIDの動画を禁止します。
forbidVideo: (userIds: string[]) => Promise<void>プロパティ値
(userIds: string[]) => Promise<void>
permitAudio
指定したユーザー ID のオーディオを許可します。
permitAudio: (userIds: string[]) => Promise<void>プロパティ値
(userIds: string[]) => Promise<void>
permitOthersAudio
ローカル ユーザーを除く Teams 会議の出席者のオーディオを許可します。
permitOthersAudio: () => Promise<void>プロパティ値
() => Promise<void>
permitOthersVideo
ローカル ユーザーを除く Teams 会議の出席者に対してビデオを許可します。
permitOthersVideo: () => Promise<void>プロパティ値
() => Promise<void>
permitVideo
指定したユーザー ID のビデオを許可します。
permitVideo: (userIds: string[]) => Promise<void>プロパティ値
(userIds: string[]) => Promise<void>
sendDtmfTone
DTMF トーンを 1:1 通話で通話の別の参加者に送信する
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>プロパティ値
(dtmfTone: DtmfTone) => Promise<void>
sendRealTimeText
リアルタイムのテキストを送信
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>プロパティ値
(text: string, isFinalized: boolean) => Promise<void>
メソッドの詳細
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>パラメーター
- participant
- CommunicationUserIdentifier
返品
Promise<void>
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
新しい参加者を通話に追加します。
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>パラメーター
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
返品
Promise<void>
askDevicePermission(PermissionConstraints)
デバイスのアクセス許可を要求します。
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>パラメーター
- constrain
- PermissionConstraints
ローカル デバイスにアクセスするための制約を定義 <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
返品
Promise<DeviceAccess>
注釈
アクセス許可がまだ付与されていない場合は、ブラウザーのアクセス許可ウィンドウが表示されます。
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>
注釈
このメソッドは複合用に実装されています。
createTogetherModeStreamView(TogetherModeStreamOptions)
togethermode ストリームの html ビューを作成します。
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>パラメーター
- options
- TogetherModeStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
返品
Promise<void | TogetherModeStreamViewResult>
注釈
このメソッドは複合用に実装されています。
deleteMessage(string)
スレッド内のメッセージを削除します。
function deleteMessage(messageId: string): Promise<void>パラメーター
- messageId
-
string
返品
Promise<void>
disposeLocalVideoStreamView()
ローカルビデオストリームの html ビューを破棄します
function disposeLocalVideoStreamView(): Promise<void>返品
Promise<void>
disposeRemoteVideoStreamView(string)
リモートビデオストリームのhtmlビューを破棄します
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>パラメーター
- remoteUserId
-
string
廃棄する参加者のID
返品
Promise<void>
disposeScreenShareStreamView(string)
画面共有ストリームの html ビューを破棄します
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>パラメーター
- remoteUserId
-
string
画面共有ストリーム ビューを破棄する参加者の ID。
返品
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>
注釈
このメソッドは複合用に実装されています。
disposeTogetherModeStreamView()
togethermode ストリームの html ビューを破棄します。
function disposeTogetherModeStreamView(): Promise<void>返品
Promise<void>
注釈
このメソッドは複合用に実装されています。
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>パラメーター
- resourceDetails
- ResourceDetails
返品
Promise<void>
fetchInitialData()
チャット アダプターの初期状態をフェッチします。
ChatComposite メソッドと API メソッドに必要な最小限のフェッチを実行します。
function fetchInitialData(): Promise<void>返品
Promise<void>
holdCall()
通話をローカルホールドにします。
function holdCall(): Promise<void>返品
Promise<void>
joinCall(boolean)
警告
この API は非推奨になりました。
Use joinCall(options?:JoinCallOptions) instead.
最初にマイクをオン/オフにして通話に参加します。
function joinCall(microphoneOn?: boolean): Call | undefinedパラメーター
- microphoneOn
-
boolean
マイクが最初に有効になっているかどうか
返品
Call | undefined
joinCall(JoinCallOptions)
通話に参加するときにマイク/カメラの初期状態を設定するオプションバッグを使用して通話に参加します true = 通話に参加するときにデバイスをオンにします false = 通話に参加するときにデバイスの電源を切ります 'keep'/undefined = デバイスの事前通話状態を保持します
function joinCall(options?: JoinCallOptions): Call | undefinedパラメーター
- options
- JoinCallOptions
マイク/カメラを最初にオン/オフ/使用プレコール状態に設定するパラメータ。
返品
Call | undefined
leaveCall(boolean)
通話を終了します。
function leaveCall(forEveryone?: boolean): Promise<void>パラメーター
- forEveryone
-
boolean
退出時にすべての参加者を削除するかどうか
返品
Promise<void>
loadPreviousChatMessages(number)
チャット スレッド履歴に以前のメッセージをさらに読み込みます。
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>パラメーター
- messagesToLoad
-
number
返品
Promise<boolean>
注釈
このメソッドは通常、増分フェッチ/無限スクロールを制御するために使用されます。
lowerHand()
ローカルユーザーのためのローハンド。
function lowerHand(): Promise<void>返品
Promise<void>
mute()
通話中に現在のユーザーをミュートするか、ローカルでマイクを無効にします。
function mute(): Promise<void>返品
Promise<void>
muteAllRemoteParticipants()
参加者をミュートする
function muteAllRemoteParticipants(): Promise<void>返品
Promise<void>
muteParticipant(string)
参加者をミュートする
function muteParticipant(userId: string): Promise<void>パラメーター
- userId
-
string
返品
Promise<void>
onReactionClick(Reaction)
進行中の会議にリアクションを送信します。
function onReactionClick(reaction: Reaction): Promise<void>パラメーター
- reaction
- Reaction
type の値 <xref:%40azure%2Fcommunication-calling%23Reaction>
返品
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() の後に呼び出す必要があります
raiseHand()
ローカルユーザーのために手を挙げます。
function raiseHand(): Promise<void>返品
Promise<void>
removeParticipant(CommunicationIdentifier)
通話から参加者を削除します。
function removeParticipant(participant: CommunicationIdentifier): Promise<void>パラメーター
- participant
- CommunicationIdentifier
<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 除名される参加者の
返品
Promise<void>
removeParticipant(string)
通話から参加者を削除します。
function removeParticipant(userId: string): Promise<void>パラメーター
- userId
-
string
削除する参加者の UserId。
返品
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)パラメーター
- resourceDetails
- ResourceDetails
resumeCall()
LocalHold 状態から呼び出しを再開します。
function resumeCall(): Promise<void>返品
Promise<void>
returnFromBreakoutRoom()
ブレイクアウトルームの発信元に戻る
function returnFromBreakoutRoom(): Promise<void>返品
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
カメラデバイスを選ぶ場合は、CallAdapterDeviceManagement#queryCameras から返されたものを選びます
- options
- VideoStreamOptions
カメラ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
返品
Promise<void>
setCaptionLanguage(string)
キャプション言語を設定する機能
function setCaptionLanguage(language: string): Promise<void>パラメーター
- language
-
string
キャプションの言語セット
返品
Promise<void>
setMicrophone(AudioDeviceInfo)
通話で使用するマイクを設定します。
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>パラメーター
- sourceInfo
- AudioDeviceInfo
マイクデバイスを選ぶ場合は、CallAdapterDeviceManagement#queryMicrophonesから返されたものを選んでください
返品
Promise<void>
setSpeaker(AudioDeviceInfo)
通話で使用するスピーカーを設定します。
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>パラメーター
- sourceInfo
- AudioDeviceInfo
スピーカーデバイスを選ぶ場合は、CallAdapterDeviceManagement#querySpeakersから返されたものを選びます
返品
Promise<void>
setSpokenLanguage(string)
音声言語を設定する機能
function setSpokenLanguage(language: string): Promise<void>パラメーター
- language
-
string
話し言葉
返品
Promise<void>
setTogetherModeSceneSize(number, number)
Together モードの着座位置を再計算します。
function setTogetherModeSceneSize(width: number, height: number)パラメーター
- width
-
number
コンテナの幅
- height
-
number
コンテナの高さ
注釈
このメソッドは複合用に実装されています。
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
呼び出しを開始します。
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): Call | undefinedパラメーター
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
呼び出される <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> の配列
- options
- StartCallOptions
返品
Call | undefined
startCall(string[], StartCallOptions)
呼び出しを開始します。
function startCall(participants: string[], options?: StartCallOptions): Call | undefinedパラメーター
- participants
-
string[]
参加する参加者 ID の配列
- options
- StartCallOptions
返品
Call | undefined
startCamera(VideoStreamOptions)
カメラを起動します。
このメソッドは、呼び出しがアクティブでない場合にローカル カメラ ビューのレンダリングを開始します。
function startCamera(options?: VideoStreamOptions): Promise<void>パラメーター
- options
- VideoStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
返品
Promise<void>
startCaptions(StartCaptionsAdapterOptions)
キャプションを開始する機能
function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>パラメーター
- options
- StartCaptionsAdapterOptions
開始キャプションのオプション
返品
Promise<void>
startNoiseSuppressionEffect()
ノイズ抑制効果を開始します。
function startNoiseSuppressionEffect(): Promise<void>返品
Promise<void>
startScreenShare()
通話中に画面の共有を開始します。
function startScreenShare(): Promise<void>返品
Promise<void>
startSpotlight(string[])
スポットライトを開始
function startSpotlight(userIds?: string[]): Promise<void>パラメーター
- userIds
-
string[]
返品
Promise<void>
startTogetherMode()
一緒に開始モード。
function startTogetherMode(): Promise<void>返品
Promise<void>
注釈
このメソッドは複合用に実装されています。
startVideoBackgroundEffect(VideoBackgroundEffect)
ビデオの背景効果を開始します。
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>パラメーター
- videoBackgroundEffect
- VideoBackgroundEffect
返品
Promise<void>
stopAllSpotlight()
すべてのスポットライトを止める
function stopAllSpotlight(): Promise<void>返品
Promise<void>
stopCamera()
カメラを停止します。
このメソッドは、呼び出しがアクティブでない場合、ローカル カメラ ビューのレンダリングを停止します。
function stopCamera(): Promise<void>返品
Promise<void>
stopCaptions(StopCaptionsAdapterOptions)
キャプションを停止する機能
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>パラメーター
- options
- StopCaptionsAdapterOptions
返品
Promise<void>
stopNoiseSuppressionEffect()
ノイズ抑制効果を開始します。
function stopNoiseSuppressionEffect(): Promise<void>返品
Promise<void>
stopScreenShare()
画面の共有を停止します。
function stopScreenShare(): Promise<void>返品
Promise<void>
stopSpotlight(string[])
スポットライトを止める
function stopSpotlight(userIds?: string[]): Promise<void>パラメーター
- userIds
-
string[]
返品
Promise<void>
stopVideoBackgroundEffects()
ビデオの背景効果を停止します。
function stopVideoBackgroundEffects(): Promise<void>返品
Promise<void>
submitSurvey(CallSurvey)
通話終了の調査結果を送信する
function submitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>パラメーター
- survey
- CallSurvey
返品
Promise<CallSurveyResponse | undefined>
unmute()
通話中に現在のユーザーのミュートを解除するか、ローカルでマイクを有効にします。
function unmute(): Promise<void>返品
Promise<void>
updateBackgroundPickerImages(VideoBackgroundImage[])
背景ピッカーの画像を上書きして、背景の置換効果を得ます。
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])パラメーター
- backgroundImages
カスタム背景画像の配列。
updateMessage(string, string, Record<string, string>)
メッセージの内容を更新します。
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>パラメーター
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
返品
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
選択したビデオの背景効果を更新する
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)パラメーター
- selectedVideoBackground
- VideoBackgroundEffect