CommonCallAdapter interface
CallComposite Adapter 介面。
- Extends
繼承的屬性
| send |
發送即時文本 |
方法
| join |
使用麥克風一開始開啟/關閉來加入通話。 |
| join |
使用選項包加入通話，在加入通話時設置麥克風/攝像頭初始狀態 true = 加入通話時打開設備 false = 加入通話時關閉設備 'keep'/undefined = 保留設備的通話前狀態 |
| start |
啟動呼叫。 |
| start |
啟動呼叫。 |
繼承的方法
繼承的屬性詳細資料
sendRealTimeText
發送即時文本
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>屬性值
(text: string, isFinalized: boolean) => Promise<void>
方法詳細資料
joinCall(boolean)
警告
此 API 現已淘汰。
Use joinCall(options?:JoinCallOptions) instead.
使用麥克風一開始開啟/關閉來加入通話。
function joinCall(microphoneOn?: boolean)參數
- microphoneOn
-
boolean
是否一開始啟用麥克風
joinCall(JoinCallOptions)
使用選項包加入通話，在加入通話時設置麥克風/攝像頭初始狀態 true = 加入通話時打開設備 false = 加入通話時關閉設備 'keep'/undefined = 保留設備的通話前狀態
function joinCall(options?: JoinCallOptions)參數
- options
- JoinCallOptions
param 設置麥克風/攝像頭初始開啟/關閉/使用呼叫前狀態。
startCall(CommunicationIdentifier[], StartCallOptions)
啟動呼叫。
function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions)參數
- participants
要調用的 <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 陣列
- options
- StartCallOptions
startCall(string[], StartCallOptions)
啟動呼叫。
function startCall(participants: string[], options?: StartCallOptions)參數
- participants
-
string[]
要加入的參與者標識碼陣列
- options
- StartCallOptions
繼承的方法的詳細資料
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>
askDevicePermission(PermissionConstraints)
要求裝置的許可權。
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>參數
- constrain
- PermissionConstraints
定義存取本機裝置的條件約束 <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
傳回
Promise<DeviceAccess>
備註
如果尚未授與許可權，瀏覽器許可權視窗將會快顯
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>
備註
這個方法已針對複合實作
dispose()
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>
getState()
holdCall()
leaveCall(boolean)
離開通話
function leaveCall(forEveryone?: boolean): Promise<void>參數
- forEveryone
-
boolean
是否要在離開時移除所有參與者
傳回
Promise<void>
lowerHand()
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>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
“breakoutRoomsUpdated”事件的取消訂閱函數。
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)參數
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
off("callEnded", CallEndedListener)
'callEnded' 事件的取消訂閱函式。
function off(event: "callEnded", listener: CallEndedListener)參數
- event
-
"callEnded"
- listener
- CallEndedListener
off("callIdChanged", CallIdChangedListener)
'callIdChanged' 事件的取消訂閱函式。
function off(event: "callIdChanged", listener: CallIdChangedListener)參數
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
off("capabilitiesChanged", CapabilitiesChangedListener)
unsubscribe 函數。
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)參數
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
off("captionsReceived", CaptionsReceivedListener)
'captionsReceived' 事件的取消訂閱函數。
function off(event: "captionsReceived", listener: CaptionsReceivedListener)參數
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
off("diagnosticChanged", DiagnosticChangedEventListner)
'diagnosticChanged' 事件的取消訂閱函式。
function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)參數
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
off("displayNameChanged", DisplayNameChangedListener)
'displayNameChanged' 事件的取消訂閱函式。
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)參數
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
off("error", (e: AdapterError) => void)
取消訂閱 『error』 事件的函式。
function off(event: "error", listener: (e: AdapterError) => void)參數
- event
-
"error"
- listener
-
(e: AdapterError) => void
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
取消訂閱函數。
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)參數
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
'isCaptionsActiveChanged' 事件的取消訂閱函數。
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)參數
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
'isLocalScreenSharingActiveChanged' 事件的取消訂閱函式。
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)參數
- event
-
"isLocalScreenSharingActiveChanged"
off("isMutedChanged", IsMutedChangedListener)
'isMutedChanged' 事件的取消訂閱函式。
function off(event: "isMutedChanged", listener: IsMutedChangedListener)參數
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
off("isSpeakingChanged", IsSpeakingChangedListener)
'isSpeakingChanged' 事件的取消訂閱函式。
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)參數
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
'isSpokenLanguageChanged' 事件的取消訂閱函數。
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)參數
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
off("mutedByOthers", PropertyChangedEvent)
'mutedByOthers' 事件的 Unsubscribe 函數。
function off(event: "mutedByOthers", listener: PropertyChangedEvent)參數
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
off("participantsJoined", ParticipantsJoinedListener)
'participantsJoined' 事件的取消訂閱函式。
function off(event: "participantsJoined", listener: ParticipantsJoinedListener)參數
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
off("participantsLeft", ParticipantsLeftListener)
'participantsLeft' 事件的取消訂閱函式。
function off(event: "participantsLeft", listener: ParticipantsLeftListener)參數
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
off("realTimeTextReceived", RealTimeTextReceivedListener)
'realTimeTextReceived' 事件的 Unsubscribe 函數。
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)參數
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
off("roleChanged", PropertyChangedEvent)
'roleChanged' 事件的 Unsubscribe 函數。
function off(event: "roleChanged", listener: PropertyChangedEvent)參數
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
off("selectedMicrophoneChanged", PropertyChangedEvent)
取消訂閱 『selectedMicrophoneChanged』 事件的函式。
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)參數
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
off("selectedSpeakerChanged", PropertyChangedEvent)
'selectedSpeakerChanged' 事件的取消訂閱函式。
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)參數
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
off("spotlightChanged", SpotlightChangedListener)
unsubscribe 函數。
function off(event: "spotlightChanged", listener: SpotlightChangedListener)參數
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
off("transferAccepted", TransferAcceptedListener)
unsubscribe 函數。
function off(event: "transferAccepted", listener: TransferAcceptedListener)參數
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
offStateChange((state: CallAdapterState) => void)
將處理程式取消訂閱至 stateChanged 事件。
function offStateChange(handler: (state: CallAdapterState) => void)參數
- handler
-
(state: CallAdapterState) => void
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
“breakoutRoomsUpdated”事件的訂閱函數。
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)參數
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
on("callEnded", CallEndedListener)
'callEnded' 事件的 Subscribe 函式。
function on(event: "callEnded", listener: CallEndedListener)參數
- event
-
"callEnded"
- listener
- CallEndedListener
on("callIdChanged", CallIdChangedListener)
'callIdChanged' 事件的 Subscribe 函式。
function on(event: "callIdChanged", listener: CallIdChangedListener)參數
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
備註
當目前使用者的 callId 變更時，將會觸發事件。
on("capabilitiesChanged", CapabilitiesChangedListener)
'capabilitiesChanged' 事件的 Subscribe 函數。
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)參數
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
on("captionsReceived", CaptionsReceivedListener)
'captionsReceived' 事件的訂閱函數。
function on(event: "captionsReceived", listener: CaptionsReceivedListener)參數
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
on("diagnosticChanged", DiagnosticChangedEventListner)
'diagnosticChanged' 事件的訂閱函式。
每當使用者面臨有關進行中呼叫的診斷變更時，就會引發此事件。
function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)參數
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
on("displayNameChanged", DisplayNameChangedListener)
'displayNameChanged' 事件的 Subscribe 函式。
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)參數
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
on("error", (e: AdapterError) => void)
'error' 事件的訂閱函式。
function on(event: "error", listener: (e: AdapterError) => void)參數
- event
-
"error"
- listener
-
(e: AdapterError) => void
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
訂閱 'isCaptionLanguageChanged' 事件的函數。
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)參數
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
“isCaptionsActiveChanged”事件的訂閱函數。
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)參數
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
'isLocalScreenSharingActiveChanged' 事件的訂閱函式。
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)參數
- event
-
"isLocalScreenSharingActiveChanged"
on("isMutedChanged", IsMutedChangedListener)
'isMutedChanged' 事件的訂閱函式。
function on(event: "isMutedChanged", listener: IsMutedChangedListener)參數
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
備註
每當目前的使用者或遠端使用者靜音狀態變更時，就會觸發事件
on("isSpeakingChanged", IsSpeakingChangedListener)
'isSpeakingChanged' 事件的 Subscribe 函式。
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)參數
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
訂閱 'isSpokenLanguageChanged' 事件的函數。
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)參數
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
on("mutedByOthers", PropertyChangedEvent)
'mutedByOthers' 事件的 subscribe 函數。
function on(event: "mutedByOthers", listener: PropertyChangedEvent)參數
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
on("participantsJoined", ParticipantsJoinedListener)
'participantsJoined' 事件的訂閱函式。
function on(event: "participantsJoined", listener: ParticipantsJoinedListener)參數
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
on("participantsLeft", ParticipantsLeftListener)
'participantsLeft' 事件的訂閱函式。
function on(event: "participantsLeft", listener: ParticipantsLeftListener)參數
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
on("realTimeTextReceived", RealTimeTextReceivedListener)
'realTimeTextReceived' 事件的訂閱函數。
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)參數
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
on("roleChanged", PropertyChangedEvent)
'roleChanged' 事件的 Subscribe 函數。
function on(event: "roleChanged", listener: PropertyChangedEvent)參數
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
on("selectedMicrophoneChanged", PropertyChangedEvent)
'selectedMicrophoneChanged' 事件的訂閱函式。
每當用戶選取新的麥克風裝置時，就會引發此事件。
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)參數
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
on("selectedSpeakerChanged", PropertyChangedEvent)
'selectedSpeakerChanged' 事件的訂閱函式。
每當用戶選取新的喇叭裝置時，就會引發此事件。
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)參數
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
on("spotlightChanged", SpotlightChangedListener)
'spotlightChanged' 事件的訂閱函數。
function on(event: "spotlightChanged", listener: SpotlightChangedListener)參數
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
on("transferAccepted", TransferAcceptedListener)
'transferRequested' 事件的 Subscribe 函數。
function on(event: "transferAccepted", listener: TransferAcceptedListener)參數
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
onReactionClick(Reaction)
發送反應表情符號
function onReactionClick(reaction: Reaction): Promise<void>參數
- reaction
- Reaction
傳回
Promise<void>
onStateChange((state: CallAdapterState) => void)
訂閱處理程式至 stateChanged 事件。
function onStateChange(handler: (state: CallAdapterState) => void)參數
- handler
-
(state: CallAdapterState) => 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>
queryCameras()
查詢可用的相機裝置。
function queryCameras(): Promise<VideoDeviceInfo[]>傳回
Promise<VideoDeviceInfo[]>
視訊裝置資訊實體陣列 <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
備註
這個方法應在 askDevicePermission（） 之後呼叫
queryMicrophones()
查詢可用的麥克風裝置。
function queryMicrophones(): Promise<AudioDeviceInfo[]>傳回
Promise<AudioDeviceInfo[]>
音訊裝置資訊實體陣列 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
備註
這個方法應在 askDevicePermission（） 之後呼叫
querySpeakers()
查詢可用的揚聲器設備。
function querySpeakers(): Promise<AudioDeviceInfo[]>傳回
Promise<AudioDeviceInfo[]>
音訊裝置資訊實體陣列 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
備註
這個方法應在 askDevicePermission（） 之後呼叫
raiseHand()
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>
setCamera(VideoDeviceInfo, VideoStreamOptions)
設定要用於呼叫中的相機。
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>參數
- sourceInfo
- VideoDeviceInfo
要選擇的相機裝置，挑選 查詢Cameras 傳回的相機裝置
- options
- VideoStreamOptions
控制相機串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
傳回
Promise<void>
setCaptionLanguage(string)
設置字幕語言的功能
function setCaptionLanguage(language: string): Promise<void>參數
- language
-
string
為字幕設置的語言
傳回
Promise<void>
setMicrophone(AudioDeviceInfo)
將麥克風設定為在通話中使用。
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>參數
- sourceInfo
- AudioDeviceInfo
要選擇的麥克風裝置，挑選由 queryMicrophones 傳回的麥克風裝置
傳回
Promise<void>
setSpeaker(AudioDeviceInfo)
將說話者設定為在通話中使用。
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>參數
- sourceInfo
- AudioDeviceInfo
要選擇的喇叭裝置，挑選 querySpeakers 所傳回的裝置
傳回
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
繼承自CallAdapterCallOperations.updateSelectedVideoBackgroundEffect