共用方式為

Call interface

  • 參考
套件:
@azure/communication-calling

表示呼叫。

Extends
CallCommon

屬性

info

取得此通話的相關信息。

繼承的屬性

callEndReason

包含程序代碼/subCode，指出此呼叫的結束方式。
callerInfo

呼叫端 資訊，如果此呼叫是傳入的。
direction

取得通話方向，無論是傳入還是傳出。
id

取得此呼叫的唯一標識碼。
isIncomingAudioMuted

本機使用者是否將傳入音訊靜音。
isLocalVideoStarted

本機視訊是否開啟。
isMuted

本機用戶是靜音、本機還是遠端。
isScreenSharingOn

屏幕共用是否開啟。
kind

取得呼叫物件的種類。
lobby

取得 Teams 會議大廳。
localAudioStreams

正在傳送給通話中其他參與者的本機音訊串流集合。
localVideoStreams

在通話中傳送給其他參與者的本機視訊串流集合。
remoteAudioStreams

從呼叫接收的遠端音訊串流集合。
remoteParticipants

此呼叫中遠程參與者的集合。 如果與參與者有數百個以上的通話，則此集合中只會有媒體作用中的參與者。
role

取得通話中本機使用者的角色。
state

取得此通話的狀態。
totalParticipantCount

此通話中的參與者總數。

方法

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)

將參與者新增至此通話。
addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)

將參與者新增至此通話。
addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)

將 Teams 應用程式新增至此通話。
addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)

將參與者新增至此通話。
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

將參與者新增至此通話。
removeParticipant(CommunicationIdentifier)

從此通話中移除參與者。

繼承的方法

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)

擷取具有擴充 API 的初始化和備忘功能物件。 檢查物件 Features.* 以取得此套件中所有可用的擴充呼叫功能，例如：

const call: Call = ...;
call.feature(Features.Recording).isRecordingActive;
call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)

掛斷電話。
hold()

保留此通話。
mute()

將本機麥克風設為靜音。
muteAllRemoteParticipants()

將所有遠端參與者設為靜音。
muteIncomingAudio()

將傳入音訊設為靜音。
off("idChanged", PropertyChangedEvent)

idChanged 事件的取消訂閱函式。
off("isIncomingAudioMutedChanged", PropertyChangedEvent)

isIncomingAudioMutedChanged 事件的訂閱函式。
off("isLocalVideoStartedChanged", PropertyChangedEvent)

isLocalVideoStartedChanged 事件的取消訂閱函式。
off("isMutedChanged", PropertyChangedEvent)

isMutedChanged 事件的 Subscribe 函式。
off("isScreenSharingOnChanged", PropertyChangedEvent)

isScreenSharingChanged 事件的取消訂閱函式。
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

取消訂閱 localAudioStreamsUpdated 事件的函式。
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

取消訂閱 localVideoStreamsUpdated 事件的函式。
off("mutedByOthers", PropertyChangedEvent)

針對 mutedByOthers 事件取消訂閱函式。
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

remoteAudioStreamsUpdated 事件的取消訂閱函式。
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

remoteParticipantsUpdated 事件的取消訂閱函式。
off("roleChanged", PropertyChangedEvent)

roleChanged 事件的取消訂閱函式。
off("stateChanged", PropertyChangedEvent)

stateChanged 事件的取消訂閱函式。
off("totalParticipantCountChanged", PropertyChangedEvent)

totalParticipantCountChanged 事件的 unsubscribe 函式。
on("idChanged", PropertyChangedEvent)

idChanged 事件的 Subscribe 函式。
on("isIncomingAudioMutedChanged", PropertyChangedEvent)

isIncomingAudioMutedChanged 事件的訂閱函式。
on("isLocalVideoStartedChanged", PropertyChangedEvent)

isLocalVideoStartedChanged 事件的訂閱函式。
on("isMutedChanged", PropertyChangedEvent)

isMutedChanged 事件的 Subscribe 函式。
on("isScreenSharingOnChanged", PropertyChangedEvent)

isScreenSharingChanged 事件的訂閱函式。
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

localAudioStreamsUpdated 事件的訂閱函式。
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

localVideoStreamsUpdated 事件的訂閱函式。
on("mutedByOthers", PropertyChangedEvent)

MutedByOthers 事件的 Subscribe 函式。
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

remoteAudioStreamsUpdated 事件的訂閱函式。
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

remoteParticipantsUpdated 事件的訂閱函式。
on("roleChanged", PropertyChangedEvent)

roleChanged 事件的訂閱函式。
on("stateChanged", PropertyChangedEvent)

