@azure/communication-calling package

CallClient 是 SDK 的主要入口点。 CallClient 用于创建 CallAgent 并获取 DeviceManager。

表示本地 michrophone 设备的本地音频流

表示本地相机设备的本地视频流

视频流的呈现器

用于接受传入呼叫的选项。 传递将用于接受传入呼叫的视频流。 如果未定义 videoOptions，则将接受传入呼叫，并关闭本地视频。 如果未定义 AudioOptions，则传入呼叫将接受默认麦克风作为设备管理器的源。

表示当前活动音频效果

用于将 AddCommunicationUserOptions 参与者添加到正在进行的呼叫的选项。

用于将 MicrosoftTeamsUser 参与者添加到正在进行的呼叫的选项。

用于将 PSTN 参与者添加到正在进行的呼叫的选项。

用于将 Teams 参与者添加到正在进行的 Teams 通话的选项。

允许所有参与者的结果。

允许来自大厅的参与者的选项。

分配的分组讨论室事件的接口名称

有关麦克风或扬声器设备的信息。

基本音频效果。

AudioEffects 功能的 API 接口

表示开始效果时的音频效果配置

表示停止效果时的音频效果配置

音频质量诊断

发出传出呼叫或加入组呼叫时提供的音频选项。

表示音频流功能

表示为构造函数中的扩展音频/视频流功能提供的上下文。

表示音频流功能的工厂

背景模糊效果。

后台替换配置。

背景替换效果。

表示任何功能的基接口

在收集的呼叫诊断中

MediaAccess 状态已更改事件对象

分组讨论室详细信息

分组讨论室呼叫功能。

所有可用分组讨论室可用事件的接口名称

用户加入分组讨论室后可用的分组讨论室设置

可用分组讨论室设置的接口名称

表示调用。

CallAgent 用于处理调用。

CallAgent 通用接口。

表示 CallAgent 功能。

表示为构造函数中的扩展调用代理功能的上下文。

表示呼叫代理功能的工厂

用于创建 CallAgent 的选项。

表示 CallClient 功能。

表示为构造函数上的扩展调用客户端功能提供的上下文。

表示调用客户端代理功能的工厂

调用客户端选项

调用通用接口。

表示调用的约束

呼叫诊断

描述调用结束的原因。

表示呼叫功能。

表示为构造函数上的扩展调用功能提供的上下文。

表示调用功能的工厂

有关呼叫的信息。

CallInfo 通用接口。

表示通话调查评级。

表示呼叫调查的结束。

ACS 实时传送视频流功能

表示呼叫调查响应的结束。

调用方信息。

为每个 CapabilitiesChangedEventType 事件接收的数据结构。

功能功能。

Captions 对象的数据结构

标题功能

CaptionsCommon 对象的数据结构

为每个 CaptionsReceivedEventType 事件接收的数据结构

API 调用失败时引发的错误。

有关复合音频设备的信息。

视频流的呈现器的选项。

在调用自定义上下文上收到选项。

用于调用自定义上下文的选项。

DataChannel 调用功能

DataChannel 消息

DataChannel 接收器

DataChannel 发送方

调用调试信息的功能。

转储 ID 是每个调试信息转储的唯一Identifier

深度噪声抑制效果

用户授予的权限。

设备兼容性信息

设备枚举信息

设备管理器用于处理系统媒体设备，例如相机、麦克风和扬声器。

诊断选项

释放对象。

呼叫主导扬声器的功能。

有关通话的主要说话人的信息

远程参与者终结点的详细信息

表示用于分解特征的接口

用于加入组呼叫的定位符。

用于加入群组聊天呼叫的定位符。

用于挂断呼叫的选项。

表示冰服务器（眩晕/转弯）

呼叫诊断信息

音频的泛型类型接收媒体统计信息

表示传入呼叫。

传入调用通用接口。

传入呼叫推送通知数据

视频的泛型类型接收媒体统计信息

被邀请者详细信息

分组讨论室联接事件的事件类型的名称

用于加入组呼叫的选项。 传递将用于启动呼叫的视频流。 呼叫中的远程参与者将收到视频流，以便他们可以在 UI 中呈现视频流。 传递音频选项天气以加入呼叫静音或取消静音。 如果未定义 videoOptions，则呼叫将以本地视频关闭开始。

引发的最新媒体诊断。

引发的最新网络诊断。

Teams 会议大厅

呼叫录制功能。

本地录制信息。

MediaAccess 状态已更改事件对象

媒体访问功能。

媒体访问已更改事件信息

约束范围

媒体诊断

在通话中获取媒体统计信息的功能。

媒体统计信息收集器。

来自“sampleReported”事件的媒体统计信息

来自“summaryReported”事件的聚合媒体统计信息

会议媒体访问状态已更改事件对象

会议媒体访问已更改事件信息

表示在创建呼叫客户端时要设置的网络配置

网络诊断

OnBehalfOf 其他用户的选项

最佳视频计数的功能

音频的泛型类型发送媒体统计信息

视频的泛型类型发送媒体统计信息

