CallCommon interface

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

callEndReason?: CallEndReason

属性值

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

callerInfo: CallerInfo

属性值

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

direction: CallDirection

属性值

获取此调用的唯一 ID。

id: string

属性值

本地用户是否将传入音频静音。

isIncomingAudioMuted: boolean

属性值

本地视频是否打开。

isLocalVideoStarted: boolean

属性值

本地用户是静音还是远程。

isMuted: boolean

属性值

屏幕共享是否处于打开。

isScreenSharingOn: boolean

属性值

获取调用对象的类型。

kind: CallKind

属性值

获取 Teams 会议大厅。

lobby: Lobby

属性值

将本地音频流发送到呼叫中的其他参与者的集合。

localAudioStreams: readonly LocalAudioStream[]

属性值

正在呼叫中发送给其他参与者的本地视频流的集合。

localVideoStreams: readonly LocalVideoStream[]

属性值

从呼叫接收的远程音频流的集合。

remoteAudioStreams: readonly RemoteAudioStream[]

属性值

此通话中远程参与者的集合。 如果调用参与者数百或更多，则此集合中仅存在媒体活动参与者。

remoteParticipants: readonly RemoteParticipant[]

属性值

获取呼叫中本地用户的角色。

role: ParticipantRole

属性值

获取此呼叫的状态。

state: CallState

属性值

此通话中参与者总数的计数。

totalParticipantCount: number

属性值

使用扩展 API 检索已初始化和备忘录化的功能对象。 检查对象 Features.* 中是否有此包中所有可用的扩展调用功能，例如：

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

function feature<TFeature>(factory: CallFeatureFactory<TFeature>): TFeature

参数

返回

挂断电话。

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

参数

返回

将此呼叫保持。

function hold(): Promise<void>

返回

将本地麦克风静音。

function mute(): Promise<void>

返回

将所有远程参与者静音。

function muteAllRemoteParticipants(): Promise<void>

返回

将传入音频静音。

function muteIncomingAudio(): Promise<void>

返回

取消订阅 idChanged 事件的函数。

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

参数

isIncomingAudioMutedChanged 事件的 Subscribe 函数。

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

参数

取消订阅 isLocalVideoStartedChanged 事件的订阅函数。

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

参数

isMutedChanged 事件的 Subscribe 函数。

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

参数

取消订阅 isScreenSharingChanged 事件的函数。

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

参数

取消订阅 localAudioStreamsUpdated 事件的函数。

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

参数

取消订阅 localVideoStreamsUpdated 事件的函数。

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

参数

取消订阅 mutedByOthers 事件的函数。

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

参数

取消订阅 remoteAudioStreamsUpdated 事件的函数。

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

参数

取消订阅 remoteParticipantsUpdated 事件的函数。

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

参数

取消订阅 roleChanged 事件的函数。

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

参数

取消订阅 stateChanged 事件的函数。

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

参数

unsubscribe 函数用于 totalParticipantCountChanged 事件。

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

参数

订阅 idChanged 事件的函数。

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

参数

isIncomingAudioMutedChanged 事件的 Subscribe 函数。

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

参数

isLocalVideoStartedChanged 事件的 Subscribe 函数。

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

参数

isMutedChanged 事件的 Subscribe 函数。

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

参数

isScreenSharingChanged 事件的 Subscribe 函数。

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

参数

localAudioStreamsUpdated 事件的订阅函数。

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

参数

localVideoStreamsUpdated 事件的订阅函数。

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

参数

为 mutedByOthers 事件订阅函数。

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

参数

为 remoteAudioStreamsUpdated 事件订阅函数。

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

参数

remoteParticipantsUpdated 事件的 Subscribe 函数。

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

参数

为 roleChanged 事件订阅函数。

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

参数

stateChanged 事件的订阅函数。

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

参数

totalParticipantCountChanged 事件的 Subscribe 函数。

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

参数

如果此调用处于“LocalHold”状态，请继续此调用。

function resume(): Promise<void>

返回

发送 DTMF 音调。

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

参数

返回

设置调用约束。 此方法根据提供的值设置最大约束。 最终应用的约束将小于或等于此处提供给此方法的值。 如果提供了 0 个值，则不会针对该约束应用任何约束。 如果提供了未定义的值，则使用的上一个值将用于该约束。

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

参数

返回

使用自定义音频在通话中启动音频。 LocalAudioStream 源应为 MediaStream。

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

参数

返回

• 开始在通话中发送屏幕共享流。 浏览器将提示选择屏幕、应用或浏览器选项卡。
• iOS 和 Android 不支持发送屏幕共享流。
• iOS 和 Android 支持传入屏幕共享流。

function startScreenSharing(): Promise<void>

返回

• 开始在通话中发送原始屏幕共享流。
• iOS 和 Android 不支持发送原始屏幕共享。
• iOS 和 Android 支持传入的原始屏幕共享。

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

参数

返回

开始在通话中发送视频流。 呼叫中的远程参与者将收到视频流，以便他们可以在 UI 中呈现视频流。

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

参数

返回

停止呼叫中的自定义音频，并切换到设备管理器默认音频设备。

function stopAudio()

停止本地屏幕共享。

function stopScreenSharing(): Promise<void>

返回

停止本地屏幕共享。

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

参数

返回

停止在通话中发送视频流。 必须传递用于在 CallAgent.startCall（） API、CallAgent.join（） API、IncomingCall.accept（） API 或 Call.startVideo（） API 中启动视频的 LocalVideoStream 对象。

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

参数

返回

取消静音本地麦克风。

function unmute(): Promise<void>

返回

取消静音传入音频。

function unmuteIncomingAudio(): Promise<void>

返回

function dispose()

继承自Dispos.dispose