@azure/communication-calling package

类

CallClient	CallClient 是 SDK 的主要入口点。 CallClient 用于创建 CallAgent 并获取 DeviceManager。
LocalAudioStream	表示本地 michrophone 设备的本地音频流
LocalVideoStream	表示本地相机设备的本地视频流
VideoStreamRenderer	视频流的呈现器

接口

AcceptCallOptions	用于接受传入呼叫的选项。 传递将用于接受传入呼叫的视频流。 如果未定义 videoOptions，则将接受传入呼叫，并关闭本地视频。 如果未定义 AudioOptions，则传入呼叫将接受默认麦克风作为设备管理器的源。
ActiveAudioEffects	表示当前活动音频效果
AddCommunicationUserOptions	用于将 AddCommunicationUserOptions 参与者添加到正在进行的呼叫的选项。
AddMicrosoftTeamsUserOptions	用于将 MicrosoftTeamsUser 参与者添加到正在进行的呼叫的选项。
AddPhoneNumberOptions	用于将 PSTN 参与者添加到正在进行的呼叫的选项。
AddTeamsParticipantOptions	用于将 Teams 参与者添加到正在进行的 Teams 通话的选项。
AdmitAllOperationResult	允许所有参与者的结果。
AdmitLobbyParticipantOptions	允许来自大厅的参与者的选项。
AssignedBreakoutRoomsEvent	分配的分组讨论室事件的接口名称
AudioDeviceInfo	有关麦克风或扬声器设备的信息。
AudioEffect	基本音频效果。
AudioEffectsFeature	AudioEffects 功能的 API 接口
AudioEffectsStartConfig	表示开始效果时的音频效果配置
AudioEffectsStopConfig	表示停止效果时的音频效果配置
AudioInCallDiagnostics	音频质量诊断
AudioOptions	发出传出呼叫或加入组呼叫时提供的音频选项。
AudioStreamFeature	表示音频流功能
AudioStreamFeatureContext	表示为构造函数中的扩展音频/视频流功能提供的上下文。
AudioStreamFeatureFactory	表示音频流功能的工厂
BackgroundBlurEffect	背景模糊效果。
BackgroundReplacementConfig	后台替换配置。
BackgroundReplacementEffect	背景替换效果。
BaseFeature	表示任何功能的基接口
BaseInCallDiagnostics	在收集的呼叫诊断中
BreakoutRoom	分组讨论室详细信息
BreakoutRoomsCallFeature	分组讨论室呼叫功能。
BreakoutRoomsEvent	所有可用分组讨论室可用事件的接口名称
BreakoutRoomsSettings	用户加入分组讨论室后可用的分组讨论室设置
BreakoutRoomsSettingsEvent	可用分组讨论室设置的接口名称
Call	表示调用。
CallAgent	CallAgent 用于处理调用。
CallAgentCommon	CallAgent 通用接口。
CallAgentFeature	表示 CallAgent 功能。
CallAgentFeatureContext	表示为构造函数中的扩展调用代理功能的上下文。
CallAgentFeatureFactory	表示呼叫代理功能的工厂
CallAgentOptions	用于创建 CallAgent 的选项。
CallClientFeature	表示 CallClient 功能。
CallClientFeatureContext	表示为构造函数上的扩展调用客户端功能提供的上下文。
CallClientFeatureFactory	表示调用客户端代理功能的工厂
CallClientOptions	调用客户端选项
CallCommon	调用通用接口。
CallConstraints	表示调用的约束
CallDiagnostics	呼叫诊断
CallEndReason	描述调用结束的原因。
CallFeature	表示呼叫功能。
CallFeatureContext	表示为构造函数上的扩展调用功能提供的上下文。
CallFeatureFactory	表示调用功能的工厂
CallInfo	有关呼叫的信息。
CallInfoCommon	CallInfo 通用接口。
CallRating	表示通话调查评级。
CallSurvey	表示呼叫调查的结束。
CallSurveyFeature	ACS 实时传送视频流功能
CallSurveyResponse	表示呼叫调查响应的结束。
CallerInfo	调用方信息。
CapabilitiesChangeInfo	为每个 CapabilitiesChangedEventType 事件接收的数据结构。
CapabilitiesFeature	功能功能。
Captions	Captions 对象的数据结构
CaptionsCallFeature	标题功能
CaptionsCommon	CaptionsCommon 对象的数据结构
CaptionsInfo	为每个 CaptionsReceivedEventType 事件接收的数据结构
CommunicationServicesError	API 调用失败时引发的错误。
CompositeAudioDeviceInfo	有关复合音频设备的信息。
CreateViewOptions	视频流的呈现器的选项。
CustomContext	在调用自定义上下文上收到选项。
CustomContextOptions	用于调用自定义上下文的选项。
DataChannelCallFeature	DataChannel 调用功能
DataChannelMessage	DataChannel 消息
DataChannelReceiver	DataChannel 接收器
DataChannelSender	DataChannel 发送方
DebugInfoCallClientFeature	调用调试信息的功能。
DebugInfoDump	转储 ID 是每个调试信息转储的唯一Identifier
DeepNoiseSuppressionEffect	深度噪声抑制效果
DeviceAccess	用户授予的权限。
DeviceCompatibility	设备兼容性信息
DeviceEnumeration	设备枚举信息
DeviceManager	设备管理器用于处理系统媒体设备，例如相机、麦克风和扬声器。
DiagnosticOptions	诊断选项
Disposable	释放对象。
DominantSpeakersCallFeature	呼叫主导扬声器的功能。
DominantSpeakersInfo	有关通话的主要说话人的信息
EmergencyCallOptions
EndpointDetails	远程参与者终结点的详细信息
FeatureFactory	表示用于分解特征的接口
GroupCallLocator	用于加入组呼叫的定位符。
GroupChatCallLocator	用于加入群组聊天呼叫的定位符。
HangUpOptions	用于挂断呼叫的选项。
IceServer	表示冰服务器（眩晕/转弯）
InCallDiagnostics	呼叫诊断信息
IncomingAudioMediaStats	音频的泛型类型接收媒体统计信息
IncomingCall	表示传入呼叫。
IncomingCallCommon	传入调用通用接口。
IncomingCallPushNotificationData	传入呼叫推送通知数据
IncomingVideoMediaStats	视频的泛型类型接收媒体统计信息
Invitee	被邀请者详细信息
JoinBreakoutRoomsEvent	分组讨论室联接事件的事件类型的名称
JoinCallOptions	用于加入组呼叫的选项。 传递将用于启动呼叫的视频流。 呼叫中的远程参与者将收到视频流，以便他们可以在 UI 中呈现视频流。 传递音频选项天气以加入呼叫静音或取消静音。 如果未定义 videoOptions，则呼叫将以本地视频关闭开始。
LatestMediaDiagnostics	引发的最新媒体诊断。
LatestNetworkDiagnostics	引发的最新网络诊断。
Lobby	Teams 会议大厅
LocalRecordingCallFeature	呼叫录制功能。
LocalRecordingInfo	本地录制信息。
MediaConstraintRange	约束范围
MediaDiagnostics	媒体诊断
MediaStatsCallFeature	在通话中获取媒体统计信息的功能。
MediaStatsCollector	媒体统计信息收集器。
MediaStatsReportSample	来自“sampleReported”事件的媒体统计信息
MediaStatsReportSummary	来自“summaryReported”事件的聚合媒体统计信息
NetworkConfiguration	表示在创建呼叫客户端时要设置的网络配置
NetworkDiagnostics	网络诊断
OptimalVideoCountCallFeature	最佳视频计数的功能
OutgoingAudioMediaStats	音频的泛型类型发送媒体统计信息
OutgoingVideoMediaStats	视频的泛型类型发送媒体统计信息
PPTLiveCallFeature	PPTLive 功能。
ParticipantInfo	表示通话中的参与者。
PermissionConstraints	定义访问本地设备的约束。
PreCallDiagnosticsFeature	PreCallDiagnostics 功能
ProxyConfiguration	表示代理服务器的代理配置，用于通过该代理服务器发送流量。
RaiseHandCallFeature	举手呼叫反应功能。
RaisedHand	举手状态对象
RaisedHandChangedEvent	下手事件信息
RatingScale	用于替代默认缩放的分级缩放
ReactionCallFeature	会议反应功能。
ReactionEventPayload	反应消息数据模型
ReactionMessage	反应消息类型
RecordingCallFeature	呼叫录制功能。
RecordingInfo	呼叫录制信息。
RejectLobbyParticipantOptions	拒绝来自大厅的参与者的选项。
RejoinMainMeetingEvent	主会议加入事件的事件类型的名称
RemoteAudioStream	呼叫的远程音频流。
RemoteDiagnostics	远程诊断
RemoteParticipant	表示呼叫中的远程参与者。
RemoteParticipantDiagnosticsData	引发的远程诊断。
RemoteVideoStream	表示远程参与者的视频或屏幕共享。
RemoteVideoStreamCommon	表示远程参与者的视频或屏幕共享或实时流。
RoomCallLocator	用于加入会议室呼叫的定位符。
SpotlightCallFeature	聚焦呼叫功能。
SpotlightedParticipant	聚焦状态已更改事件对象
StartCallOptions	用于启动传出呼叫的选项。
StartCaptionsOptions	传递给 StartCaptions 的选项
StartTeamsCallOptions	用于启动传出 Teams 呼叫的选项。
StartTeamsGroupCallOptions	用于启动传出 Teams 组呼叫的选项。
StreamSize	流大小。
SubmitSurveyOptions	提交呼叫调查的选项。
TeamsCall	表示 Teams 通话。
TeamsCallAgent	TeamsCallAgent 用于处理 Teams 呼叫。
TeamsCallAgentOptions	用于创建 TeamsCallAgent 的选项。
TeamsCallInfo	有关 Teams 通话的信息。
TeamsCaptions	TeamsCaptions 对象的数据结构
TeamsCaptionsInfo	为每个 CaptionsReceivedEventType 事件接收的数据结构
TeamsIncomingCall	重新发送 Teams 传入呼叫。
TeamsMeetingAudioConferencingCallFeature	TeamsMeetingAudioConferencing 呼叫功能。
TeamsMeetingAudioConferencingDetails	表示 Teams 会议音频会议详细信息
TeamsMeetingAudioConferencingPhoneNumber	表示分配给音频会议网桥的电话号码
TeamsMeetingCoordinatesLocator	用于使用会议坐标加入会议的定位符。
TeamsMeetingIdLocator	用于使用会议 ID 和代码加入会议的定位符。
TeamsMeetingLinkLocator	用于使用会议链接加入会议的定位符。
TogetherModeCallFeature	一起模式呼叫功能。
TogetherModeSceneSize	一起模式的场景大小
TogetherModeSeatingPosition	一起模式座位位置 CSS 坐标
TogetherModeVideoStream	表示一起模式机器人视频流。
TranscriptionCallFeature	呼叫听录的功能。
Transfer	表示 Transfer 对象
TransferCallFeature	呼叫转接的功能。
TransferErrorCode	传输错误代码
TransferEventArgs	传输事件基础
TransferToCallLocator	将呼叫转接到另一个呼叫
TransferToCallOptions	用于将呼叫转接到呼叫的选项
TransferToParticipantLocator	将呼叫转接给参与者
TransferToParticipantOptions	用于将呼叫转接给参与者的选项
TransferToVoicemailLocator	将呼叫转接到语音邮件
TransferToVoicemailOptions	用于将呼叫转接到语音邮件的选项
TransportMediaStats	传输媒体统计信息的泛型类型
TurnConfiguration	表示通过它发送所有媒体流量的轮次服务器配置。
UserFacingDiagnosticsFeature	呼叫诊断的功能。
VideoConstraints	视频流的约束
VideoDeviceInfo	有关相机设备的信息。
VideoEffect	基本视频效果。
VideoEffectConfig	基本视频效果配置。
VideoEffectsFeature	VideoEffects 功能的 API 接口
VideoInCallDiagnostics	视频质量诊断
VideoOptions	表示 CallOption 中的视频选项
VideoStreamFeature	表示视频流功能
VideoStreamFeatureContext	表示为构造函数上的扩展音频/视频流功能提供的上下文。
VideoStreamFeatureFactory	表示视频流功能的工厂
VideoStreamRendererView	视频流的视图。
Volume