stateChanged 事件的 Subscribe 函式。
on("totalParticipantCountChanged", PropertyChangedEvent)

totalParticipantCountChanged 事件的 Subscribe 函式。
resume()

如果呼叫處於 『LocalHold』 狀態，請繼續此呼叫。
sendDtmf(DtmfTone)

傳送 DTMF 音調。
setConstraints(CallConstraints)

設定呼叫條件約束。 這個方法會根據所提供的值來設定 的最大條件約束。 最後套用的條件約束會小於或等於這裡提供給這個方法的值。 如果提供 0 值，則不會針對該條件約束套用任何條件約束。 如果提供未定義的值，則會針對該條件約束使用先前的值。
startAudio(LocalAudioStream)

使用自定義音訊在通話中啟動音訊。 LocalAudioStream 來源應該是 MediaStream。
startScreenSharing()
  • 開始在通話中傳送螢幕共用串流。 瀏覽器會提示您選取畫面、應用程式或瀏覽器索引標籤。
  • iOS 和 Android 不支援傳送螢幕共用串流。
  • iOS 和 Android 支援傳入螢幕畫面共用串流。
startScreenSharing(LocalVideoStream)
  • 開始在通話中傳送原始螢幕共用串流。
  • iOS 和 Android 不支援傳送原始螢幕共用。
  • iOS 和 Android 支援傳入的原始螢幕共用。
startVideo(LocalVideoStream)

開始在通話中傳送視訊串流。 通話中的遠程參與者會收到您的視訊串流，讓他們可以在UI中轉譯。
stopAudio()

停止通話中的自定義音訊，並切換至設備管理器預設音訊裝置。
stopScreenSharing()

停止本機螢幕共用。
stopScreenSharing(LocalVideoStream)

停止本機螢幕共用。
stopVideo(LocalVideoStream)

停止在通話中傳送視訊串流。 必須傳遞用來在 CallAgent.startCall（） API、CallAgent.join（） API、IncomingCall.accept（） API 或 Call.startVideo（） API 中啟動視訊的 LocalVideoStream 物件。
unmute()

取消靜音本機麥克風。
unmuteIncomingAudio()

取消靜音傳入音訊。

屬性詳細資料

info

取得此通話的相關信息。

info: CallInfo

屬性值

CallInfo

繼承的屬性詳細資料

callEndReason

包含程序代碼/subCode，指出此呼叫的結束方式。

callEndReason?: CallEndReason

屬性值

CallEndReason

繼承自CallCommon.callEndReason

callerInfo

呼叫端 資訊，如果此呼叫是傳入的。

callerInfo: CallerInfo

屬性值

CallerInfo

繼承自CallCommon.callerInfo

direction

取得通話方向，無論是傳入還是傳出。

direction: CallDirection

屬性值

CallDirection

繼承自CallCommon.direction

id

取得此呼叫的唯一標識碼。

id: string

屬性值

string

繼承自CallCommon.id

isIncomingAudioMuted

本機使用者是否將傳入音訊靜音。

isIncomingAudioMuted: boolean

屬性值

boolean

繼承自CallCommon.isIncomingAudioMuted

isLocalVideoStarted

本機視訊是否開啟。

isLocalVideoStarted: boolean

屬性值

boolean

繼承自CallCommon.isLocalVideoStarted

isMuted

本機用戶是靜音、本機還是遠端。

isMuted: boolean

屬性值

boolean

繼承自CallCommon.isMuted

isScreenSharingOn

屏幕共用是否開啟。

isScreenSharingOn: boolean

屬性值

boolean

繼承自CallCommon.isScreenSharingOn

kind

取得呼叫物件的種類。

kind: CallKind

屬性值

CallKind

繼承自CallCommon.kind

lobby

取得 Teams 會議大廳。

lobby: Lobby

屬性值

Lobby

繼承自CallCommon.lobby

localAudioStreams

正在傳送給通話中其他參與者的本機音訊串流集合。

localAudioStreams: readonly LocalAudioStream[]

屬性值

readonly LocalAudioStream[]

繼承自CallCommon.localAudioStreams

localVideoStreams

在通話中傳送給其他參與者的本機視訊串流集合。

localVideoStreams: readonly LocalVideoStream[]

屬性值

readonly LocalVideoStream[]

繼承自CallCommon.localVideoStreams

remoteAudioStreams

從呼叫接收的遠端音訊串流集合。

remoteAudioStreams: readonly RemoteAudioStream[]

屬性值

readonly RemoteAudioStream[]

繼承自CallCommon.remoteAudioStreams

remoteParticipants

