@azure/communication-calling package

The CallClient is the main entry point to the SDK. The CallClient is used to create the CallAgent and to get the DeviceManager.

Represents a local audio stream for a local michrophone device

Represents a local video stream for a local camera device

The renderer for a video stream

Options for accepting an incoming call. Pass video streams that will be used to accept an incoming call. If videoOptions is undefined, then the incoming call will be accepted with local video off. If AudioOptions is undefined, then the incoming call will be accepted with default microphone as source from device manager.

Represents the current active audio effects

Options for adding a AddCommunicationUserOptions participant to an on-going call.

Options for adding a MicrosoftTeamsUser participant to an on-going call.

Options for adding a PSTN participant to an on-going call.

Options for adding a Teams participant to an on-going Teams call.

Result for admit all participants.

Options for admit participant from Lobby.

Name of interface for assigned breakout room event

Information about a microphone or speaker device.

Base audio effect.

API interface for the AudioEffects feature

Represents the audio effects config while starting effects

Represents the audio effects config while stopping effects

Audio quality diagnostics

Audio options provided when making an outgoing call or joining a group call.

Represents a Audio stream feature

Represents the context provided for extended audio/video stream features at the constructor.

Represents the factory of the audio stream features

Background blur effect.

Background replacement config.

Background replacement effect.

Represents the base interface for any Feature

In Call diagnostics gathered

Breakout room details

Breakout rooms call feature.

Name of interface for all BreakoutRooms available Event

Breakout room settings available once the user joins the breakout room

Name of interface for breakoutroom settings available event

Represents a Call.

The CallAgent is used to handle calls.

CallAgent common interface.

Represents a CallAgent Feature.

Represents the context provided for extended call agent features at the constructor.

Represents the factory of call agent features

Options for creating CallAgent.

Represents a CallClient Feature.

Represents the context provided for extended call client features at the constructor.

Represents the factory of call client agent features

Call client options

The Call common interface.

Represents constraints for a call

Call diagnostics

Describes the reason why the call ended.

Represents a Call Feature.

Represents the context provided for extended call features at the constructor.

Represents the factory of call features

Information about a Call.

CallInfo common interface.

Represents a call survey rating.

Represents the end of call survey.

Feature for ACS Live Streaming

Represents the end of call survey response.

Caller Information.

Data structure received for each CapabilitiesChangedEventType event.

Capabilities Feature.

Data structure for Captions object

Feature for Captions

Data structure for CaptionsCommon object

Data structure received for each CaptionsReceivedEventType event

Error that get's throw when API call fails.

Information about a composite audio device.

Options for the renderer of a video stream.

Received Options on call custom context.

Options for call custom context.

DataChannel Call Feature

DataChannel message

DataChannel receiver

DataChannel sender

Feature for call debug info.

dump id is a uniqueIdentifier for each debug info dump

Deep noise suppression effect

Permissions granted by the user.

Device compatibility information

Device enumeration information

The Device Manager is used to handle system media devices such as cameras, microphones, and speakers.

Diagnostic options

Dispose of an object.

Feature for call dominant speaker.

Information about the dominant speakers of a call

Details of a remote participant's endpoint

Represents the interface for factoring a feature

Locator used for joining a group call.

Locator used to joining group chat call.

Options for hanging up a call.

Represents an ice server (stun/turn)

Call diagnostic information

Generic type of audio receive media stats

Represents an incoming call.

The incoming call common interface.

Incoming call push notification data

Generic type of video receive media stats

Invitee details

Name of event type for breakoutroom joined event

Options for joining a group call. Pass video stream that will be used to start a call. Remote participants in the call will receive your video stream so that they can render it in their UIs. Pass audio options weather to join the call muted or unmuted. If videoOptions is undefined, then call will be started with local video off.

Latest media diagnostics that were raised.

Latest network diagnostics that were raised.

Teams meeting lobby

Feature for call recording.

Local Recording Information.

Constraint range

Media Diagnostics

Feature for getting media stats while in a call.

Media stats collector.