类型别名

AudioDeviceType	音频设备的类型。
AudioEffectsFeatureErrorListener	音频效果功能错误侦听器回调类型
AudioEffectsFeatureEvent	音频效果功能事件
AudioEffectsFeatureListener	音频效果功能侦听器回调类型
AudioIssue	表示呼叫调查音频问题的结束。 示例： 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.
AudioSourceChangedEvent	音频源更改事件的有效负载。
AudioStreamFeatureCtor	表示 AudioStreamFeature 对象的构造函数以及上下文参数。
BackgroundBlurConfig	背景模糊配置。
BreakoutRoomState	分组讨论室状态
BreakoutRoomsEventData	所有 BreakoutRoom 更新事件的事件类型的名称
BreakoutRoomsUpdated	更新的所有 BreakoutRoom 的事件类型的名称
BreakoutRoomsUpdatedListener	用于处理分组讨论室事件的回调定义。
CallAgentFeatureCtor	表示 CallAgentFeature 对象的构造函数以及上下文参数。
CallClientFeatureCtor	表示 CallClientFeature 对象的构造函数以及上下文参数。
CallDirection	呼叫方向： “传入” “传出”
CallEndedEvent	调用结束事件的有效负载。
CallFeatureCtor	表示 CallFeature 对象的构造函数以及上下文参数。
CallInformationContext
CallInformationIdentifierKind
CallInformationScenario
CallInitializationResult	调用堆栈初始化状态
CallState	调用状态。
CapabilitiesChangeHandler	用于处理 CaptionsReceivedEventType 事件的回调定义。
CapabilitiesChangedEventType	功能更改事件的事件类型
CapabilitiesChangedReason	功能更改的原因
CapabilityResolutionReason	功能解决原因
CaptionLanguageChangedEventType	标题语言更改事件的事件类型
CaptionsHandler	用于处理 CaptionsReceivedEventType 事件的回调定义
CaptionsKind	用于对 Captions 对象类型进行分类的题注类型
CaptionsKindChangedEventType	Captions 类型更改事件的事件类型
CaptionsPropertyChangedEventType	captions 属性更改事件的事件类型
CaptionsReceivedEventType	已接收标题事件的事件类型
CaptionsResultType	用于对当前短语听录的结局进行分类的类型 如果文本包含部分口述句子，CaptionInfo 将具有 PartialType。 如果句子已完全转录，CaptionInfo 将具有 Final 的 ResultType。
ChangedParticipantCapabilities	已更改参与者功能
CollectionUpdatedEvent	集合更新事件的有效负载。
CompositeAudioDeviceType	复合音频设备的类型。
ConnectionState	ConnectionState 用于指示 CallAgent 的连接状态。 “已连接”- CallAgent 已连接并准备好接收传入呼叫。 “Disconnected”- CallAgent 已断开连接，可能无法接收传入呼叫。
ConnectionStateChangedEvent	状态更改事件的有效负载。
ConnectionStateChangedReason	连接状态更改的原因。
DataChannelPriority	DataChannelSenderOpenOptions 中的 priority 选项
DataChannelReceiverCloseEvent	DataChannel 关闭事件侦听器
DataChannelReceiverCreatedEvent	DataChannel dataChannelReceiverCreated 事件侦听器
DataChannelReceiverMessageReadyEvent	DataChannel messageReady 事件侦听器
DataChannelReliability	DataChannelSenderOpenOptions 中的可靠性选项
DataChannelSenderOpenOptions	用于创建 DataChannel 发件人对象的发件人选项
DeviceAvailabilityGrade	设备可用性等级
DeviceSupportGrade	浏览器/OS 支持等级
DeviceType	设备类型。
DiagnosticChangedEventArgs	调用“diagnosticChanged”事件的侦听器参数 值为 DiagnosticQuality 或 DiagnosticFlag： DiagnosticQuality = enum { Good = 1， Poor = 2， Bad = 3 }. DiagnosticFlag = true |假。 valueType = 'DiagnosticQuality' |“DiagnosticFlag”
DiagnosticFlag	布尔相关诊断的布尔标志值，例如 DeviceSpeakWhileMuted、NoNetwork 等...
DiagnosticValueType	诊断值类型。 DiagnosticQuality 或 DiagnosticFlag
DtmfTone	PSTN 呼叫的 DTMF 音调。
Environment	浏览器信息
EnvironmentInfo	环境信息
GroupLocator	组定位符。
IncomingCallEvent	传入调用事件的有效负载。
IncomingScreenShareMediaStats	屏幕共享的泛型类型接收媒体统计信息
LatestDiagnosticValue	呼叫诊断的最新值
LoweredHandEventType	下放手功能的事件类型的名称
LoweredHandListener	用于处理 LowerHandEventType 事件的回调定义。
MediaDiagnosticChangedEventArgs	diagnostic 是媒体诊断的类型，例如 SpeakingWhileMicrophoneIsMuted、cameraStartFailed 等...
MediaDiagnosticType	媒体诊断类型
MediaStatValue	summaryReported 事件中统计信息的属性
MediaStatsAggregation	每个统计信息字段的聚合属性。
MediaStatsCollectorOptions	媒体统计信息收集器的选项
MediaStatsReportSampleEvent	发出 sampleReported 事件的媒体统计信息的有效负载。
MediaStatsReportSummaryEvent	媒体统计信息发出的 summaryReported 事件的有效负载。
MediaStreamType	媒体流类型。 视频 - 来自相机设备的媒体流 ScreenSharing - 屏幕、应用或浏览器选项卡中的媒体流 RawMedia - 原始视频媒体流或原始屏幕共享流 LiveStream - 来自实时流的媒体流 音频 - 来自音频设备的媒体流
MeetingLocator	会议定位符。
NetworkDiagnosticChangedEventArgs	diagnostic 是网络诊断的类型，例如 networkRcvQuality、noNetwrok 等...DeviceSpeakWhileMuted 等...
NetworkDiagnosticType	网络诊断的类型
NoiseSuppressionEffectName	表示干扰抑制效果名称
OutgoingScreenShareMediaStats	屏幕共享的泛型类型发送媒体统计信息
OverallIssue	表示呼叫调查呼叫问题的结束。 示例： 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.
ParticipantCapabilities	参与者功能
ParticipantCapabilityName	功能解决原因
ParticipantRole	参与者角色。
PreCallDiagnosticsResult	诊断结果
PropertyChangedEvent	属性更改事件的有效负载。
PushNotificationData	推送通知数据
QualityGrade	呼叫质量等级
RaisedHandEventType	用于举手功能的事件类型的名称
RaisedHandListener	用于处理 RaisedHandEventType 事件的回调定义。
Reaction	为每个人定义的反应类型
ReactionListener	用于处理 ReactionEventType 事件的回调定义。
RemoteDiagnostic	面向诊断有效负载的远程用户。
RemoteParticipantState	远程参与者状态。
ResultCategories	错误结果类别
RoomLocator	房间定位符。
RunOptions	PreCallDiagnostics 选项
ScalingMode	视频流的视图的缩放模式。
ScreenshareIssue	表示呼叫调查屏幕共享问题的结束。 示例： 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.
ServerDiagnosticType	服务器诊断
SpokenLanguageChangedEventType	字幕口语更改事件的事件类型
SpotlightChangedEventType	聚焦功能的事件类型的名称
TeamsCaptionsHandler	用于处理 CaptionsReceivedEventType 事件的回调定义
TeamsIncomingCallEvent	Teams 传入呼叫事件的有效负载。
TogetherModeSceneUpdatedListener	用于处理 togetherMode 场景更新事件的回调定义。
TogetherModeSeatingMap	参与者的 MRI 到座位位置的映射
TogetherModeSeatingUpdatedListener	用于处理 togetherMode 座位更新事件的回调定义。
TranscriptionPropertyChangedEventType	听录属性已更改事件。
TransferAcceptedEvent	接受传输的事件
TransferAcceptedEventType	接受传输的事件类型的名称
TransferState	传输状态
VideoDeviceType	视频设备的类型。
VideoEffectError	视频效果错误类型。
VideoEffectErrorPayload	视频效果错误有效负载。
VideoEffectName	表示视频效果的名称。
VideoEffectProcessor	所有效果的联合类型
VideoEffectsFeatureErrorListener	“effectsError”订阅函数的侦听器类型
VideoEffectsFeatureEvent	订阅事件的类型
VideoEffectsFeatureListener	效果功能订阅函数的侦听器类型
VideoIssue	表示通话调查视频问题的结束。 示例： 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.
VideoSendConstraints	表示视频流约束
VideoSourceChangedEvent	视频源更改事件的有效负载。
VideoStreamFeatureCtor	表示 VideoStreamFeature 对象的构造函数以及上下文参数。
xHeader	X 标头。

枚举

CallAgentKind	调用代理对象的类型。
CallKind	调用对象的类型。
DiagnosticQuality	与质量相关的诊断的质量价值，例如 NetworkSendQuality、NetworkRevQuality 等...好 = 1，没有问题。 差 = 2， 温和的问题。 错误 = 3，严重问题。
IncomingCallKind	传入调用对象的类型。
LocalRecordingState	本地重新记录状态
RecordingState	记录状态。