共用方式為


@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

所有可用的 BreakoutRooms 介面名稱

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

傾印標識碼是每個偵錯信息傾印的唯一標識符

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

表示 Proxy 伺服器的 Proxy 組態,以透過該 Proxy 伺服器傳送流量。

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

定位器,用來加入會議標識碼和程式碼的會議。

TeamsMeetingLinkLocator

定位器,用於加入會議連結的會議。

TogetherModeCallFeature

一起模式通話功能。

TogetherModeSceneSize

一起模式的場景大小

TogetherModeSeatingPosition

一起模式座位位置 CSS 座標

TogetherModeVideoStream

表示一起模式 Bot 視訊串流。

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

表示在 constuctor 上針對擴充音訊/視訊串流功能提供的內容。

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

所有 BreakoutRooms 更新事件的事件類型名稱

BreakoutRoomsUpdated

已更新所有 BreakoutRoom 的事件類型名稱

BreakoutRoomsUpdatedListener

處理分會室事件的回呼定義。

CallAgentFeatureCtor

表示 CallAgentFeature 物件的建構函式,以及內容自變數。

CallClientFeatureCtor

表示 CallClientFeature 物件的建構函式,以及內容自變數。

CallDirection

通話方向:

  • 'Incoming'
  • 'Outgoing'
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 將會有 Partial 的 ResultType。 如果句子完全轉譯,CaptionInfo 將會有 Final 的 ResultType。

ChangedParticipantCapabilities

已變更參與者功能

CollectionUpdatedEvent

集合更新事件的承載。

CompositeAudioDeviceType

複合音訊裝置的類型。

ConnectionState

ConnectionState 用來指出 CallAgent 的連接狀態。

  • 「已連線」- CallAgent 已連線並準備好接收來電。
  • 「已中斷連線」- 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 等...Good = 1,沒有問題。 可憐 = 2, 溫和的問題。 Bad = 3,嚴重問題。

IncomingCallKind

傳入呼叫物件的種類。

LocalRecordingState

本機重新記錄狀態

RecordingState

錄製狀態。