media stats from 'sampleReported' event

Aggregated media stats from 'summaryReported' event

Represents the network configuration to set while creating the call client

Network Diagnostics

Feature for Optimal Video count

Generic type of audio send media stats

Generic type of video send media stats

PPTLive feature.

Represents a participant in a call.

Define constraints for accessing local devices.

PreCallDiagnostics feature

Represents the proxy configuration of the proxy server to send traffic through that proxy server.

Raise hand call reaction feature.

Raise hand state object

Lower hand event information

Rating scale to override the default scale

Meeting reaction feature.

Reaction message data model

Reaction Message type

Feature for call recording.

Call Recording Information.

Options for reject a participant from Lobby.

Name of event type for main meeting joined event

Remote audio stream of the call.

Remote Diagnostics

Represents a remote participant in a call.

Remote diagnostics that were raised.

Represents a remote participant's video or screen-sharing.

Represents a remote participant's video or screen-sharing or live stream.

Locator used for joining a room call.

Spotlight call feature.

Spotlight state changed event object

Options for starting an outgoing call.

Options passed to StartCaptions

Options for starting an outgoing Teams call.

Options for starting an outgoing Teams group call.

Stream size.

Options for submitting call survey.

Represents a Teams Call.

The TeamsCallAgent is used to handle Teams calls.

Options for creating TeamsCallAgent.

Information about a Teams Call.

Data structure for TeamsCaptions object

Data structure received for each CaptionsReceivedEventType event

Reoresents a Teams incoming call.

TeamsMeetingAudioConferencing call feature.

Represents a Teams meeting audio conferencing details

Represents phone number assigned to a audio conferencing bridge

Locator used for joining a meeting with meeting coordinates.

Locator used for joining a meeting with meeting id and code.

Locator used for joining a meeting with meeting link.

Together mode call feature.

Scene Size of Together Mode

Together Mode Seating position CSS coordinates

Represents a together mode bot video stream.

Feature for call transcription.

Represents a Transfer Object

Feature for call transfer.

Transfer error code

Transfer event base

Transfer call into another call

Options for transfering a call to a call

Transfer call to participant

Options for transfering a call to a participant

Transfer call to voicemail

Options for transferring a call to voicemail

Generic type of transport media stats

Represents the turn server configuration to send all media traffic through it.

Feature for call diagnostics.

Constraint of video stream

Information about a camera device.

Base video effect.

Base video effect config.

API interface for the VideoEffects feature

Video quality diagnostics

Represents video option in CallOption

Represents a Video stream feature

Represents the context provided for extended audio/video stream features at the constuctor.

Represents the factory of video stream features

The view for a video stream.

Type of an audio device.

Audio effects feature error listener callback type

Audio effects feature events

Audio effects feature listener callback type

Represents the end of call survey audio issues.

Example

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.

Payload for audio source changed event.

Represents the constructor for AudioStreamFeature object, along with the context argument.

Background blur config.

Breakout room state

Name of event type for all BreakoutRooms updated events

Name of event type for all BreakoutRooms updated

Callback definition for handling breakout rooms events.

Represents the constructor for CallAgentFeature objects, along with the context argument.

Represents the constructor for CallClientFeature objects, along with the context argument.

Direction of a call:

• 'Incoming'
• 'Outgoing'

Payload for call ended event.

Represents the constructor for CallFeature objects, along with the context argument.

Call stack initialization states

Call states.

Callback definition for handling the CaptionsReceivedEventType event.

Event type for capabilities changed event

Capabilities Changed Reason

Capability Resolution Reason

Event type for caption language changed event

Callback definition for handling the CaptionsReceivedEventType event

Captions Type for classifying Captions object kind

Event type for Captions Type changed event

Event type for captions property changed event

Event type for captions received event

Type for classifying the finality of the current phrase's transcription

CaptionInfo will have ResultType of Partial if the text contains partially spoken sentence. CaptionInfo will have ResultType of Final if once the sentence has been completely transcribed.

Changed Participant Capabilities

