@azure/communication-calling package

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Classes

CallClient	The CallClient is the main entry point to the SDK. The CallClient is used to create the CallAgent and to get the DeviceManager.
LocalVideoStream	Represents a local video stream for a local camera device
VideoStreamRenderer	The renderer for a video stream

Interfaces

AcceptCallOptions	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.
AcceptTransferOptions	Accept transfer options
AddCommunicationUserOptions	Options for adding a AddCommunicationUserOptions participant to an on-going call.
AddMicrosoftTeamsUserOptions	Options for adding a MicrosoftTeamsUser participant to an on-going call.
AddPhoneNumberOptions	Options for adding a PSTN participant to an on-going call.
AudioDeviceInfo	Information about a microphone or speaker device.
AudioOptions	Audio options provided when making an outgoing call or joining a group call.
BaseFeature	Represents the base interface for any Feature
Call	Represents a Call.
CallAgent	The CallAgent is used to handle calls.
CallAgentFeature	Represents a CallAgent Feature.
CallAgentFeatureContext	Represents the context provided for extended call agent features at the constructor.
CallAgentFeatureFactory	Represents the factory of call agent features
CallAgentOptions	Options for creating CallAgent.
CallClientFeature	Represents a CallClient Feature.
CallClientFeatureContext	Represents the context provided for extended call client features at the constructor.
CallClientFeatureFactory	Represents the factory of call client agent features
CallClientOptions	Call client options
CallEndReason	Describes the reason why the call ended.
CallFeature	Represents a Call Feature.
CallFeatureContext	Represents the context provided for extended call features at the constructor.
CallFeatureFactory	Represents the factory of call features
CallInfo	Information about a Call.
CallerInfo	Caller Information.
CaptionsCallFeature	Feature for call captions
CaptionsInfo
CommunicationServicesError	Error that get's throw when API call fails.
CompositeAudioDeviceInfo	Information about a composite audio device.
CreateViewOptions	Options for the renderer of a video stream.
DebugInfoCallClientFeature	Feature for call debug info.
DebugInfoDump	dump id is a uniqueIdentifier for each debug info dump
DeviceAccess	Permissions granted by the user.
DeviceManager	The Device Manager is used to handle system media devices such as cameras, microphones, and speakers.
DiagnosticOptions	Diagnostic options
Disposable	Dispose of an object.
DominantSpeakersCallFeature	Feature for call dominant speaker.
DominantSpeakersInfo	Information about the dominant speakers of a call
EmergencyCallOptions
FeatureFactory	Represents the interface for factoring a feature
GroupCallLocator	Locator used for joining a group call.
GroupChatCallLocator	Locator used to joining group chat call.
HangUpOptions	Options for hanging up a call.
IncomingCall	Represents an incoming call.
JoinCallOptions	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.
LatestMediaDiagnostics	Latest media diagnostics that were raised.
LatestNetworkDiagnostics	Latest network diagnostics that were raised.
MediaDiagnostics	Media Diagnostics
MediaStatsCallFeature	Feature for getting media stats while in call.
MediaStatsCollector	Media stats collector.
NetworkDiagnostics	Network Diagnostics
ParticipantInfo	Represents a participant in a call.
PermissionConstraints	Define constraints for accessing local devices.
RecordingCallFeature	Feature for call recording.
RecordingInfo	Call Recording Information.
RemoteParticipant	Represents a remote participant in a call.
RemoteVideoStream	Represents a remote participant's video or screen-sharing stream.
RoomCallLocator	Locator used for joining a room call.
StartCallOptions	Options for starting an outgoing call.
StartCaptionsOptions
StreamSize	Stream size.
TeamsMeetingCoordinatesLocator	Locator used for joining a meeting with meeting coordinates.
TeamsMeetingIdLocator	Locator used for joining a meeting with meeting id and code.
TeamsMeetingLinkLocator	Locator used for joining a meeting with meeting link.
TranscriptionCallFeature	Feature for call transcription.
Transfer	Represents a Transfer Object
TransferCallFeature	Feature for call transfer.
TransferErrorCode	Transfer error code
TransferToCallLocator	Transfer call into another call
TransferToCallOptions	Options for transfering a call to a call
TransferToParticipantLocator	Transfer call to participant
TransferToParticipantOptions	Options for transfering a call to a participant
UserFacingDiagnosticsFeature	Feature for call diagnostics.
VideoDeviceInfo	Information about a camera device.
VideoOptions	Represents a local video stream and takes a camera in constructor.
VideoStreamRendererView	The view for a video stream.

Type Aliases

AudioDeviceType	Type of an audio device.
CallAgentFeatureCtor	Represents the constructor for CallAgentFeature objects, along with the context argument.
CallClientFeatureCtor	Represents the constructor for CallClientFeature objects, along with the context argument.
CallDirection	Direction of a call: 'Incoming' 'Outgoing'
CallEndedEvent	Payload for call ended event.
CallFeatureCtor	Represents the constructor for CallFeature objects, along with the context argument.
CallState	Call states.
CaptionsHandler
CaptionsPropertyChangedEventType
CaptionsReceivedEventType
CollectionUpdatedEvent	Payload for collection updated event.
CompositeAudioDeviceType	Type of a compositve audio device.
DeviceType	Type of device.
DiagnosticChangedEventArgs	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'
DiagnosticFlag	Boolean flag value for boolean related diagnostics such as DeviceSpeakWhileMuted, NoNetwork etc...
DiagnosticValueType	Diagnostic value type. DiagnosticQuality or DiagnosticFlag
DtmfTone	DTMF tone for PSTN calls.
Environment	Supported Environment
EnvironmentInfo	Supported Environment informations
GroupLocator	Group locator.
IncomingCallEvent	Payload for incoming call event.
LatestDiagnosticValue	Latest value for a call diagnostic
MediaDiagnosticChangedEventArgs	diagnostic is the type of Media diagnostic, e.g. speakingWhileMicrophoneIsMuted, cameraStartFailed, etc...
MediaDiagnosticType	Media diagnostic types
MediaStatValue	Properties of each stat.
MediaStats	Media stats.
MediaStatsAggregation	Properties of aggregation for each stat.
MediaStatsCollectorOptions	options for media stats collector
MediaStatsEmittedEvent	Payload for media stats emitted event.
MediaStatsList	Media stats list.
MediaStreamType	Media stream type.
MeetingLocator	Meeting locator.
NetworkDiagnosticChangedEventArgs	diagnostic is the type of Network diagnostic, e.g. networkRcvQuality, noNetwrok, etc... DeviceSpeakWhileMuted, etc...
NetworkDiagnosticType	Type of network diagnostic
PropertyChangedEvent	Payload for property changed event.
RemoteParticipantState	Remote participant state.
RoomLocator	Room locator.
ScalingMode	The scaling mode for the view of a video stream.
TranscriptionPropertyChangedEventType	Transcription property changed event.
TransferRequestedEvent	Event that a transfer has requested
TransferRequestedEventArgs	Event arguments for transfer requested event
TransferState	Transfer state
VideoDeviceType	Type of a video device.

Enums

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