CallAdapterCallManagement interface

警告

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

CallAdapter interface will be flatten, consider using CallAdapter directly

現在の呼び出しを管理したり、新しい呼び出しを開始したりする機能

Extends

継承されたプロパティ

sendRealTimeText

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

メソッド

joinCall(boolean)

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

joinCall(JoinCallOptions)

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

startCall(CommunicationIdentifier[], StartCallOptions)

呼び出しを開始します。

startCall(string[], StartCallOptions)

呼び出しを開始します。

継承されたメソッド

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

createStreamView(string, VideoStreamOptions)

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

createTogetherModeStreamView(TogetherModeStreamOptions)

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

disposeLocalVideoStreamView()

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

disposeRemoteVideoStreamView(string)

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

disposeScreenShareStreamView(string)

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

disposeStreamView(string, VideoStreamOptions)

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

disposeTogetherModeStreamView()

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

forbidAudio(string[])

Teams 会議の出席者の音声をユーザー ID で禁止します。

forbidOthersAudio()

Teamsの会議の音声を禁止します。

forbidOthersVideo()

Teamsの会議ビデオを禁止します。

forbidVideo(string[])

Teams 会議の出席者のビデオをユーザー ID で禁止します。

holdCall()

通話を保留にします。

leaveCall(boolean)

通話を終了する

lowerHand()

現在のユーザーのローハンド

mute()

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

muteAllRemoteParticipants()

すべての参加者をミュート

muteParticipant(string)

参加者をミュートする

onReactionClick(Reaction)

リアクション絵文字を送信する

permitAudio(string[])

Teams 会議の出席者にユーザー ID による音声を許可します。

permitOthersAudio()

Teams 会議の音声を許可します。

permitOthersVideo()

Teams 会議のビデオを許可します。

permitVideo(string[])

Teams 会議の出席者にユーザー ID による音声を許可します。

raiseHand()

現在のユーザーの手を挙げる

removeParticipant(CommunicationIdentifier)

通話から参加者を削除します。

removeParticipant(string)

通話から参加者を削除します。

resumeCall()

LocalHold状態から通話を再開します。

returnFromBreakoutRoom()

ブレイクアウトルームの発信元に戻る

sendDtmfTone(DtmfTone)

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

setCaptionLanguage(string)

キャプション言語を設定する機能

setSpokenLanguage(string)

音声言語を設定する機能

setTogetherModeSceneSize(number, number)

Together モードの着座位置を再計算します。

startCamera(VideoStreamOptions)

カメラの起動 このメソッドは、呼び出しがアクティブでないときにローカル カメラ ビューのレンダリングを開始します

startCaptions(StartCaptionsAdapterOptions)

キャプションを開始する機能

startNoiseSuppressionEffect()

ノイズ抑制効果を開始します。

startScreenShare()

通話中に画面の共有を開始します。

startSpotlight(string[])

ローカル参加者とリモート参加者のスポットライトをユーザー ID で開始します。 ユーザー ID の配列が渡されない場合、アクションはローカル参加者に対して実行されます。

startTogetherMode()

「一緒に開始」モード。

startVideoBackgroundEffect(VideoBackgroundEffect)

ビデオの背景効果を開始します。

stopAllSpotlight()

すべてのスポットライトを止める

stopCamera()

カメラを停止する このメソッドは、呼び出しがアクティブでない場合にローカル カメラ ビューのレンダリングを停止します

stopCaptions(StopCaptionsAdapterOptions)

キャプションを停止する機能

stopNoiseSuppressionEffect()

ノイズ抑制効果を停止します。

stopScreenShare()

画面の共有を停止する

stopSpotlight(string[])

ローカル参加者とリモート参加者のスポットライトを、ユーザー ID で停止します。 ユーザー ID の配列が渡されない場合、アクションはローカル参加者に対して実行されます。

stopVideoBackgroundEffects()

ビデオの背景効果を停止します。

submitSurvey(CallSurvey)

通話終了の調査結果を送信する

unmute()

通話中に現在のユーザーのミュートを解除するか、ローカルでマイクを有効にする

updateBackgroundPickerImages(VideoBackgroundImage[])

背景ピッカーの画像を上書きして、背景の置換効果を得ます。

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

選択したビデオの背景効果を更新します。

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

sendRealTimeText

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

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

プロパティ値

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

CallAdapterCallOperations.sendRealTimeTextから継承

メソッドの詳細

joinCall(boolean)

警告

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

Use joinCall(options?:JoinCallOptions) instead.

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

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

パラメーター

microphoneOn

boolean

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

戻り値

undefined | Call

joinCall(JoinCallOptions)

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

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

パラメーター

options
JoinCallOptions

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

戻り値

undefined | Call

startCall(CommunicationIdentifier[], StartCallOptions)

呼び出しを開始します。

function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): undefined | Call

パラメーター

participants

CommunicationIdentifier[]

呼び出される <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> の配列

戻り値

undefined | Call

startCall(string[], StartCallOptions)

呼び出しを開始します。

function startCall(participants: string[], options?: StartCallOptions): undefined | Call

パラメーター

participants

string[]

参加する参加者 ID の配列

戻り値

undefined | Call

継承済みメソッドの詳細

addParticipant(CommunicationUserIdentifier)

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

パラメーター

戻り値

Promise<void>

CallAdapterCallOperations.addParticipantから継承

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

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

パラメーター

participant
PhoneNumberIdentifier

戻り値

Promise<void>

CallAdapterCallOperations.addParticipantから継承

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>

注釈

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

CallAdapterCallOperations.createStreamView から継承された

createTogetherModeStreamView(TogetherModeStreamOptions)

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

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

パラメーター

options
TogetherModeStreamOptions

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

戻り値

注釈

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

CallAdapterCallOperations.createTogetherModeStreamViewから継承されます

disposeLocalVideoStreamView()

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

function disposeLocalVideoStreamView(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.disposeLocalVideoStreamViewから継承

disposeRemoteVideoStreamView(string)

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

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

パラメーター

remoteUserId

string

廃棄する参加者のID

戻り値

Promise<void>

CallAdapterCallOperations.disposeRemoteVideoStreamViewから継承

disposeScreenShareStreamView(string)

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

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

パラメーター

remoteUserId

string

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

戻り値

Promise<void>

注釈

このメソッドは、複合

CallAdapterCallOperations.disposeScreenShareStreamViewから継承

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>

注釈

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

CallAdapterCallOperations.disposeStreamView から継承された

disposeTogetherModeStreamView()

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

function disposeTogetherModeStreamView(): Promise<void>

戻り値

Promise<void>

注釈

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

CallAdapterCallOperations.disposeTogetherModeStreamViewから継承

forbidAudio(string[])

Teams 会議の出席者の音声をユーザー ID で禁止します。

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

パラメーター

userIds

string[]

戻り値

Promise<void>

CallAdapterCallOperations.forbidAudioから継承されます

forbidOthersAudio()

Teamsの会議の音声を禁止します。

function forbidOthersAudio(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.forbidOthersAudioから継承

forbidOthersVideo()

Teamsの会議ビデオを禁止します。

function forbidOthersVideo(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.forbidOthersVideoから継承

forbidVideo(string[])

Teams 会議の出席者のビデオをユーザー ID で禁止します。

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

パラメーター

userIds

string[]

戻り値

Promise<void>

CallAdapterCallOperations.forbidVideoから継承

holdCall()

通話を保留にします。

function holdCall(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.holdCallから継承されます

leaveCall(boolean)

通話を終了する

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

パラメーター

forEveryone

boolean

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

戻り値

Promise<void>

CallAdapterCallOperations.leaveCall から継承された

lowerHand()

現在のユーザーのローハンド

function lowerHand(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.lowerHandから継承されます

mute()

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

function mute(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.mute から継承された

muteAllRemoteParticipants()

すべての参加者をミュート

function muteAllRemoteParticipants(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.muteAllRemoteParticipantsから継承

muteParticipant(string)

参加者をミュートする

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

パラメーター

userId

string

ミュートする参加者のID

戻り値

Promise<void>

CallAdapterCallOperations.muteParticipantから継承されます

onReactionClick(Reaction)

リアクション絵文字を送信する

function onReactionClick(reaction: Reaction): Promise<void>

パラメーター

reaction
Reaction

戻り値

Promise<void>

CallAdapterCallOperations.onReactionClickから継承されます

permitAudio(string[])

Teams 会議の出席者にユーザー ID による音声を許可します。

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

パラメーター

userIds

string[]

戻り値

Promise<void>

CallAdapterCallOperations.permitAudioから継承されます

permitOthersAudio()

Teams 会議の音声を許可します。

function permitOthersAudio(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.permitOthersAudioから継承されます

permitOthersVideo()

Teams 会議のビデオを許可します。

function permitOthersVideo(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.permitOthersVideoから継承

permitVideo(string[])

Teams 会議の出席者にユーザー ID による音声を許可します。

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

パラメーター

userIds

string[]

戻り値

Promise<void>

CallAdapterCallOperations.permitVideoから継承

raiseHand()

現在のユーザーの手を挙げる

function raiseHand(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.raiseHandから継承

removeParticipant(CommunicationIdentifier)

通話から参加者を削除します。

function removeParticipant(participant: CommunicationIdentifier): Promise<void>

パラメーター

participant
CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 除名される参加者の

戻り値

Promise<void>

CallAdapterCallOperations.removeParticipant から継承された

removeParticipant(string)

通話から参加者を削除します。

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

パラメーター

userId

string

削除する参加者の ID

戻り値

Promise<void>

CallAdapterCallOperations.removeParticipant から継承された

resumeCall()

LocalHold状態から通話を再開します。

function resumeCall(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.resumeCallから継承されます

returnFromBreakoutRoom()

ブレイクアウトルームの発信元に戻る

function returnFromBreakoutRoom(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.returnFromBreakoutRoomから継承

sendDtmfTone(DtmfTone)

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

function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>

パラメーター

dtmfTone
DtmfTone

戻り値

Promise<void>

CallAdapterCallOperations.sendDtmfToneから継承されます

setCaptionLanguage(string)

キャプション言語を設定する機能

function setCaptionLanguage(language: string): Promise<void>

パラメーター

language

string

キャプションの言語セット

戻り値

Promise<void>

CallAdapterCallOperations.setCaptionLanguageから継承

setSpokenLanguage(string)

音声言語を設定する機能

function setSpokenLanguage(language: string): Promise<void>

パラメーター

language

string

話し言葉

戻り値

Promise<void>

CallAdapterCallOperations.setSpokenLanguageから継承されます

setTogetherModeSceneSize(number, number)

Together モードの着座位置を再計算します。

function setTogetherModeSceneSize(width: number, height: number)

パラメーター

width

number

コンテナの幅

height

number

コンテナの高さ

注釈

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

CallAdapterCallOperations.setTogetherModeSceneSizeから継承されます

startCamera(VideoStreamOptions)

カメラの起動 このメソッドは、呼び出しがアクティブでないときにローカル カメラ ビューのレンダリングを開始します

function startCamera(options?: VideoStreamOptions): Promise<void>

パラメーター

options
VideoStreamOptions

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

戻り値

Promise<void>

CallAdapterCallOperations.startCamera から継承された

startCaptions(StartCaptionsAdapterOptions)

キャプションを開始する機能

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

パラメーター

options
StartCaptionsAdapterOptions

開始キャプションのオプション

戻り値

Promise<void>

CallAdapterCallOperations.startCaptionsから継承されます

startNoiseSuppressionEffect()

ノイズ抑制効果を開始します。

function startNoiseSuppressionEffect(): Promise<void>

戻り値

Promise<void>

継承元CallAdapterCallOperations.startNoiseSuppressionEffect

startScreenShare()

通話中に画面の共有を開始します。

function startScreenShare(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.startScreenShare から継承されます

startSpotlight(string[])

ローカル参加者とリモート参加者のスポットライトをユーザー ID で開始します。 ユーザー ID の配列が渡されない場合、アクションはローカル参加者に対して実行されます。

function startSpotlight(userIds?: string[]): Promise<void>

パラメーター

userIds

string[]

戻り値

Promise<void>

継承元CallAdapterCallOperations.startSpotlight

startTogetherMode()

「一緒に開始」モード。

function startTogetherMode(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.startTogetherModeから継承されます

startVideoBackgroundEffect(VideoBackgroundEffect)

ビデオの背景効果を開始します。

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

パラメーター

videoBackgroundEffect
VideoBackgroundEffect

戻り値

Promise<void>

継承元CallAdapterCallOperations.startVideoBackgroundEffect

stopAllSpotlight()

すべてのスポットライトを止める

function stopAllSpotlight(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.stopAllSpotlightから継承

stopCamera()

カメラを停止する このメソッドは、呼び出しがアクティブでない場合にローカル カメラ ビューのレンダリングを停止します

function stopCamera(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.stopCamera から継承された

stopCaptions(StopCaptionsAdapterOptions)

キャプションを停止する機能

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

パラメーター

戻り値

Promise<void>

CallAdapterCallOperations.stopCaptionsから継承されます

stopNoiseSuppressionEffect()

ノイズ抑制効果を停止します。

function stopNoiseSuppressionEffect(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.stopNoiseSuppressionEffectから継承されます

stopScreenShare()

画面の共有を停止する

function stopScreenShare(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.stopScreenShare から継承された

stopSpotlight(string[])

ローカル参加者とリモート参加者のスポットライトを、ユーザー ID で停止します。 ユーザー ID の配列が渡されない場合、アクションはローカル参加者に対して実行されます。

function stopSpotlight(userIds?: string[]): Promise<void>

パラメーター

userIds

string[]

戻り値

Promise<void>

CallAdapterCallOperations.stopSpotlightから継承

stopVideoBackgroundEffects()

ビデオの背景効果を停止します。

function stopVideoBackgroundEffects(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.stopVideoBackgroundEffectsから継承

submitSurvey(CallSurvey)

通話終了の調査結果を送信する

function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

パラメーター

survey
CallSurvey

戻り値

Promise<undefined | CallSurveyResponse>

CallAdapterCallOperations.submitSurveyから継承されます

unmute()

通話中に現在のユーザーのミュートを解除するか、ローカルでマイクを有効にする

function unmute(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.unmute から継承された

updateBackgroundPickerImages(VideoBackgroundImage[])

背景ピッカーの画像を上書きして、背景の置換効果を得ます。

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

パラメーター

backgroundImages

VideoBackgroundImage[]

カスタム背景画像の配列。

継承元CallAdapterCallOperations.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

選択したビデオの背景効果を更新します。

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

パラメーター

selectedVideoBackground
VideoBackgroundEffect

CallAdapterCallOperations.updateSelectedVideoBackgroundEffectから継承