Payload for collection updated event.

Type of a composite audio device.

The ConnectionState is used to indicate the connection state of the CallAgent.

• 'Connected' - The CallAgent is connected and ready to receive incoming calls.
• 'Disconnected' - The CallAgent is disconnected and might not receive incoming calls.

Payload for state changed event.

Reason why connection state changed.

priority option in DataChannelSenderOpenOptions

DataChannel close event listener

DataChannel dataChannelReceiverCreated event listener

DataChannel messageReady event listener

reliability option in DataChannelSenderOpenOptions

Sender options for creating a DataChannel sender object

Device availability grade

Browser/OS support grade

Type of device.

Listener arguments for the call 'diagnosticChanged' event

• value is DiagnosticQuality or DiagnosticFlag:
  • DiagnosticQuality = enum { Good = 1, Poor = 2, Bad = 3 }.
  • DiagnosticFlag = true | false.
• valueType = 'DiagnosticQuality' | 'DiagnosticFlag'

Boolean flag value for boolean related diagnostics such as DeviceSpeakWhileMuted, NoNetwork etc...

Diagnostic value type. DiagnosticQuality or DiagnosticFlag

DTMF tone for PSTN calls.

Browser info

Environment Info

Group locator.

Payload for incoming call event.

Generic type of screenshare receive media stats

Latest value for a call diagnostic

Name of event type for lowered hand feature

Callback definition for handling the LowerHandEventType event.

• diagnostic is the type of Media diagnostic, e.g. speakingWhileMicrophoneIsMuted, cameraStartFailed, etc...

Media diagnostic types

Properties of stats in summaryReported event

Properties of aggregation for each stats field.

Options for media stats collector

Payload for media stats emitted sampleReported event.

Payload for media stats emitted summaryReported event.

Media stream type.

• Video - Media stream from a camera device
• ScreenSharing - Media stream from a screen, app, or browser tab
• RawMedia - Raw video media stream or raw screen sharing stream
• LiveStream - Media stream from a live stream
• Audio - Media stream from audio device

Meeting locator.

• diagnostic is the type of Network diagnostic, e.g. networkRcvQuality, noNetwrok, etc... DeviceSpeakWhileMuted, etc...

Type of network diagnostic

Represents noise suppression effect names

Generic type of screenshare send media stats

Represents the end of call survey call issues.

Example

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.

Participant Capabilities

Capability Resolution Reason

Participant role.

Diagnostic results

Payload for property changed event.

Push notification data

Call quality grade

Name of event type for raise hand feature

Callback definition for handling the RaisedHandEventType event.

Reaction types defined for everyone

Callback definition for handling the ReactionEventType event.

Remote users facing diagnostics payload.

Remote participant state.

Error result categories

Room locator.

PreCallDiagnostics options

The scaling mode for the view of a video stream.

Represents the end of call survey screenshare issues.

Example

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.

Server diagnostics

Event type for captions spoken language changed event

Name of event type for Spotlight feature

Callback definition for handling the CaptionsReceivedEventType event

Payload for Teams incoming call event.

Callback definition for handling the togetherMode scene update event.

Mapping of participant's MRI to seating position

Callback definition for handling the togetherMode seating update event.

Transcription property changed event.

Event that a transfer was accepted

Name of event type for transfer accepted

Transfer state

Type of a video device.

Video effect error type.

Video effect error payload.

Represents the name of a video effect.

Union type for all effects

Listener type for the 'effectsError' subscribe function

Types of subscribe events

Listener type for effects feature subscribe functions

Represents the end of call survey video issues.

Example

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.

Represents video stream constraints

Payload for video source changed event.

Represents the constructor for VideoStreamFeature object, along with the context argument.

X-header.

The kind of call agent object.

The kind of call object.

Quality value for Quality related diagnostics such as NetworkSendQuality, NetworkRevQuality, etc... Good = 1, no problem. Poor = 2, mild problem. Bad = 3, severe problem.

The kind of incoming call object.

Local recoring state

Recording state.