PPTLive 功能。

表示通话中的参与者。

定义访问本地设备的约束。

PreCallDiagnostics 功能

表示代理服务器的代理配置，用于通过该代理服务器发送流量。

举手呼叫反应功能。

举手状态对象

下手事件信息

用于替代默认缩放的分级缩放

会议反应功能。

反应消息数据模型

反应消息类型

呼叫录制功能。

呼叫录制信息。

拒绝来自大厅的参与者的选项。

呼叫的远程音频流。

远程诊断

表示呼叫中的远程参与者。

引发的远程诊断。

表示远程参与者的视频或屏幕共享。

表示远程参与者的视频或屏幕共享或实时流。

用于加入会议室呼叫的定位符。

聚焦呼叫功能。

聚焦状态已更改事件对象

用于启动传出呼叫的选项。

传递给 StartCaptions 的选项

用于启动传出 Teams 呼叫的选项。

用于启动传出 Teams 组呼叫的选项。

流大小。

提交呼叫调查的选项。

表示 Teams 通话。

TeamsCallAgent 用于处理 Teams 呼叫。

用于创建 TeamsCallAgent 的选项。

有关 Teams 通话的信息。

TeamsCaptions 对象的数据结构

为每个 CaptionsReceivedEventType 事件接收的数据结构

重新发送 Teams 传入呼叫。

TeamsMeetingAudioConferencing 呼叫功能。

表示 Teams 会议音频会议详细信息

表示分配给音频会议网桥的电话号码

用于使用会议坐标加入会议的定位符。

用于使用会议 ID 和代码加入会议的定位符。

用于使用会议链接加入会议的定位符。

一起模式呼叫功能。

一起模式的场景大小

一起模式座位位置 CSS 坐标

表示一起模式机器人视频流。

呼叫听录的功能。

表示 Transfer 对象

呼叫转接的功能。

传输错误代码

传输事件基础

将呼叫转接到另一个呼叫

用于将呼叫转接到呼叫的选项

将呼叫转接给参与者

用于将呼叫转接给参与者的选项

将呼叫转接到语音邮件

用于将呼叫转接到语音邮件的选项

传输媒体统计信息的泛型类型

表示通过它发送所有媒体流量的轮次服务器配置。

呼叫诊断的功能。

视频流的约束

有关相机设备的信息。

基本视频效果。

基本视频效果配置。

VideoEffects 功能的 API 接口

视频质量诊断

表示 CallOption 中的视频选项

表示视频流功能

表示为构造函数上的扩展音频/视频流功能提供的上下文。

表示视频流功能的工厂

视频流的视图。

音频设备的类型。

音频效果功能错误侦听器回调类型

音频效果功能事件

音频效果功能侦听器回调类型

表示呼叫调查音频问题的结束。

示例：

NoLocalAudio - other participants unable to hear me.
NoRemoteAudio - participant unable to hear another participant's audio.
Echo - heard echo.
AudioNoise - heard audio noise.
LowVolume - call audio volume was low.
AudioStoppedUnexpectedly - call audio stopped unexpectedly.
DistortedSpeech - audio was distorted.
AudioInterruption - audio was interrupted.
OtherIssues - any other audio issue not listed here.

音频源更改事件的有效负载。

表示 AudioStreamFeature 对象的构造函数以及上下文参数。

背景模糊配置。

分组讨论室状态

所有 BreakoutRoom 更新事件的事件类型的名称

更新的所有 BreakoutRoom 的事件类型的名称

用于处理分组讨论室事件的回调定义。

表示 CallAgentFeature 对象的构造函数以及上下文参数。

表示 CallClientFeature 对象的构造函数以及上下文参数。

呼叫方向：

• “传入”
• “传出”

调用结束事件的有效负载。

表示 CallFeature 对象的构造函数以及上下文参数。

调用堆栈初始化状态

调用状态。

用于处理 CaptionsReceivedEventType 事件的回调定义。

功能更改事件的事件类型

功能更改的原因

功能解决原因

标题语言更改事件的事件类型

用于处理 CaptionsReceivedEventType 事件的回调定义

用于对 Captions 对象类型进行分类的题注类型

Captions 类型更改事件的事件类型

captions 属性更改事件的事件类型

已接收标题事件的事件类型

用于对当前短语听录的结局进行分类的类型

如果文本包含部分口述句子，CaptionInfo 将具有 PartialType。 如果句子已完全转录，CaptionInfo 将具有 Final 的 ResultType。

已更改参与者功能

集合更新事件的有效负载。

复合音频设备的类型。

ConnectionState 用于指示 CallAgent 的连接状态。

• “已连接”- CallAgent 已连接并准备好接收传入呼叫。
• “Disconnected”- CallAgent 已断开连接，可能无法接收传入呼叫。

状态更改事件的有效负载。

连接状态更改的原因。

DataChannelSenderOpenOptions 中的 priority 选项

DataChannel 关闭事件侦听器

DataChannel dataChannelReceiverCreated 事件侦听器

DataChannel messageReady 事件侦听器