此呼叫中遠程參與者的集合。 如果與參與者有數百個以上的通話，則此集合中只會有媒體作用中的參與者。

remoteParticipants: readonly RemoteParticipant[]

屬性值

readonly RemoteParticipant[]

繼承自CallCommon.remoteParticipants

role

取得通話中本機使用者的角色。

role: ParticipantRole

屬性值

ParticipantRole

繼承自CallCommon.role

state

取得此通話的狀態。

state: CallState

屬性值

CallState

繼承自CallCommon.state

totalParticipantCount

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

此通話中的參與者總數。

totalParticipantCount: number

屬性值

number

繼承自CallCommon.totalParticipantCount

方法詳細資料

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)

將參與者新增至此通話。

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

參數

identifier

CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier

要加入之參與者的標識碼。

傳回

RemoteParticipant

與成功新增參與者相關聯的 RemoteParticipant 物件。

addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

將參與者新增至此通話。

function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant

參數

identifier
CommunicationUserIdentifier

要加入之參與者的標識碼。

options
AddCommunicationUserOptions

管理通話的其他選項。

傳回

RemoteParticipant

與成功新增參與者相關聯的 RemoteParticipant 物件。

addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

將 Teams 應用程式新增至此通話。

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

參數

identifier

MicrosoftTeamsAppIdentifier | UnknownIdentifier

要新增的Teams應用程式的標識碼。

傳回

RemoteParticipant

與已成功新增的Teams應用程式相關聯的RemoteParticipant物件。

addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

將參與者新增至此通話。

function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant

參數

identifier
MicrosoftTeamsUserIdentifier

要加入之參與者的標識碼。

options
AddMicrosoftTeamsUserOptions

管理通話的其他選項。

傳回

RemoteParticipant

與成功新增參與者相關聯的 RemoteParticipant 物件。

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

將參與者新增至此通話。

function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant

參數

identifier
PhoneNumberIdentifier

要加入之參與者的標識碼。

options
AddPhoneNumberOptions

管理 PSTN 通話的其他選項。 例如，在 PSTN 通話中設定來電者標識符電話號碼。

傳回

RemoteParticipant

與成功新增參與者相關聯的 RemoteParticipant 物件。

removeParticipant(CommunicationIdentifier)

從此通話中移除參與者。

function removeParticipant(identifier: CommunicationIdentifier): Promise<void>

參數

identifier
CommunicationIdentifier

要移除之參與者的標識碼。

傳回

Promise<void>

繼承的方法的詳細資料

dispose() 

function dispose()

繼承自CallCommon.dispose

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

繼承自CallCommon.feature

hangUp(HangUpOptions)

掛斷電話。

function hangUp(options?: HangUpOptions): Promise<void>

參數

options
HangUpOptions

HangUp 選項。

傳回

Promise<void>

繼承自CallCommon.hangUp

hold()

保留此通話。

function hold(): Promise<void>

傳回

Promise<void>

繼承自CallCommon.hold

mute()

將本機麥克風設為靜音。

function mute(): Promise<void>

傳回

Promise<void>

繼承自CallCommon.mute

muteAllRemoteParticipants()

將所有遠端參與者設為靜音。

function muteAllRemoteParticipants(): Promise<void>

傳回

Promise<void>

繼承自CallCommon.muteAllRemoteParticipants

muteIncomingAudio()

將傳入音訊設為靜音。

function muteIncomingAudio(): Promise<void>

傳回

Promise<void>

繼承自CallCommon.muteIncomingAudio

off("idChanged", PropertyChangedEvent)

idChanged 事件的取消訂閱函式。

function off(event: "idChanged", listener: PropertyChangedEvent)

參數

event

"idChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來訂閱此事件。

繼承自CallCommon.off

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

isIncomingAudioMutedChanged 事件的訂閱函式。

function off(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)

參數

event

"isIncomingAudioMutedChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

繼承自CallCommon.off

off("isLocalVideoStartedChanged", PropertyChangedEvent)

isLocalVideoStartedChanged 事件的取消訂閱函式。

function off(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)

參數

event

"isLocalVideoStartedChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

繼承自CallCommon.off

off("isMutedChanged", PropertyChangedEvent)

isMutedChanged 事件的 Subscribe 函式。

function off(event: "isMutedChanged", listener: PropertyChangedEvent)

參數

event

"isMutedChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

繼承自CallCommon.off

off("isScreenSharingOnChanged", PropertyChangedEvent)

isScreenSharingChanged 事件的取消訂閱函式。

function off(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)

參數

event

"isScreenSharingOnChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來訂閱此事件。

繼承自CallCommon.off

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

