CallAdapterCallOperations interface
管理目前呼叫的功能。
屬性
| send |
發送即時文本 |
方法
屬性詳細資料
sendRealTimeText
發送即時文本
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>屬性值
(text: string, isFinalized: boolean) => Promise<void>
方法詳細資料
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>參數
- participant
- CommunicationUserIdentifier
傳回
Promise<void>
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
將參與者新增至通話。
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>參數
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
傳回
Promise<void>
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>
備註
這個方法已針對複合實作
createTogetherModeStreamView(TogetherModeStreamOptions)
建立數據流的 HTML 檢視。
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>參數
- options
- TogetherModeStreamOptions
控制影片串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
傳回
Promise<void | TogetherModeStreamViewResult>
備註
這個方法已針對複合實作
disposeLocalVideoStreamView()
釋放本地視頻流的 html 視圖
function disposeLocalVideoStreamView(): Promise<void>傳回
Promise<void>
disposeRemoteVideoStreamView(string)
釋放遠端視頻流的 html 視圖
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>參數
- remoteUserId
-
string
要處置的參與者的ID
傳回
Promise<void>
disposeScreenShareStreamView(string)
釋放螢幕共用流的 html 視圖
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>參數
- remoteUserId
-
string
要為其處理螢幕共用流視圖的參與者的ID。
傳回
Promise<void>
備註
該方法為 composite 實現
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>
備註
這個方法已針對複合實作
disposeTogetherModeStreamView()
處置數據流的 HTML 檢視。
function disposeTogetherModeStreamView(): Promise<void>傳回
Promise<void>
備註
這個方法已針對複合實作
forbidAudio(string[])
禁止 Teams 出席者通過其使用者 ID 進行音訊。
function forbidAudio(userIds: string[]): Promise<void>參數
- userIds
-
string[]
傳回
Promise<void>
forbidOthersAudio()
禁止 Teams 會議音訊。
function forbidOthersAudio(): Promise<void>傳回
Promise<void>
forbidOthersVideo()
禁止 Teams 會議視頻。
function forbidOthersVideo(): Promise<void>傳回
Promise<void>
forbidVideo(string[])
通過使用者ID禁止Teams與會者觀看視頻。
function forbidVideo(userIds: string[]): Promise<void>參數
- userIds
-
string[]
傳回
Promise<void>
holdCall()
保持呼叫。
function holdCall(): Promise<void>傳回
Promise<void>
leaveCall(boolean)
離開通話
function leaveCall(forEveryone?: boolean): Promise<void>參數
- forEveryone
-
boolean
是否要在離開時移除所有參與者
傳回
Promise<void>
lowerHand()
當前使用者降低
function lowerHand(): Promise<void>傳回
Promise<void>
mute()
在通話期間將目前的用戶靜音，或在本機停用麥克風
function mute(): Promise<void>傳回
Promise<void>
muteAllRemoteParticipants()
將所有參與者靜音
function muteAllRemoteParticipants(): Promise<void>傳回
Promise<void>
muteParticipant(string)
將參與者靜音
function muteParticipant(userId: string): Promise<void>參數
- userId
-
string
要靜音的參與者的ID
傳回
Promise<void>
onReactionClick(Reaction)
發送反應表情符號
function onReactionClick(reaction: Reaction): Promise<void>參數
- reaction
- Reaction
傳回
Promise<void>
permitAudio(string[])
允許 Teams 出席者通過其使用者 ID 進行音訊會議。
function permitAudio(userIds: string[]): Promise<void>參數
- userIds
-
string[]
傳回
Promise<void>
permitOthersAudio()
允許 Teams 會議音訊。
function permitOthersAudio(): Promise<void>傳回
Promise<void>
permitOthersVideo()
允許 Teams 會議視頻。
function permitOthersVideo(): Promise<void>傳回
Promise<void>
permitVideo(string[])
允許 Teams 出席者通過其使用者 ID 進行音訊會議。
function permitVideo(userIds: string[]): Promise<void>參數
- userIds
-
string[]
傳回
Promise<void>
raiseHand()
為當前用戶舉手
function raiseHand(): Promise<void>傳回
Promise<void>
removeParticipant(CommunicationIdentifier)
從通話中移除參與者。
function removeParticipant(participant: CommunicationIdentifier): Promise<void>參數
- participant
- CommunicationIdentifier
<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 要刪除的參與者
傳回
Promise<void>
removeParticipant(string)
從通話中移除參與者。
function removeParticipant(userId: string): Promise<void>參數
- userId
-
string
要移除之參與者的標識碼
傳回
Promise<void>
resumeCall()
從狀態 LocalHold 恢復調用。
function resumeCall(): Promise<void>傳回
Promise<void>
returnFromBreakoutRoom()
返回分組討論室的源站呼叫
function returnFromBreakoutRoom(): Promise<void>傳回
Promise<void>
sendDtmfTone(DtmfTone)
向 1 對 1 PSTN 呼叫中的另一位參與者發送 DTMF 音調
function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>參數
- dtmfTone
- DtmfTone
傳回
Promise<void>
setCaptionLanguage(string)
設置字幕語言的功能
function setCaptionLanguage(language: string): Promise<void>參數
- language
-
string
為字幕設置的語言
傳回
Promise<void>
setSpokenLanguage(string)
設置口語的功能
function setSpokenLanguage(language: string): Promise<void>參數
- language
-
string
口語
傳回
Promise<void>
setTogetherModeSceneSize(number, number)
重新計算 Together 模式的座位位置。
function setTogetherModeSceneSize(width: number, height: number)參數
- width
-
number
容器的寬度
- height
-
number
容器的高度
備註
這個方法已針對複合實作
startCamera(VideoStreamOptions)
啟動相機 此方法會在呼叫未使用時開始轉譯本機相機檢視
function startCamera(options?: VideoStreamOptions): Promise<void>參數
- options
- VideoStreamOptions
控制影片串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
傳回
Promise<void>
startCaptions(StartCaptionsAdapterOptions)
啟動字幕的功能
function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>參數
- options
- StartCaptionsAdapterOptions
開始字幕的選項
傳回
Promise<void>
startNoiseSuppressionEffect()
啟動雜訊抑制效果。
function startNoiseSuppressionEffect(): Promise<void>傳回
Promise<void>
startScreenShare()
開始在通話期間共享畫面。
function startScreenShare(): Promise<void>傳回
Promise<void>
startSpotlight(string[])
按本地和遠端參與者的使用者ID啟動聚焦。 如果未傳遞使用者 ID 陣列，則對本地參與者執行作。
function startSpotlight(userIds?: string[]): Promise<void>參數
- userIds
-
string[]
傳回
Promise<void>
startTogetherMode()
“一起啟動”模式。
function startTogetherMode(): Promise<void>傳回
Promise<void>
startVideoBackgroundEffect(VideoBackgroundEffect)
啟動視頻背景效果。
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>參數
- videoBackgroundEffect
- VideoBackgroundEffect
傳回
Promise<void>
stopAllSpotlight()
停止所有聚光燈
function stopAllSpotlight(): Promise<void>傳回
Promise<void>
stopCamera()
停止相機 此方法會在呼叫未使用時停止轉譯本機相機檢視
function stopCamera(): Promise<void>傳回
Promise<void>
stopCaptions(StopCaptionsAdapterOptions)
停止字幕的功能
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>參數
- options
- StopCaptionsAdapterOptions
傳回
Promise<void>
stopNoiseSuppressionEffect()
停止雜訊抑制效果。
function stopNoiseSuppressionEffect(): Promise<void>傳回
Promise<void>
stopScreenShare()
停止共享畫面
function stopScreenShare(): Promise<void>傳回
Promise<void>
stopSpotlight(string[])
通過使用者 ID 為本地和遠端參與者停止聚焦。 如果未傳遞使用者 ID 陣列，則對本地參與者執行作。
function stopSpotlight(userIds?: string[]): Promise<void>參數
- userIds
-
string[]
傳回
Promise<void>
stopVideoBackgroundEffects()
停止視頻背景效果。
function stopVideoBackgroundEffects(): Promise<void>傳回
Promise<void>
submitSurvey(CallSurvey)
發送通話結束調查結果
function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>參數
- survey
- CallSurvey
傳回
Promise<undefined | CallSurveyResponse>
unmute()
在通話期間取消靜音目前的使用者，或在本機啟用麥克風
function unmute(): Promise<void>傳回
Promise<void>
updateBackgroundPickerImages(VideoBackgroundImage[])
覆蓋背景選取器圖像以獲得背景替換效果。
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])參數
- backgroundImages
自訂背景圖像陣列。
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
更新所選視頻背景效果。
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)參數
- selectedVideoBackground
- VideoBackgroundEffect