DataChannelSenderOpenOptions 中的可靠性选项

用于创建 DataChannel 发件人对象的发件人选项

设备可用性等级

浏览器/OS 支持等级

设备类型。

调用“diagnosticChanged”事件的侦听器参数

• 值为 DiagnosticQuality 或 DiagnosticFlag：
  • DiagnosticQuality = enum { Good = 1， Poor = 2， Bad = 3 }.
  • DiagnosticFlag = true |假。
• valueType = 'DiagnosticQuality' |“DiagnosticFlag”

布尔相关诊断的布尔标志值，例如 DeviceSpeakWhileMuted、NoNetwork 等...

诊断值类型。 DiagnosticQuality 或 DiagnosticFlag

PSTN 呼叫的 DTMF 音调。

浏览器信息

环境信息

组定位符。

传入调用事件的有效负载。

屏幕共享的泛型类型接收媒体统计信息

呼叫诊断的最新值

下放手功能的事件类型的名称

用于处理 LowerHandEventType 事件的回调定义。

用于处理 mediaAccessChanged 事件的回调定义。

• diagnostic 是媒体诊断的类型，例如 SpeakingWhileMicrophoneIsMuted、cameraStartFailed 等...

媒体诊断类型

summaryReported 事件中统计信息的属性

每个统计信息字段的聚合属性。

媒体统计信息收集器的选项

发出 sampleReported 事件的媒体统计信息的有效负载。

媒体统计信息发出的 summaryReported 事件的有效负载。

媒体流类型。

• 视频 - 来自相机设备的媒体流
• ScreenSharing - 屏幕、应用或浏览器选项卡中的媒体流
• RawMedia - 原始视频媒体流或原始屏幕共享流
• LiveStream - 来自实时流的媒体流
• 音频 - 来自音频设备的媒体流

会议定位符。

用于处理 mediaAccessChanged 事件的回调定义。

• diagnostic 是网络诊断的类型，例如 networkRcvQuality、noNetwrok 等...DeviceSpeakWhileMuted 等...

网络诊断的类型

表示干扰抑制效果名称

屏幕共享的泛型类型发送媒体统计信息

表示呼叫调查呼叫问题的结束。

示例：

CallCannotJoin - participant is unable to join the call.
CallCannotInvite - participant is unable to add another participant in the call.
HadToRejoin - participant rejoined the call due the call quality issue.
CallEndedUnexpectedly - when the call ended unexpectedly.
OtherIssues - any other overall call issue not listed here.

参与者功能

功能解决原因

参与者角色。

诊断结果

属性更改事件的有效负载。

推送通知数据

呼叫质量等级

用于举手功能的事件类型的名称

用于处理 RaisedHandEventType 事件的回调定义。

为每个人定义的反应类型

用于处理 ReactionEventType 事件的回调定义。

面向诊断有效负载的远程用户。

远程参与者状态。

错误结果类别

房间定位符。

PreCallDiagnostics 选项

视频流的视图的缩放模式。

表示呼叫调查屏幕共享问题的结束。

示例：

NoContentLocal - other participants unable to see my screen.
NoContentRemote - participant unable to saw another participant's screen share.
CannotPresent - participant was unable to share the screen.
LowQuality - screen share video quality was low.
Freezes - screen share freezes.
StoppedUnexpectedly - screen share stopped unexpectedly.
LargeDelay - watch screen share having large delay.
OtherIssues - any other screen share issue not listed here.

服务器诊断

字幕口语更改事件的事件类型

聚焦功能的事件类型的名称

用于处理 CaptionsReceivedEventType 事件的回调定义

Teams 传入呼叫事件的有效负载。

用于处理 togetherMode 场景更新事件的回调定义。

参与者的 MRI 到座位位置的映射

用于处理 togetherMode 座位更新事件的回调定义。

听录属性已更改事件。

接受传输的事件

接受传输的事件类型的名称

传输状态

视频设备的类型。

视频效果错误类型。

视频效果错误有效负载。

表示视频效果的名称。

所有效果的联合类型

“effectsError”订阅函数的侦听器类型

订阅事件的类型

效果功能订阅函数的侦听器类型

表示通话调查视频问题的结束。

示例：

NoVideoReceived - participant unable to saw another participant's video.
NoVideoSent - other participants unable to see me.
LowQuality - video quality was low.
Freezes - video freezes.
StoppedUnexpectedly - video stopped unexpectedly.
DarkVideoReceived - participant receives dark video.
AudioVideoOutOfSync - participant watch video and audio out of sync.
OtherIssues - any other video issue not listed here.

表示视频流约束

视频源更改事件的有效负载。

表示 VideoStreamFeature 对象的构造函数以及上下文参数。

X 标头。

调用代理对象的类型。

调用对象的类型。

与质量相关的诊断的质量价值，例如 NetworkSendQuality、NetworkRevQuality 等...好 = 1，没有问题。 差 = 2， 温和的问题。 错误 = 3，严重问题。

传入调用对象的类型。

本地重新记录状态

记录状态。