取消訂閱 localAudioStreamsUpdated 事件的函式。

function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

參數

event

"localAudioStreamsUpdated"

事件名稱。

listener

CollectionUpdatedEvent<LocalAudioStream>

回呼 fn，用來訂閱此事件。

繼承自CallCommon.off

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

取消訂閱 localVideoStreamsUpdated 事件的函式。

function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

參數

event

"localVideoStreamsUpdated"

事件名稱。

listener

CollectionUpdatedEvent<LocalVideoStream>

回呼 fn，用來訂閱此事件。

繼承自CallCommon.off

off("mutedByOthers", PropertyChangedEvent)

針對 mutedByOthers 事件取消訂閱函式。

function off(event: "mutedByOthers", listener: PropertyChangedEvent)

參數

event

"mutedByOthers"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來取消訂閱此事件。

繼承自CallCommon.off

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

remoteAudioStreamsUpdated 事件的取消訂閱函式。

function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

參數

event

"remoteAudioStreamsUpdated"

事件名稱。

listener

CollectionUpdatedEvent<RemoteAudioStream>

回呼 fn，用來訂閱此事件。

繼承自CallCommon.off

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

remoteParticipantsUpdated 事件的取消訂閱函式。

function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

參數

event

"remoteParticipantsUpdated"

事件名稱。

listener

CollectionUpdatedEvent<RemoteParticipant>

回呼 fn，用來訂閱此事件。

繼承自CallCommon.off

off("roleChanged", PropertyChangedEvent)

roleChanged 事件的取消訂閱函式。

function off(event: "roleChanged", listener: PropertyChangedEvent)

參數

event

"roleChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來訂閱此事件。

繼承自CallCommon.off

off("stateChanged", PropertyChangedEvent)

stateChanged 事件的取消訂閱函式。

function off(event: "stateChanged", listener: PropertyChangedEvent)

參數

event

"stateChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來訂閱此事件。

繼承自CallCommon.off

off("totalParticipantCountChanged", PropertyChangedEvent)

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

totalParticipantCountChanged 事件的 unsubscribe 函式。

function off(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)

參數

event

"totalParticipantCountChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在參與者計數變更時呼叫。

繼承自CallCommon.off

on("idChanged", PropertyChangedEvent)

idChanged 事件的 Subscribe 函式。

function on(event: "idChanged", listener: PropertyChangedEvent)

參數

event

"idChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

繼承自CallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

isIncomingAudioMutedChanged 事件的訂閱函式。

function on(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)

參數

event

"isIncomingAudioMutedChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

繼承自CallCommon.on

on("isLocalVideoStartedChanged", PropertyChangedEvent)

isLocalVideoStartedChanged 事件的訂閱函式。

function on(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)

參數

event

"isLocalVideoStartedChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

繼承自CallCommon.on

on("isMutedChanged", PropertyChangedEvent)

isMutedChanged 事件的 Subscribe 函式。

function on(event: "isMutedChanged", listener: PropertyChangedEvent)

參數

event

"isMutedChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

繼承自CallCommon.on

on("isScreenSharingOnChanged", PropertyChangedEvent)

isScreenSharingChanged 事件的訂閱函式。

function on(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)

參數

event

"isScreenSharingOnChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

繼承自CallCommon.on

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

localAudioStreamsUpdated 事件的訂閱函式。

function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

參數

event

"localAudioStreamsUpdated"

事件名稱。

listener

CollectionUpdatedEvent<LocalAudioStream>

回呼 fn，會在此集合變更時呼叫，它會傳遞已新增和移除元素的陣列。

繼承自CallCommon.on

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

localVideoStreamsUpdated 事件的訂閱函式。

function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

參數

event

"localVideoStreamsUpdated"

事件名稱。

listener

CollectionUpdatedEvent<LocalVideoStream>

回呼 fn，會在此集合變更時呼叫，它會傳遞已新增和移除元素的陣列。

繼承自CallCommon.on

on("mutedByOthers", PropertyChangedEvent)

MutedByOthers 事件的 Subscribe 函式。

function on(event: "mutedByOthers", listener: PropertyChangedEvent)

參數

event

"mutedByOthers"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來訂閱此事件。

繼承自CallCommon.on

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

remoteAudioStreamsUpdated 事件的訂閱函式。

function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

參數

event

"remoteAudioStreamsUpdated"

事件名稱。

listener

CollectionUpdatedEvent<RemoteAudioStream>

回呼 fn，會在此集合變更時呼叫，它會傳遞已新增和移除元素的陣列。

繼承自CallCommon.on

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

remoteParticipantsUpdated 事件的訂閱函式。

