CallWithChatAdapterManagement interface
使用聊天管理目前通話的功能。
方法
方法詳細資料
askDevicePermission(PermissionConstraints)
要求裝置的許可權。
function askDevicePermission(constrain: PermissionConstraints): Promise<void>參數
- constrain
- PermissionConstraints
定義存取本機裝置的條件約束 <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
傳回
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>
備註
這個方法會針對複合實作。
deleteMessage(string)
刪除線程中的訊息。
function deleteMessage(messageId: string): Promise<void>參數
- messageId
-
string
傳回
Promise<void>
disposeStreamView(string, VideoStreamOptions)
處置資料流程的 HTML 檢視。
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>參數
- remoteUserId
-
string
要轉譯的參與者識別碼，將它保留為未定義以處置本機相機檢視
- options
- VideoStreamOptions
控制影片串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
傳回
Promise<void>
備註
這個方法會針對複合實作。
fetchInitialData()
擷取聊天配接器的初始狀態。
執行 ChatComposite 和 API 方法所需的最小擷取。
function fetchInitialData(): Promise<void>傳回
Promise<void>
joinCall(boolean)
一開始開啟/關閉麥克風來加入通話。
function joinCall(microphoneOn?: boolean): undefined | Call參數
- microphoneOn
-
boolean
是否一開始啟用麥克風
傳回
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>
備註
這個方法通常用來控制累加式擷取/無限捲動。
mute()
在通話期間將目前的使用者設為靜音，或在本機停用麥克風。
function mute(): Promise<void>傳回
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 () 之後呼叫
removeParticipant(string)
從通話中移除參與者。
function removeParticipant(userId: string): Promise<void>參數
- userId
-
string
要移除之參與者的 UserId。
傳回
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
要選擇的相機裝置，挑選queryCameras傳回的相機裝置
- options
- VideoStreamOptions
控制相機串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
傳回
Promise<void>
setMicrophone(AudioDeviceInfo)
將麥克風設定為在通話中使用。
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>參數
- sourceInfo
- AudioDeviceInfo
要選擇的麥克風裝置，挑選 queryMicrophone 所傳回的裝置
傳回
Promise<void>
setSpeaker(AudioDeviceInfo)
將喇叭設定為在通話中使用。
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>參數
- sourceInfo
- AudioDeviceInfo
選擇要選擇的說話者裝置，挑選querySpeakers傳回的裝置
傳回
Promise<void>
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>
startScreenShare()
開始在通話期間共用畫面。
function startScreenShare(): Promise<void>傳回
Promise<void>
stopCamera()
停止相機。
此方法會在呼叫未使用時停止轉譯本機相機檢視。
function stopCamera(): Promise<void>傳回
Promise<void>
stopScreenShare()
停止共用畫面。
function stopScreenShare(): Promise<void>傳回
Promise<void>
unmute()
在通話期間取消靜音目前的使用者，或在本機啟用麥克風。
function unmute(): Promise<void>傳回
Promise<void>
updateMessage(string, string, Record<string, string>)
更新訊息內容。
function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>參數
- messageId
-
string
- content
-
string
- metadata
-
Record<string, string>
傳回
Promise<void>