CallAdapterCallManagement interface

パッケージ:

@azure/communication-react

警告

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

CallAdapter interface will be flatten, consider using CallAdapter directly

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

Extends

CallAdapterCallOperations

メソッド

joinCall(boolean)	最初にマイクをオン/オフにして通話に参加します。
startCall(string[], StartCallOptions)	呼び出しを開始します。

継承されたメソッド

createStreamView(string, VideoStreamOptions)	ストリームの HTML ビューを作成します。
disposeStreamView(string, VideoStreamOptions)	ストリームの html ビューを破棄します。
leaveCall(boolean)	通話を終了する
mute()	通話中に現在のユーザーをミュートするか、ローカルでマイクを無効にする
removeParticipant(string)	通話から参加者を削除します。
startCamera(VideoStreamOptions)	カメラの起動 このメソッドは、呼び出しがアクティブでないときにローカル カメラ ビューのレンダリングを開始します
startScreenShare()	通話中に画面の共有を開始します。
stopCamera()	カメラを停止する このメソッドは、呼び出しがアクティブでない場合にローカル カメラ ビューのレンダリングを停止します
stopScreenShare()	画面の共有を停止する
unmute()	通話中に現在のユーザーのミュートを解除するか、ローカルでマイクを有効にする

メソッドの詳細

joinCall(boolean)

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

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

パラメーター

microphoneOn

boolean

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

戻り値

undefined | Call

startCall(string[], StartCallOptions)

呼び出しを開始します。

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

パラメーター

participants

string[]

参加する参加者 ID の配列

options

StartCallOptions

戻り値

undefined | Call

継承済みメソッドの詳細

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 から継承された

disposeStreamView(string, VideoStreamOptions)

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

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

パラメーター

remoteUserId

string

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

options

VideoStreamOptions

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

戻り値

Promise<void>

注釈

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

CallAdapterCallOperations.disposeStreamView から継承された

leaveCall(boolean)

通話を終了する

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

パラメーター

forEveryone

boolean

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

戻り値

Promise<void>

CallAdapterCallOperations.leaveCall から継承された

mute()

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

function mute(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.mute から継承された

removeParticipant(string)

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

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

パラメーター

userId

string

削除する参加者の ID

戻り値

Promise<void>

CallAdapterCallOperations.removeParticipant から継承された

startCamera(VideoStreamOptions)

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

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

パラメーター

options

VideoStreamOptions

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

戻り値

Promise<void>

CallAdapterCallOperations.startCamera から継承された

startScreenShare()

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

function startScreenShare(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.startScreenShare から継承されます

stopCamera()

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

function stopCamera(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.stopCamera から継承された

stopScreenShare()

画面の共有を停止する

function stopScreenShare(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.stopScreenShare から継承された

unmute()

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

function unmute(): Promise<void>

戻り値

Promise<void>

CallAdapterCallOperations.unmute から継承された