function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

參數

event

"remoteParticipantsUpdated"

事件名稱。

listener

CollectionUpdatedEvent<RemoteParticipant>

回呼 fn，會在此集合變更時呼叫，它會傳遞已新增和移除元素的陣列。

繼承自CallCommon.on

on("roleChanged", PropertyChangedEvent)

roleChanged 事件的訂閱函式。

function on(event: "roleChanged", listener: PropertyChangedEvent)

參數

event

"roleChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

繼承自CallCommon.on

on("stateChanged", PropertyChangedEvent)

stateChanged 事件的 Subscribe 函式。

function on(event: "stateChanged", listener: PropertyChangedEvent)

參數

event

"stateChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

繼承自CallCommon.on

on("totalParticipantCountChanged", PropertyChangedEvent)

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

totalParticipantCountChanged 事件的 Subscribe 函式。

function on(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)

參數

event

"totalParticipantCountChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在參與者計數變更時呼叫。

繼承自CallCommon.on

resume()

如果呼叫處於 『LocalHold』 狀態，請繼續此呼叫。

function resume(): Promise<void>

傳回

Promise<void>

繼承自CallCommon.resume

sendDtmf(DtmfTone)

傳送 DTMF 音調。

function sendDtmf(dtmfTone: DtmfTone): Promise<void>

參數

dtmfTone
DtmfTone

傳回

Promise<void>

繼承自CallCommon.sendDtmf

setConstraints(CallConstraints)

設定呼叫條件約束。 這個方法會根據所提供的值來設定 的最大條件約束。 最後套用的條件約束會小於或等於這裡提供給這個方法的值。 如果提供 0 值，則不會針對該條件約束套用任何條件約束。 如果提供未定義的值，則會針對該條件約束使用先前的值。

function setConstraints(constraints: CallConstraints): Promise<void>

參數

constraints
CallConstraints

物件，表示要設定的呼叫條件約束

傳回

Promise<void>

繼承自CallCommon.setConstraints

startAudio(LocalAudioStream)

使用自定義音訊在通話中啟動音訊。 LocalAudioStream 來源應該是 MediaStream。

function startAudio(localAudioStream: LocalAudioStream): Promise<void>

參數

localAudioStream
LocalAudioStream

傳回

Promise<void>

繼承自CallCommon.startAudio

startScreenSharing()

  • 開始在通話中傳送螢幕共用串流。 瀏覽器會提示您選取畫面、應用程式或瀏覽器索引標籤。
  • iOS 和 Android 不支援傳送螢幕共用串流。
  • iOS 和 Android 支援傳入螢幕畫面共用串流。
function startScreenSharing(): Promise<void>

傳回

Promise<void>

繼承自CallCommon.startScreenSharing

startScreenSharing(LocalVideoStream)

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

  • 開始在通話中傳送原始螢幕共用串流。
  • iOS 和 Android 不支援傳送原始螢幕共用。
  • iOS 和 Android 支援傳入的原始螢幕共用。
function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

參數

localVideoStream
LocalVideoStream

表示採用建構函式中 MediaStream 的本機原始螢幕共用數據流。

傳回

Promise<void>

繼承自CallCommon.startScreenSharing

startVideo(LocalVideoStream)

開始在通話中傳送視訊串流。 通話中的遠程參與者會收到您的視訊串流，讓他們可以在UI中轉譯。

function startVideo(localVideoStream: LocalVideoStream): Promise<void>

參數

localVideoStream
LocalVideoStream

表示採用建構函式中相機來源的本機視訊串流。

傳回

Promise<void>

繼承自CallCommon.startVideo

stopAudio()

停止通話中的自定義音訊，並切換至設備管理器預設音訊裝置。

function stopAudio()

繼承自CallCommon.stopAudio

stopScreenSharing()

停止本機螢幕共用。

function stopScreenSharing(): Promise<void>

傳回

Promise<void>

繼承自CallCommon.stopScreenSharing

stopScreenSharing(LocalVideoStream)

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

停止本機螢幕共用。

function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

參數

localVideoStream
LocalVideoStream

要停止串流的本機螢幕共用串流。

傳回

Promise<void>

繼承自CallCommon.stopScreenSharing

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>

繼承自CallCommon.stopVideo

unmute()

取消靜音本機麥克風。

function unmute(): Promise<void>

傳回

Promise<void>

繼承自CallCommon.unmute

unmuteIncomingAudio()

取消靜音傳入音訊。

function unmuteIncomingAudio(): Promise<void>

傳回

Promise<void>

繼承自CallCommon.unmuteIncomingAudio