CallAdapterCallManagement interface

套件:

@azure/communication-react

警告

此 API 現已淘汰。

CallAdapter interface will be flatten, consider using CallAdapter directly

管理目前通話或啟動新通話的功能

Extends

CallAdapterCallOperations

繼承的屬性

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[])	通過使用者ID禁止Teams與會者觀看視頻。
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)	向 1 對 1 PSTN 呼叫中的另一位參與者發送 DTMF 音調
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

param 設置麥克風/攝像頭初始開啟/關閉/使用呼叫前狀態。

傳回

undefined | Call

startCall(CommunicationIdentifier[], StartCallOptions)

啟動呼叫。

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

參數

participants

CommunicationIdentifier[]

要調用的 <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 陣列

options

StartCallOptions

傳回

undefined | Call

startCall(string[], StartCallOptions)

啟動呼叫。

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

參數

participants

string[]

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

options

StartCallOptions

傳回

undefined | Call

繼承的方法的詳細資料

addParticipant(CommunicationUserIdentifier)

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

參數

participant

CommunicationUserIdentifier

傳回

Promise<void>

繼承自CallAdapterCallOperations.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

將參與者新增至通話。

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

參數

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

傳回

Promise<void>

繼承自CallAdapterCallOperations.addParticipant

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

createTogetherModeStreamView(TogetherModeStreamOptions)

建立數據流的 HTML 檢視。

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

參數

options

TogetherModeStreamOptions

控制影片串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

傳回

Promise<void | TogetherModeStreamViewResult>

備註

這個方法已針對複合實作

繼承自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>

備註

該方法為 composite 實現

繼承自CallAdapterCallOperations.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

警告

此 API 現已淘汰。

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

處置數據流的 HTML 檢視。

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

參數

remoteUserId

string

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

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

通過使用者ID禁止Teams與會者觀看視頻。

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

要移除之參與者的標識碼

傳回

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)

向 1 對 1 PSTN 呼叫中的另一位參與者發送 DTMF 音調

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>

參數

options

StopCaptionsAdapterOptions

傳回

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