CallCommon interface
呼叫通用介面。
- Extends
屬性
| call |
包含程序代碼/subCode，指出此呼叫的結束方式。 |
| caller |
呼叫端 資訊，如果此呼叫是傳入的。 |
| direction | 取得通話方向，無論是傳入還是傳出。 |
| id | 取得此呼叫的唯一標識碼。 |
| is |
本機使用者是否將傳入音訊靜音。 |
| is |
本機視訊是否開啟。 |
| is |
本機用戶是靜音、本機還是遠端。 |
| is |
屏幕共用是否開啟。 |
| kind | 取得呼叫物件的種類。 |
| lobby | 取得 Teams 會議大廳。 |
| local |
正在傳送給通話中其他參與者的本機音訊串流集合。 |
| local |
在通話中傳送給其他參與者的本機視訊串流集合。 |
| remote |
從呼叫接收的遠端音訊串流集合。 |
| remote |
此呼叫中遠程參與者的集合。 如果與參與者有數百個以上的通話，則此集合中只會有媒體作用中的參與者。 |
| role | 取得通話中本機使用者的角色。 |
| state | 取得此通話的狀態。 |
| total |
此通話中的參與者總數。 |
方法
繼承的方法
| dispose() |
屬性詳細資料
callEndReason
callerInfo
direction
id
取得此呼叫的唯一標識碼。
id: string屬性值
string
isIncomingAudioMuted
本機使用者是否將傳入音訊靜音。
isIncomingAudioMuted: boolean屬性值
boolean
isLocalVideoStarted
本機視訊是否開啟。
isLocalVideoStarted: boolean屬性值
boolean
isMuted
本機用戶是靜音、本機還是遠端。
isMuted: boolean屬性值
boolean
isScreenSharingOn
屏幕共用是否開啟。
isScreenSharingOn: boolean屬性值
boolean
kind
lobby
localAudioStreams
正在傳送給通話中其他參與者的本機音訊串流集合。
localAudioStreams: readonly LocalAudioStream[]屬性值
readonly LocalAudioStream[]
localVideoStreams
在通話中傳送給其他參與者的本機視訊串流集合。
localVideoStreams: readonly LocalVideoStream[]屬性值
readonly LocalVideoStream[]
remoteAudioStreams
從呼叫接收的遠端音訊串流集合。
remoteAudioStreams: readonly RemoteAudioStream[]屬性值
readonly RemoteAudioStream[]
remoteParticipants
此呼叫中遠程參與者的集合。 如果與參與者有數百個以上的通話，則此集合中只會有媒體作用中的參與者。
remoteParticipants: readonly RemoteParticipant[]屬性值
readonly RemoteParticipant[]
role
state
totalParticipantCount
注意
此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。
此通話中的參與者總數。
totalParticipantCount: number屬性值
number
方法詳細資料
feature<TFeature>(CallFeatureFactory<TFeature>)
擷取具有擴充 API 的初始化和備忘功能物件。 檢查物件 Features.* 以取得此套件中所有可用的擴充呼叫功能，例如：
const call: Call = ...;
call.feature(Features.Recording).isRecordingActive;
call.feature(Features.Captions).startCaptions('en-us')
function feature<TFeature>(factory: CallFeatureFactory<TFeature>): TFeature參數
- factory
-
CallFeatureFactory<TFeature>
提供擴充 API 之呼叫功能建構函式的 Factory。
傳回
TFeature
hangUp(HangUpOptions)
掛斷電話。
function hangUp(options?: HangUpOptions): Promise<void>參數
- options
- HangUpOptions
HangUp 選項。
傳回
Promise<void>
hold()
保留此通話。
function hold(): Promise<void>傳回
Promise<void>
mute()
將本機麥克風設為靜音。
function mute(): Promise<void>傳回
Promise<void>
muteAllRemoteParticipants()
將所有遠端參與者設為靜音。
function muteAllRemoteParticipants(): Promise<void>傳回
Promise<void>
muteIncomingAudio()
將傳入音訊設為靜音。
function muteIncomingAudio(): Promise<void>傳回
Promise<void>
off("idChanged", PropertyChangedEvent)
idChanged 事件的取消訂閱函式。
function off(event: "idChanged", listener: PropertyChangedEvent)參數
- event
-
"idChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件。
off("isIncomingAudioMutedChanged", PropertyChangedEvent)
isIncomingAudioMutedChanged 事件的訂閱函式。
function off(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)參數
- event
-
"isIncomingAudioMutedChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在此屬性的值變更時呼叫。
off("isLocalVideoStartedChanged", PropertyChangedEvent)
isLocalVideoStartedChanged 事件的取消訂閱函式。
function off(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)參數
- event
-
"isLocalVideoStartedChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在此屬性的值變更時呼叫。
off("isMutedChanged", PropertyChangedEvent)
isMutedChanged 事件的 Subscribe 函式。
function off(event: "isMutedChanged", listener: PropertyChangedEvent)參數
- event
-
"isMutedChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在此屬性的值變更時呼叫。
off("isScreenSharingOnChanged", PropertyChangedEvent)
isScreenSharingChanged 事件的取消訂閱函式。
function off(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)參數
- event
-
"isScreenSharingOnChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件。
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)
取消訂閱 localAudioStreamsUpdated 事件的函式。
function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)參數
- event
-
"localAudioStreamsUpdated"
事件名稱。
- listener
回呼 fn，用來訂閱此事件。
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)
取消訂閱 localVideoStreamsUpdated 事件的函式。
function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)參數
- event
-
"localVideoStreamsUpdated"
事件名稱。
- listener
回呼 fn，用來訂閱此事件。
off("mutedByOthers", PropertyChangedEvent)
針對 mutedByOthers 事件取消訂閱函式。
function off(event: "mutedByOthers", listener: PropertyChangedEvent)參數
- event
-
"mutedByOthers"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，用來取消訂閱此事件。
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)
remoteAudioStreamsUpdated 事件的取消訂閱函式。
function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)參數
- event
-
"remoteAudioStreamsUpdated"
事件名稱。
- listener
回呼 fn，用來訂閱此事件。
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)
remoteParticipantsUpdated 事件的取消訂閱函式。
function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)參數
- event
-
"remoteParticipantsUpdated"
事件名稱。
- listener
回呼 fn，用來訂閱此事件。
off("roleChanged", PropertyChangedEvent)
roleChanged 事件的取消訂閱函式。
function off(event: "roleChanged", listener: PropertyChangedEvent)參數
- event
-
"roleChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件。
off("stateChanged", PropertyChangedEvent)
stateChanged 事件的取消訂閱函式。
function off(event: "stateChanged", listener: PropertyChangedEvent)參數
- event
-
"stateChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件。
off("totalParticipantCountChanged", PropertyChangedEvent)
注意
此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。
totalParticipantCountChanged 事件的 unsubscribe 函式。
function off(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)參數
- event
-
"totalParticipantCountChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在參與者計數變更時呼叫。
on("idChanged", PropertyChangedEvent)
idChanged 事件的 Subscribe 函式。
function on(event: "idChanged", listener: PropertyChangedEvent)參數
- event
-
"idChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在此屬性的值變更時呼叫。
on("isIncomingAudioMutedChanged", PropertyChangedEvent)
isIncomingAudioMutedChanged 事件的訂閱函式。
function on(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)參數
- event
-
"isIncomingAudioMutedChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在此屬性的值變更時呼叫。
on("isLocalVideoStartedChanged", PropertyChangedEvent)
isLocalVideoStartedChanged 事件的訂閱函式。
function on(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)參數
- event
-
"isLocalVideoStartedChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在此屬性的值變更時呼叫。
on("isMutedChanged", PropertyChangedEvent)
isMutedChanged 事件的 Subscribe 函式。
function on(event: "isMutedChanged", listener: PropertyChangedEvent)參數
- event
-
"isMutedChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在此屬性的值變更時呼叫。
on("isScreenSharingOnChanged", PropertyChangedEvent)
isScreenSharingChanged 事件的訂閱函式。
function on(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)參數
- event
-
"isScreenSharingOnChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在此屬性的值變更時呼叫。
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)
localAudioStreamsUpdated 事件的訂閱函式。
function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)參數
- event
-
"localAudioStreamsUpdated"
事件名稱。
- listener
回呼 fn，會在此集合變更時呼叫，它會傳遞已新增和移除元素的陣列。
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)
localVideoStreamsUpdated 事件的訂閱函式。
function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)參數
- event
-
"localVideoStreamsUpdated"
事件名稱。
- listener
回呼 fn，會在此集合變更時呼叫，它會傳遞已新增和移除元素的陣列。
on("mutedByOthers", PropertyChangedEvent)
MutedByOthers 事件的 Subscribe 函式。
function on(event: "mutedByOthers", listener: PropertyChangedEvent)參數
- event
-
"mutedByOthers"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，用來訂閱此事件。
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)
remoteAudioStreamsUpdated 事件的訂閱函式。
function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)參數
- event
-
"remoteAudioStreamsUpdated"
事件名稱。
- listener
回呼 fn，會在此集合變更時呼叫，它會傳遞已新增和移除元素的陣列。
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)
remoteParticipantsUpdated 事件的訂閱函式。
function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)參數
- event
-
"remoteParticipantsUpdated"
事件名稱。
- listener
回呼 fn，會在此集合變更時呼叫，它會傳遞已新增和移除元素的陣列。
on("roleChanged", PropertyChangedEvent)
roleChanged 事件的訂閱函式。
function on(event: "roleChanged", listener: PropertyChangedEvent)參數
- event
-
"roleChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在此屬性的值變更時呼叫。
on("stateChanged", PropertyChangedEvent)
stateChanged 事件的 Subscribe 函式。
function on(event: "stateChanged", listener: PropertyChangedEvent)參數
- event
-
"stateChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在此屬性的值變更時呼叫。
on("totalParticipantCountChanged", PropertyChangedEvent)
注意
此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。
totalParticipantCountChanged 事件的 Subscribe 函式。
function on(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)參數
- event
-
"totalParticipantCountChanged"
事件名稱。
- listener
- PropertyChangedEvent
回呼 fn，會在參與者計數變更時呼叫。
resume()
如果呼叫處於 『LocalHold』 狀態，請繼續此呼叫。
function resume(): Promise<void>傳回
Promise<void>
sendDtmf(DtmfTone)
傳送 DTMF 音調。
function sendDtmf(dtmfTone: DtmfTone): Promise<void>參數
- dtmfTone
- DtmfTone
傳回
Promise<void>
setConstraints(CallConstraints)
設定呼叫條件約束。 這個方法會根據所提供的值來設定 的最大條件約束。 最後套用的條件約束會小於或等於這裡提供給這個方法的值。 如果提供 0 值，則不會針對該條件約束套用任何條件約束。 如果提供未定義的值，則會針對該條件約束使用先前的值。
function setConstraints(constraints: CallConstraints): Promise<void>參數
- constraints
- CallConstraints
物件，表示要設定的呼叫條件約束
傳回
Promise<void>
startAudio(LocalAudioStream)
使用自定義音訊在通話中啟動音訊。 LocalAudioStream 來源應該是 MediaStream。
function startAudio(localAudioStream: LocalAudioStream): Promise<void>參數
- localAudioStream
- LocalAudioStream
傳回
Promise<void>
startScreenSharing()
- 開始在通話中傳送螢幕共用串流。 瀏覽器會提示您選取畫面、應用程式或瀏覽器索引標籤。
- iOS 和 Android 不支援傳送螢幕共用串流。
- iOS 和 Android 支援傳入螢幕畫面共用串流。
function startScreenSharing(): Promise<void>傳回
Promise<void>
startScreenSharing(LocalVideoStream)
注意
此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。
- 開始在通話中傳送原始螢幕共用串流。
- iOS 和 Android 不支援傳送原始螢幕共用。
- iOS 和 Android 支援傳入的原始螢幕共用。
function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>參數
- localVideoStream
- LocalVideoStream
表示採用建構函式中 MediaStream 的本機原始螢幕共用數據流。
傳回
Promise<void>
startVideo(LocalVideoStream)
開始在通話中傳送視訊串流。 通話中的遠程參與者會收到您的視訊串流，讓他們可以在UI中轉譯。
function startVideo(localVideoStream: LocalVideoStream): Promise<void>參數
- localVideoStream
- LocalVideoStream
表示採用建構函式中相機來源的本機視訊串流。
傳回
Promise<void>
stopAudio()
停止通話中的自定義音訊，並切換至設備管理器預設音訊裝置。
function stopAudio()
stopScreenSharing()
停止本機螢幕共用。
function stopScreenSharing(): Promise<void>傳回
Promise<void>
stopScreenSharing(LocalVideoStream)
注意
此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。
停止本機螢幕共用。
function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>參數
- localVideoStream
- LocalVideoStream
要停止串流的本機螢幕共用串流。
傳回
Promise<void>
stopVideo(LocalVideoStream)
停止在通話中傳送視訊串流。 必須傳遞用來在 CallAgent.startCall（） API、CallAgent.join（） API、IncomingCall.accept（） API 或 Call.startVideo（） API 中啟動視訊的 LocalVideoStream 物件。
function stopVideo(localVideoStream: LocalVideoStream): Promise<void>參數
- localVideoStream
- LocalVideoStream
要停止串流的本機視訊串流。
傳回
Promise<void>
unmute()
取消靜音本機麥克風。
function unmute(): Promise<void>傳回
Promise<void>
unmuteIncomingAudio()
取消靜音傳入音訊。
function unmuteIncomingAudio(): Promise<void>傳回
Promise<void>
繼承的方法的詳細資料
dispose()
function dispose()