共用方式為

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[]

要加入的參與者標識碼陣列

options
StartCallOptions

傳回

undefined | Call

繼承的方法的詳細資料

createStreamView(string, VideoStreamOptions)

建立數據流的 HTML 檢視。

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

參數

remoteUserId

string

要轉譯的參與者標識碼，讓它保持未定義以建立本機相機檢視

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

要轉譯的參與者標識碼，讓它保持未定義以處置本機相機檢視

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

要移除之參與者的標識碼

傳回

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