CallAdapterCallOperations interface
現在の呼び出しを管理するための機能。
プロパティ
| send |
リアルタイムのテキストを送信 |
メソッド
プロパティの詳細
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>
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)
ストリームの HTML ビューを作成します。
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>パラメーター
- options
- TogetherModeStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void | TogetherModeStreamViewResult>
注釈
このメソッドは複合用に実装されています。
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)
警告
この API は非推奨になりました。
Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.
ストリームの html ビューを破棄します。
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>パラメーター
- remoteUserId
-
string
レンダリングする参加者の ID。ローカル カメラ ビューを破棄するには未定義のままにします
- options
- VideoStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void>
注釈
このメソッドは複合用に実装されています。
disposeTogetherModeStreamView()
ストリームの html ビューを破棄します。
function disposeTogetherModeStreamView(): Promise<void>戻り値
Promise<void>
注釈
このメソッドは複合用に実装されています。
forbidAudio(string[])
Teams 会議の出席者の音声をユーザー ID で禁止します。
function forbidAudio(userIds: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
forbidOthersAudio()
Teamsの会議の音声を禁止します。
function forbidOthersAudio(): Promise<void>戻り値
Promise<void>
forbidOthersVideo()
Teamsの会議ビデオを禁止します。
function forbidOthersVideo(): Promise<void>戻り値
Promise<void>
forbidVideo(string[])
Teams 会議の出席者のビデオをユーザー ID で禁止します。
function forbidVideo(userIds: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
holdCall()
通話を保留にします。
function holdCall(): Promise<void>戻り値
Promise<void>
leaveCall(boolean)
通話を終了する
function leaveCall(forEveryone?: boolean): Promise<void>パラメーター
- forEveryone
-
boolean
退出時にすべての参加者を削除するかどうか
戻り値
Promise<void>
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
ミュートする参加者のID
戻り値
Promise<void>
onReactionClick(Reaction)
リアクション絵文字を送信する
function onReactionClick(reaction: Reaction): Promise<void>パラメーター
- reaction
- Reaction
戻り値
Promise<void>
permitAudio(string[])
Teams 会議の出席者にユーザー ID による音声を許可します。
function permitAudio(userIds: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
permitOthersAudio()
Teams 会議の音声を許可します。
function permitOthersAudio(): Promise<void>戻り値
Promise<void>
permitOthersVideo()
Teams 会議のビデオを許可します。
function permitOthersVideo(): Promise<void>戻り値
Promise<void>
permitVideo(string[])
Teams 会議の出席者にユーザー ID による音声を許可します。
function permitVideo(userIds: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
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
削除する参加者の ID
戻り値
Promise<void>
resumeCall()
LocalHold状態から通話を再開します。
function resumeCall(): Promise<void>戻り値
Promise<void>
returnFromBreakoutRoom()
ブレイクアウトルームの発信元に戻る
function returnFromBreakoutRoom(): Promise<void>戻り値
Promise<void>
sendDtmfTone(DtmfTone)
DTMF トーンを 1:1 PSTN 通話の別の参加者に送信する
function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>パラメーター
- dtmfTone
- DtmfTone
戻り値
Promise<void>
setCaptionLanguage(string)
キャプション言語を設定する機能
function setCaptionLanguage(language: string): Promise<void>パラメーター
- language
-
string
キャプションの言語セット
戻り値
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
コンテナの高さ
注釈
このメソッドは複合用に実装されています。
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[])
ローカル参加者とリモート参加者のスポットライトをユーザー ID で開始します。 ユーザー ID の配列が渡されない場合、アクションはローカル参加者に対して実行されます。
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[])
ローカル参加者とリモート参加者のスポットライトを、ユーザー ID で停止します。 ユーザー ID の配列が渡されない場合、アクションはローカル参加者に対して実行されます。
function stopSpotlight(userIds?: string[]): Promise<void>パラメーター
- userIds
-
string[]
戻り値
Promise<void>
stopVideoBackgroundEffects()
ビデオの背景効果を停止します。
function stopVideoBackgroundEffects(): Promise<void>戻り値
Promise<void>
submitSurvey(CallSurvey)
通話終了の調査結果を送信する
function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>パラメーター
- survey
- CallSurvey
戻り値
Promise<undefined | CallSurveyResponse>
unmute()
通話中に現在のユーザーのミュートを解除するか、ローカルでマイクを有効にする
function unmute(): Promise<void>戻り値
Promise<void>
updateBackgroundPickerImages(VideoBackgroundImage[])
背景ピッカーの画像を上書きして、背景の置換効果を得ます。
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])パラメーター
- backgroundImages
カスタム背景画像の配列。
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
選択したビデオの背景効果を更新します。
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)パラメーター
- selectedVideoBackground
- VideoBackgroundEffect