CallWithChatAdapter interface
CallWithChatComposite Adapter 介面。
- Extends
繼承的屬性
| forbid |
禁止對指定的 User ID 進行音訊作。 |
| forbid |
禁止 Teams 會議出席者（本地使用者除外）使用音訊。 |
| forbid |
禁止 Teams 會議出席者（本地使用者除外）觀看視頻。 |
| forbid |
禁止指定 User ID 的視頻。 |
| permit |
允許指定 User ID 的音訊。 |
| permit |
允許 Teams 會議出席者（本地使用者除外）使用音訊。 |
| permit |
允許 Teams 會議出席者（本地使用者除外）觀看視頻。 |
| permit |
允許指定使用者 ID 的視頻。 |
| send |
在 1 對 1 通話中向呼叫中的其他參與者發送 DTMF 音調 |
| send |
發送即時文本 |
繼承的方法
繼承的屬性詳細資料
forbidAudio
禁止對指定的 User ID 進行音訊作。
forbidAudio: (userIds: string[]) => Promise<void>屬性值
(userIds: string[]) => Promise<void>
forbidOthersAudio
禁止 Teams 會議出席者（本地使用者除外）使用音訊。
forbidOthersAudio: () => Promise<void>屬性值
() => Promise<void>
forbidOthersVideo
禁止 Teams 會議出席者（本地使用者除外）觀看視頻。
forbidOthersVideo: () => Promise<void>屬性值
() => Promise<void>
forbidVideo
禁止指定 User ID 的視頻。
forbidVideo: (userIds: string[]) => Promise<void>屬性值
(userIds: string[]) => Promise<void>
permitAudio
允許指定 User ID 的音訊。
permitAudio: (userIds: string[]) => Promise<void>屬性值
(userIds: string[]) => Promise<void>
permitOthersAudio
允許 Teams 會議出席者（本地使用者除外）使用音訊。
permitOthersAudio: () => Promise<void>屬性值
() => Promise<void>
permitOthersVideo
允許 Teams 會議出席者（本地使用者除外）觀看視頻。
permitOthersVideo: () => Promise<void>屬性值
() => Promise<void>
permitVideo
允許指定使用者 ID 的視頻。
permitVideo: (userIds: string[]) => Promise<void>屬性值
(userIds: string[]) => Promise<void>
sendDtmfTone
在 1 對 1 通話中向呼叫中的其他參與者發送 DTMF 音調
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>屬性值
(dtmfTone: DtmfTone) => Promise<void>
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>
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)
為 togethermode 流創建 html 視圖。
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>參數
- options
- TogetherModeStreamOptions
控制影片串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
傳回
Promise<void | TogetherModeStreamViewResult>
備註
這個方法已針對複合實作
繼承自CallWithChatAdapterManagement.createTogetherModeStreamView
deleteMessage(string)
刪除線程中的訊息。
function deleteMessage(messageId: string): Promise<void>參數
- messageId
-
string
傳回
Promise<void>
dispose()
disposeLocalVideoStreamView()
釋放本地視頻流的 html 視圖
function disposeLocalVideoStreamView(): Promise<void>傳回
Promise<void>
繼承自CallWithChatAdapterManagement.disposeLocalVideoStreamView
disposeRemoteVideoStreamView(string)
釋放遠端視頻流的 html 視圖
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>參數
- remoteUserId
-
string
要處置的參與者的ID
傳回
Promise<void>
繼承自CallWithChatAdapterManagement.disposeRemoteVideoStreamView
disposeScreenShareStreamView(string)
釋放螢幕共用流的 html 視圖
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>參數
- remoteUserId
-
string
要為其處理螢幕共用流視圖的參與者的ID。
傳回
Promise<void>
備註
該方法為 composite 實現
繼承自CallWithChatAdapterManagement.disposeScreenShareStreamView
disposeStreamView(string, VideoStreamOptions)
處置數據流的 HTML 檢視。
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>參數
- remoteUserId
-
string
要轉譯的參與者標識碼，讓它保持未定義以處置本機相機檢視
- options
- VideoStreamOptions
控制影片串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
傳回
Promise<void>
備註
這個方法會針對複合實作。
disposeTogetherModeStreamView()
釋放 togethermode 流的 html 視圖。
function disposeTogetherModeStreamView(): Promise<void>傳回
Promise<void>
備註
這個方法已針對複合實作
繼承自CallWithChatAdapterManagement.disposeTogetherModeStreamView
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>參數
- resourceDetails
- ResourceDetails
傳回
Promise<void>
fetchInitialData()
擷取聊天配接器的初始狀態。
執行 ChatComposite 和 API 方法所需的最小擷取。
function fetchInitialData(): Promise<void>傳回
Promise<void>
getState()
取得目前狀態
function getState(): CallWithChatAdapterState傳回
holdCall()
將呼叫置於本地保留中。
function holdCall(): Promise<void>傳回
Promise<void>
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
leaveCall(boolean)
離開通話。
function leaveCall(forEveryone?: boolean): Promise<void>參數
- forEveryone
-
boolean
是否要在離開時移除所有參與者
傳回
Promise<void>
loadPreviousChatMessages(number)
在聊天對話歷程記錄中載入更多先前的訊息。
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>參數
- messagesToLoad
-
number
傳回
Promise<boolean>
備註
這個方法通常用來控制累加式擷取/無限捲動。
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
傳回
Promise<void>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)參數
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)參數
- event
-
"callEnded"
- listener
- CallEndedListener
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)參數
- event
-
"callError"
- listener
-
(e: AdapterError) => void
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)參數
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)參數
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)參數
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
off("capabilitiesChanged", CapabilitiesChangedListener)
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)參數
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
off("captionsReceived", CaptionsReceivedListener)
function off(event: "captionsReceived", listener: CaptionsReceivedListener)參數
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)參數
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
off("chatInitialized", ChatInitializedListener)
function off(event: "chatInitialized", listener: ChatInitializedListener)參數
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)參數
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)參數
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)參數
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)參數
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)參數
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)參數
- event
-
"isLocalScreenSharingActiveChanged"
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)參數
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)參數
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)參數
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
off("messageDeleted", MessageReceivedListener)
function off(event: "messageDeleted", listener: MessageReceivedListener)參數
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
off("messageEdited", MessageReceivedListener)
function off(event: "messageEdited", listener: MessageReceivedListener)參數
- event
-
"messageEdited"
- listener
- MessageReceivedListener
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)參數
- event
-
"messageRead"
- listener
- MessageReadListener
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)參數
- event
-
"messageReceived"
- listener
- MessageReceivedListener
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)參數
- event
-
"messageSent"
- listener
- MessageReceivedListener
off("realTimeTextReceived", RealTimeTextReceivedListener)
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)參數
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)參數
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)參數
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
off("spotlightChanged", SpotlightChangedListener)
function off(event: "spotlightChanged", listener: SpotlightChangedListener)參數
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
offStateChange((state: CallWithChatAdapterState) => void)
將處理程式取消訂閱至 stateChanged 事件。
function offStateChange(handler: (state: CallWithChatAdapterState) => void)參數
- handler
-
(state: CallWithChatAdapterState) => void
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)參數
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)參數
- event
-
"callEnded"
- listener
- CallEndedListener
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)參數
- event
-
"callError"
- listener
-
(e: AdapterError) => void
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)參數
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)參數
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)參數
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
on("capabilitiesChanged", CapabilitiesChangedListener)
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)參數
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
on("captionsReceived", CaptionsReceivedListener)
function on(event: "captionsReceived", listener: CaptionsReceivedListener)參數
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)參數
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
on("chatInitialized", ChatInitializedListener)
function on(event: "chatInitialized", listener: ChatInitializedListener)參數
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)參數
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)參數
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)參數
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)參數
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)參數
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)參數
- event
-
"isLocalScreenSharingActiveChanged"
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)參數
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)參數
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)參數
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
on("messageDeleted", MessageReceivedListener)
function on(event: "messageDeleted", listener: MessageReceivedListener)參數
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
on("messageEdited", MessageReceivedListener)
function on(event: "messageEdited", listener: MessageReceivedListener)參數
- event
-
"messageEdited"
- listener
- MessageReceivedListener
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)參數
- event
-
"messageRead"
- listener
- MessageReadListener
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)參數
- event
-
"messageReceived"
- listener
- MessageReceivedListener
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)參數
- event
-
"messageSent"
- listener
- MessageReceivedListener
on("realTimeTextReceived", RealTimeTextReceivedListener)
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)參數
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)參數
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)參數
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
on("spotlightChanged", SpotlightChangedListener)
function on(event: "spotlightChanged", listener: SpotlightChangedListener)參數
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
onReactionClick(Reaction)
將回應發送到正在進行的會議。
function onReactionClick(reaction: Reaction): Promise<void>參數
- reaction
- Reaction
type 為 <xref:%40azure%2Fcommunication-calling%23Reaction>
傳回
Promise<void>
onStateChange((state: CallWithChatAdapterState) => void)
訂閱處理程式至 stateChanged 事件。
function onStateChange(handler: (state: CallWithChatAdapterState) => void)參數
- handler
-
(state: CallWithChatAdapterState) => 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()
向本地用戶舉手。
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
要移除之參與者的UserId。
傳回
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)參數
- resourceDetails
- ResourceDetails
resumeCall()
從 LocalHold 狀態恢復調用。
function resumeCall(): Promise<void>傳回
Promise<void>
returnFromBreakoutRoom()
返回分組討論室的源站呼叫
function returnFromBreakoutRoom(): Promise<void>傳回
Promise<void>
sendMessage(string, SendMessageOptions)
在線程中傳送訊息。
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>參數
- content
-
string
- options
- SendMessageOptions
傳回
Promise<void>
sendReadReceipt(string)
傳送訊息的讀取回條。
function sendReadReceipt(chatMessageId: string): Promise<void>參數
- chatMessageId
-
string
傳回
Promise<void>
sendTypingIndicator()
在線程中傳送輸入指標。
function sendTypingIndicator(): Promise<void>傳回
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
容器的高度
備註
這個方法已針對複合實作
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
啟動呼叫。
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call參數
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
要調用的 <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
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>
繼承自CallWithChatAdapterManagement.startNoiseSuppressionEffect
startScreenShare()
開始在通話期間共享畫面。
function startScreenShare(): Promise<void>傳回
Promise<void>
startSpotlight(string[])
啟動spotlight
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[])
停止聚光燈
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
自訂背景圖像陣列。
繼承自CallWithChatAdapterManagement.updateBackgroundPickerImages
updateMessage(string, string, Record<string, string>)
更新訊息內容。
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>參數
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
傳回
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
更新選定的視頻背景效果
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)參數
- selectedVideoBackground
- VideoBackgroundEffect
繼承自CallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect