Call interface

包:

@azure/communication-calling

表示调用。

扩展

CallCommon

属性

info	获取有关此呼叫的信息。

继承属性

callEndReason	包含指示此调用结束方式的代码/子代码。
callerInfo	如果此呼叫是传入的，则调用方信息。
direction	获取呼叫方向，无论是传入还是传出。
id	获取此调用的唯一 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 事件的 Subscribe 函数。
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)	unsubscribe 函数用于 totalParticipantCountChanged 事件。
on("idChanged", PropertyChangedEvent)	订阅 idChanged 事件的函数。
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	isIncomingAudioMutedChanged 事件的 Subscribe 函数。
on("isLocalVideoStartedChanged", PropertyChangedEvent)	isLocalVideoStartedChanged 事件的 Subscribe 函数。
on("isMutedChanged", PropertyChangedEvent)	isMutedChanged 事件的 Subscribe 函数。
on("isScreenSharingOnChanged", PropertyChangedEvent)	isScreenSharingChanged 事件的 Subscribe 函数。
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	localAudioStreamsUpdated 事件的订阅函数。
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	localVideoStreamsUpdated 事件的订阅函数。
on("mutedByOthers", PropertyChangedEvent)	为 mutedByOthers 事件订阅函数。
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	为 remoteAudioStreamsUpdated 事件订阅函数。
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	remoteParticipantsUpdated 事件的 Subscribe 函数。
on("roleChanged", PropertyChangedEvent)	为 roleChanged 事件订阅函数。
on("stateChanged", PropertyChangedEvent)	stateChanged 事件的订阅函数。
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

包含指示此调用结束方式的代码/子代码。

callEndReason?: CallEndReason

属性值

CallEndReason

继承自CallCommon.callEndReason

callerInfo

如果此呼叫是传入的，则调用方信息。

callerInfo: CallerInfo

属性值

CallerInfo

继承自CallCommon.callerInfo

direction

获取呼叫方向，无论是传入还是传出。

direction: CallDirection

属性值

CallDirection

继承自CallCommon.direction

id

获取此调用的唯一 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 呼叫中设置呼叫者 ID 电话号码。

返回

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 的调用功能构造函数的工厂。

返回

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 事件的 Subscribe 函数。

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。

unsubscribe 函数用于 totalParticipantCountChanged 事件。

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

参数

event

"totalParticipantCountChanged"

事件名称。

listener

PropertyChangedEvent

参与者计数更改时将调用的回调 fn。

继承自CallCommon.off

on("idChanged", PropertyChangedEvent)

订阅 idChanged 事件的函数。

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

参数

event

"idChanged"

事件名称。

listener

PropertyChangedEvent

回调 fn，将在此属性的值发生更改时调用。

继承自CallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

isIncomingAudioMutedChanged 事件的 Subscribe 函数。

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

参数

event

"isIncomingAudioMutedChanged"

事件名称。

listener

PropertyChangedEvent

回调 fn，将在此属性的值发生更改时调用。

继承自CallCommon.on

on("isLocalVideoStartedChanged", PropertyChangedEvent)

isLocalVideoStartedChanged 事件的 Subscribe 函数。

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 事件的 Subscribe 函数。

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 事件订阅函数。

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 事件的 Subscribe 函数。

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 事件的订阅函数。

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