CallAdapterCallOperations interface
現在の呼び出しを管理するための機能。
メソッド
| create |
ストリームの html ビューを作成します。 |
| dispose |
ストリームの html ビューを破棄します。 |
| leave |
通話を終了する |
| mute() | 通話中に現在のユーザーをミュートするか、マイクをローカルで無効にする |
| remove |
通話から参加者を削除します。 |
| start |
カメラを起動する このメソッドは、呼び出しがアクティブでないときにローカル カメラ ビューのレンダリングを開始します |
| start |
通話中に画面の共有を開始します。 |
| stop |
カメラを停止する このメソッドは、呼び出しがアクティブでない場合にローカル カメラ ビューのレンダリングを停止します |
| stop |
画面の共有を停止する |
| unmute() | 通話中に現在のユーザーのミュートを解除するか、マイクをローカルで有効にする |
メソッドの詳細
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>
注釈
このメソッドは、複合
disposeStreamView(string, VideoStreamOptions)
ストリームの html ビューを破棄します。
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>パラメーター
- remoteUserId
-
string
レンダリングする参加者の ID。ローカル カメラ ビューを破棄するには未定義のままにします
- options
- VideoStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void>
注釈
このメソッドは、複合
leaveCall(boolean)
通話を終了する
function leaveCall(forEveryone?: boolean): Promise<void>パラメーター
- forEveryone
-
boolean
退出時にすべての参加者を削除するかどうか
戻り値
Promise<void>
mute()
通話中に現在のユーザーをミュートするか、マイクをローカルで無効にする
function mute(): Promise<void>戻り値
Promise<void>
removeParticipant(string)
通話から参加者を削除します。
function removeParticipant(userId: string): Promise<void>パラメーター
- userId
-
string
削除する参加者の ID
戻り値
Promise<void>
startCamera(VideoStreamOptions)
カメラを起動する このメソッドは、呼び出しがアクティブでないときにローカル カメラ ビューのレンダリングを開始します
function startCamera(options?: VideoStreamOptions): Promise<void>パラメーター
- options
- VideoStreamOptions
ビデオ ストリームのレンダリング方法を制御するオプション <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
戻り値
Promise<void>
startScreenShare()
通話中に画面の共有を開始します。
function startScreenShare(): Promise<void>戻り値
Promise<void>
stopCamera()
カメラを停止する このメソッドは、呼び出しがアクティブでない場合にローカル カメラ ビューのレンダリングを停止します
function stopCamera(): Promise<void>戻り値
Promise<void>
stopScreenShare()
画面の共有を停止する
function stopScreenShare(): Promise<void>戻り値
Promise<void>
unmute()
通話中に現在のユーザーのミュートを解除するか、マイクをローカルで有効にする
function unmute(): Promise<void>戻り値
Promise<void>