CommonCallAdapter interface

Package:: @azure/communication-react

Extends: AdapterState<CallAdapterState>,Disposable,CallAdapterCallOperations,CallAdapterDeviceManagement,CallAdapterSubscribers

Inherited Properties

Send real time text

Methods

joinCall(boolean)	Join the call with microphone initially on/off.
joinCall(JoinCallOptions)	Join the call with options bag to set microphone/camera initial state when joining call true = turn on the device when joining call false = turn off the device when joining call 'keep'/undefined = retain devices' precall state
startCall(CommunicationIdentifier[], StartCallOptions)	Start the call.
startCall(string[], StartCallOptions)	Start the call.

Inherited Methods

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Add a participant to the call.
askDevicePermission(PermissionConstraints)	Ask for permissions of devices.
createStreamView(string, VideoStreamOptions)	Create the html view for a stream.
createTogetherModeStreamView(TogetherModeStreamOptions)	Create the html view for a stream.
dispose()	Dispose of the Composite
disposeLocalVideoStreamView()	Dispose the html view for a local video stream
disposeRemoteVideoStreamView(string)	Dispose the html view for a remote video stream
disposeScreenShareStreamView(string)	Dispose the html view for a screen share stream
disposeStreamView(string, VideoStreamOptions)	Dispose the html view for a stream.
disposeTogetherModeStreamView()	Dispose the html view for a stream.
forbidAudio(string[])	Forbid Teams meeting attendees audio by their user ids.
forbidOthersAudio()	Forbid Teams meeting audio.
forbidOthersVideo()	Forbid Teams meeting video.
forbidVideo(string[])	Forbid Teams meeting attendees video by their user ids.
getState()	Get the current State
holdCall()	Holds the call.
leaveCall(boolean)	Leave the call
lowerHand()	lower hand for current user
mute()	Mute the current user during the call or disable microphone locally
muteAllRemoteParticipants()	Mute All participants
muteParticipant(string)	Mute a participant
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)	Unsubscribe function for 'breakoutRoomsUpdated' event.
off("callEnded", CallEndedListener)	Unsubscribe function for 'callEnded' event.
off("callIdChanged", CallIdChangedListener)	Unsubscribe function for 'callIdChanged' event.
off("capabilitiesChanged", CapabilitiesChangedListener)	Unsubscribe function for 'capabilitiesChanged' event.
off("captionsReceived", CaptionsReceivedListener)	Unsubscribe function for 'captionsReceived' event.
off("diagnosticChanged", DiagnosticChangedEventListner)	Unsubscribe function for 'diagnosticChanged' event.
off("displayNameChanged", DisplayNameChangedListener)	Unsubscribe function for 'displayNameChanged' event.
off("error", (e: AdapterError) => void)	Unsubscribe function for 'error' event.
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)	Unsubscribe function for 'isCaptionLanguageChanged' event.
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)	Unsubscribe function for 'isCaptionsActiveChanged' event.
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Unsubscribe function for 'isLocalScreenSharingActiveChanged' event.
off("isMutedChanged", IsMutedChangedListener)	Unsubscribe function for 'isMutedChanged' event.
off("isSpeakingChanged", IsSpeakingChangedListener)	Unsubscribe function for 'isSpeakingChanged' event.
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)	Unsubscribe function for 'isSpokenLanguageChanged' event.
off("mutedByOthers", PropertyChangedEvent)	Unsubscribe function for 'mutedByOthers' event.
off("participantsJoined", ParticipantsJoinedListener)	Unsubscribe function for 'participantsJoined' event.
off("participantsLeft", ParticipantsLeftListener)	Unsubscribe function for 'participantsLeft' event.
off("realTimeTextReceived", RealTimeTextReceivedListener)	Unsubscribe function for 'realTimeTextReceived' event.
off("roleChanged", PropertyChangedEvent)	Unsubscribe function for 'roleChanged' event.
off("selectedMicrophoneChanged", PropertyChangedEvent)	Unsubscribe function for 'selectedMicrophoneChanged' event.
off("selectedSpeakerChanged", PropertyChangedEvent)	Unsubscribe function for 'selectedSpeakerChanged' event.
off("spotlightChanged", SpotlightChangedListener)	Unsubscribe function for 'spotlightChanged' event.
off("transferAccepted", TransferAcceptedListener)	Unsubscribe function for 'transferRequested' event.
offStateChange((state: CallAdapterState) => void)	Unsubscribes the handler to stateChanged events.
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)	Subscribe function for 'breakoutRoomsUpdated' event.
on("callEnded", CallEndedListener)	Subscribe function for 'callEnded' event.
on("callIdChanged", CallIdChangedListener)	Subscribe function for 'callIdChanged' event.
on("capabilitiesChanged", CapabilitiesChangedListener)	Subscribe function for 'capabilitiesChanged' event.
on("captionsReceived", CaptionsReceivedListener)	Subscribe function for 'captionsReceived' event.
on("diagnosticChanged", DiagnosticChangedEventListner)	Subscribe function for 'diagnosticChanged' event. This event fires whenever there is a change in user facing diagnostics about the ongoing call.
on("displayNameChanged", DisplayNameChangedListener)	Subscribe function for 'displayNameChanged' event.
on("error", (e: AdapterError) => void)	Subscribe function for 'error' event.
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)	Subscribe function for 'isCaptionLanguageChanged' event.
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)	Subscribe function for 'isCaptionsActiveChanged' event.
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Subscribe function for 'isLocalScreenSharingActiveChanged' event.
on("isMutedChanged", IsMutedChangedListener)	Subscribe function for 'isMutedChanged' event.
on("isSpeakingChanged", IsSpeakingChangedListener)	Subscribe function for 'isSpeakingChanged' event.
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)	Subscribe function for 'isSpokenLanguageChanged' event.
on("mutedByOthers", PropertyChangedEvent)	Subscribe function for 'mutedByOthers' event.
on("participantsJoined", ParticipantsJoinedListener)	Subscribe function for 'participantsJoined' event.
on("participantsLeft", ParticipantsLeftListener)	Subscribe function for 'participantsLeft' event.
on("realTimeTextReceived", RealTimeTextReceivedListener)	Subscribe function for 'realTimeTextReceived' event.
on("roleChanged", PropertyChangedEvent)	Subscribe function for 'roleChanged' event.
on("selectedMicrophoneChanged", PropertyChangedEvent)	Subscribe function for 'selectedMicrophoneChanged' event. This event fires whenever the user selects a new microphone device.
on("selectedSpeakerChanged", PropertyChangedEvent)	Subscribe function for 'selectedSpeakerChanged' event. This event fires whenever the user selects a new speaker device.
on("spotlightChanged", SpotlightChangedListener)	Subscribe function for 'spotlightChanged' event.
on("transferAccepted", TransferAcceptedListener)	Subscribe function for 'transferRequested' event.
onReactionClick(Reaction)	Send reaction emoji
onStateChange((state: CallAdapterState) => void)	Subscribes the handler to stateChanged events.
permitAudio(string[])	Permit Teams meeting attendees audio by their user ids.
permitOthersAudio()	Permit Teams meeting audio.
permitOthersVideo()	Permit Teams meeting video.
permitVideo(string[])	Permit Teams meeting attendees audio by their user ids.
queryCameras()	Query for available camera devices.
queryMicrophones()	Query for available microphone devices.
querySpeakers()	Query for available speaker devices.
raiseHand()	Raise hand for current user
removeParticipant(CommunicationIdentifier)	Remove a participant from the call.
removeParticipant(string)	Remove a participant from the call.
resumeCall()	Resumes the call from a `LocalHold` state.
returnFromBreakoutRoom()	Return to origin call of breakout room
sendDtmfTone(DtmfTone)	send dtmf tone to another participant in a 1:1 PSTN call
setCamera(VideoDeviceInfo, VideoStreamOptions)	Set the camera to use in the call.
setCaptionLanguage(string)	Function to set caption language
setMicrophone(AudioDeviceInfo)	Set the microphone to use in the call.
setSpeaker(AudioDeviceInfo)	Set the speaker to use in the call.
setSpokenLanguage(string)	Function to set spoken language
setTogetherModeSceneSize(number, number)	Recalculate the seating positions for together mode.
startCamera(VideoStreamOptions)	Start the camera This method will start rendering a local camera view when the call is not active
startCaptions(StartCaptionsAdapterOptions)	Function to Start captions
startNoiseSuppressionEffect()	Start the noise suppression effect.
startScreenShare()	Start sharing the screen during a call.
startSpotlight(string[])	Start spotlight for local and remote participants by their user ids. If no array of user ids is passed then action is performed on local participant.
startTogetherMode()	Start Together mode.
startVideoBackgroundEffect(VideoBackgroundEffect)	Start the video background effect.
stopAllSpotlight()	Stop all spotlights
stopCamera()	Stop the camera This method will stop rendering a local camera view when the call is not active
stopCaptions(StopCaptionsAdapterOptions)	Funtion to stop captions
stopNoiseSuppressionEffect()	Stop the noise suppression effect.
stopScreenShare()	Stop sharing the screen
stopSpotlight(string[])	Stop spotlight for local and remote participants by their user ids. If no array of user ids is passed then action is performed on local participant.
stopVideoBackgroundEffects()	Stop the video background effect.
submitSurvey(CallSurvey)	Send the end of call survey result
unmute()	Unmute the current user during the call or enable microphone locally
updateBackgroundPickerImages(VideoBackgroundImage[])	Override the background picker images for background replacement effect.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Update the selected video background effect.

Inherited Property Details

sendRealTimeText

Send real time text

sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

Property Value

(text: string, isFinalized: boolean) => Promise<void>

Inherited From CallAdapterCallOperations.sendRealTimeText

Method Details

joinCall(boolean)

Warning

This API is now deprecated.

Use joinCall(options?:JoinCallOptions) instead.

Join the call with microphone initially on/off.

function joinCall(microphoneOn?: boolean)

Parameters

microphoneOn: boolean

Whether microphone is initially enabled

joinCall(JoinCallOptions)

Join the call with options bag to set microphone/camera initial state when joining call true = turn on the device when joining call false = turn off the device when joining call 'keep'/undefined = retain devices' precall state

function joinCall(options?: JoinCallOptions)

Parameters

options: JoinCallOptions

param to set microphone/camera initially on/off/use precall state.

startCall(CommunicationIdentifier[], StartCallOptions)

Start the call.

function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions)

Parameters

participants: CommunicationIdentifier[]

An array of <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> to be called

options: StartCallOptions

startCall(string[], StartCallOptions)

Start the call.

function startCall(participants: string[], options?: StartCallOptions)

Parameters

participants: string[]

An array of participant ids to join

options: StartCallOptions

Inherited Method Details

addParticipant(CommunicationUserIdentifier)

function addParticipant(participant: CommunicationUserIdentifier): Promise<void>

Parameters

participant: CommunicationUserIdentifier

Returns

Promise<void>

Inherited From CallAdapterCallOperations.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Add a participant to the call.

function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>

Parameters

participant: PhoneNumberIdentifier

options: AddPhoneNumberOptions

Returns

Promise<void>

Inherited From CallAdapterCallOperations.addParticipant

askDevicePermission(PermissionConstraints)

Ask for permissions of devices.

function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>

Parameters

constrain: PermissionConstraints

Define constraints for accessing local devices <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Returns

Promise<DeviceAccess>

Remarks

Browser permission window will pop up if permissions are not granted yet

Inherited From CallAdapterDeviceManagement.askDevicePermission

createStreamView(string, VideoStreamOptions)

Create the html view for a stream.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parameters

remoteUserId: string

Id of the participant to render, leave it undefined to create the local camera view

options: VideoStreamOptions

Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returns

Promise<void | CreateVideoStreamViewResult>

Remarks

This method is implemented for composite

Inherited From CallAdapterCallOperations.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Create the html view for a stream.

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

Parameters

options: TogetherModeStreamOptions

Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returns

Promise<void | TogetherModeStreamViewResult>

Remarks

This method is implemented for composite

Inherited From CallAdapterCallOperations.createTogetherModeStreamView

dispose()

Dispose of the Composite

function dispose()

Inherited From Disposable_2.dispose

disposeLocalVideoStreamView()

Dispose the html view for a local video stream

function disposeLocalVideoStreamView(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

Dispose the html view for a remote video stream

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

Parameters

remoteUserId: string

Id of the participant to dispose

Returns

Promise<void>

Inherited From CallAdapterCallOperations.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Dispose the html view for a screen share stream

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

Parameters

remoteUserId: string

Id of the participant to dispose the screen share stream view for.

Returns

Promise<void>

Remarks

this method is implemented for composite

Inherited From CallAdapterCallOperations.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Warning

This API is now deprecated.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

Dispose the html view for a stream.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parameters

remoteUserId: string

Id of the participant to render, leave it undefined to dispose the local camera view

options: VideoStreamOptions

Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returns

Promise<void>

Remarks

This method is implemented for composite

Inherited From CallAdapterCallOperations.disposeStreamView

disposeTogetherModeStreamView()

Dispose the html view for a stream.

function disposeTogetherModeStreamView(): Promise<void>

Returns

Promise<void>

Remarks

This method is implemented for composite

Inherited From CallAdapterCallOperations.disposeTogetherModeStreamView

forbidAudio(string[])

Forbid Teams meeting attendees audio by their user ids.

function forbidAudio(userIds: string[]): Promise<void>

Parameters

userIds: string[]

Returns

Promise<void>

Inherited From CallAdapterCallOperations.forbidAudio

forbidOthersAudio()

Forbid Teams meeting audio.

function forbidOthersAudio(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.forbidOthersAudio

forbidOthersVideo()

Forbid Teams meeting video.

function forbidOthersVideo(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.forbidOthersVideo

forbidVideo(string[])

Forbid Teams meeting attendees video by their user ids.

function forbidVideo(userIds: string[]): Promise<void>

Parameters

userIds: string[]

Returns

Promise<void>

Inherited From CallAdapterCallOperations.forbidVideo

getState()

Get the current State

function getState(): CallAdapterState

Returns

CallAdapterState

Inherited From AdapterState.getState

holdCall()

Holds the call.

function holdCall(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.holdCall

leaveCall(boolean)

Leave the call

function leaveCall(forEveryone?: boolean): Promise<void>

Parameters

forEveryone: boolean

Whether to remove all participants when leaving

Returns

Promise<void>

Inherited From CallAdapterCallOperations.leaveCall

lowerHand()

lower hand for current user

function lowerHand(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.lowerHand

mute()

Mute the current user during the call or disable microphone locally

function mute(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.mute

muteAllRemoteParticipants()

Mute All participants

function muteAllRemoteParticipants(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.muteAllRemoteParticipants

muteParticipant(string)

Mute a participant

function muteParticipant(userId: string): Promise<void>

Parameters

userId: string

Id of the participant to mute

Returns

Promise<void>

Inherited From CallAdapterCallOperations.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Unsubscribe function for 'breakoutRoomsUpdated' event.

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parameters

event: "breakoutRoomsUpdated"

listener: BreakoutRoomsUpdatedListener

Inherited From CallAdapterSubscribers.off

off("callEnded", CallEndedListener)

Unsubscribe function for 'callEnded' event.

function off(event: "callEnded", listener: CallEndedListener)

Parameters

event: "callEnded"

listener: CallEndedListener

Inherited From CallAdapterSubscribers.off

off("callIdChanged", CallIdChangedListener)

Unsubscribe function for 'callIdChanged' event.

function off(event: "callIdChanged", listener: CallIdChangedListener)

Parameters

event: "callIdChanged"

listener: CallIdChangedListener

Inherited From CallAdapterSubscribers.off

off("capabilitiesChanged", CapabilitiesChangedListener)

Unsubscribe function for 'capabilitiesChanged' event.

function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parameters

event: "capabilitiesChanged"

listener: CapabilitiesChangedListener

Inherited From CallAdapterSubscribers.off

off("captionsReceived", CaptionsReceivedListener)

Unsubscribe function for 'captionsReceived' event.

function off(event: "captionsReceived", listener: CaptionsReceivedListener)

Parameters

event: "captionsReceived"

listener: CaptionsReceivedListener

Inherited From CallAdapterSubscribers.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Unsubscribe function for 'diagnosticChanged' event.

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parameters

event: "diagnosticChanged"

listener: DiagnosticChangedEventListner

Inherited From CallAdapterSubscribers.off

off("displayNameChanged", DisplayNameChangedListener)

Unsubscribe function for 'displayNameChanged' event.

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parameters

event: "displayNameChanged"

listener: DisplayNameChangedListener

Inherited From CallAdapterSubscribers.off

off("error", (e: AdapterError) => void)

Unsubscribe function for 'error' event.

function off(event: "error", listener: (e: AdapterError) => void)

Parameters

event: "error"

listener: (e: AdapterError) => void

Inherited From CallAdapterSubscribers.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Unsubscribe function for 'isCaptionLanguageChanged' event.

function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parameters

event: "isCaptionLanguageChanged"

listener: IsCaptionLanguageChangedListener

Inherited From CallAdapterSubscribers.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Unsubscribe function for 'isCaptionsActiveChanged' event.

function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parameters

event: "isCaptionsActiveChanged"

listener: IsCaptionsActiveChangedListener

Inherited From CallAdapterSubscribers.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Unsubscribe function for 'isLocalScreenSharingActiveChanged' event.

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parameters

event: "isLocalScreenSharingActiveChanged"

listener: IsLocalScreenSharingActiveChangedListener

Inherited From CallAdapterSubscribers.off

off("isMutedChanged", IsMutedChangedListener)

Unsubscribe function for 'isMutedChanged' event.

function off(event: "isMutedChanged", listener: IsMutedChangedListener)

Parameters

event: "isMutedChanged"

listener: IsMutedChangedListener

Inherited From CallAdapterSubscribers.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Unsubscribe function for 'isSpeakingChanged' event.

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parameters

event: "isSpeakingChanged"

listener: IsSpeakingChangedListener

Inherited From CallAdapterSubscribers.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Unsubscribe function for 'isSpokenLanguageChanged' event.

function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parameters

event: "isSpokenLanguageChanged"

listener: IsSpokenLanguageChangedListener

Inherited From CallAdapterSubscribers.off

off("mutedByOthers", PropertyChangedEvent)

Unsubscribe function for 'mutedByOthers' event.

function off(event: "mutedByOthers", listener: PropertyChangedEvent)

Parameters

event: "mutedByOthers"

listener: PropertyChangedEvent

Inherited From CallAdapterSubscribers.off

off("participantsJoined", ParticipantsJoinedListener)

Unsubscribe function for 'participantsJoined' event.

function off(event: "participantsJoined", listener: ParticipantsJoinedListener)

Parameters

event: "participantsJoined"

listener: ParticipantsJoinedListener

Inherited From CallAdapterSubscribers.off

off("participantsLeft", ParticipantsLeftListener)

Unsubscribe function for 'participantsLeft' event.

function off(event: "participantsLeft", listener: ParticipantsLeftListener)

Parameters

event: "participantsLeft"

listener: ParticipantsLeftListener

Inherited From CallAdapterSubscribers.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

Unsubscribe function for 'realTimeTextReceived' event.

function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parameters

event: "realTimeTextReceived"

listener: RealTimeTextReceivedListener

Inherited From CallAdapterSubscribers.off

off("roleChanged", PropertyChangedEvent)

Unsubscribe function for 'roleChanged' event.

function off(event: "roleChanged", listener: PropertyChangedEvent)

Parameters

event: "roleChanged"

listener: PropertyChangedEvent

Inherited From CallAdapterSubscribers.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Unsubscribe function for 'selectedMicrophoneChanged' event.

function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Parameters

event: "selectedMicrophoneChanged"

listener: PropertyChangedEvent

Inherited From CallAdapterSubscribers.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Unsubscribe function for 'selectedSpeakerChanged' event.

function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Parameters

event: "selectedSpeakerChanged"

listener: PropertyChangedEvent

Inherited From CallAdapterSubscribers.off

off("spotlightChanged", SpotlightChangedListener)

Unsubscribe function for 'spotlightChanged' event.

function off(event: "spotlightChanged", listener: SpotlightChangedListener)

Parameters

event: "spotlightChanged"

listener: SpotlightChangedListener

Inherited From CallAdapterSubscribers.off

off("transferAccepted", TransferAcceptedListener)

Unsubscribe function for 'transferRequested' event.

function off(event: "transferAccepted", listener: TransferAcceptedListener)

Parameters

event: "transferAccepted"

listener: TransferAcceptedListener

Inherited From CallAdapterSubscribers.off

offStateChange((state: CallAdapterState) => void)

Unsubscribes the handler to stateChanged events.

function offStateChange(handler: (state: CallAdapterState) => void)

Parameters

handler: (state: CallAdapterState) => void

Inherited From AdapterState.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Subscribe function for 'breakoutRoomsUpdated' event.

function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parameters

event: "breakoutRoomsUpdated"

listener: BreakoutRoomsUpdatedListener

Inherited From CallAdapterSubscribers.on

on("callEnded", CallEndedListener)

Subscribe function for 'callEnded' event.

function on(event: "callEnded", listener: CallEndedListener)

Parameters

event: "callEnded"

listener: CallEndedListener

Inherited From CallAdapterSubscribers.on

on("callIdChanged", CallIdChangedListener)

Subscribe function for 'callIdChanged' event.

function on(event: "callIdChanged", listener: CallIdChangedListener)

Parameters

event: "callIdChanged"

listener: CallIdChangedListener

Remarks

The event will be triggered when callId of current user changed.

Inherited From CallAdapterSubscribers.on

on("capabilitiesChanged", CapabilitiesChangedListener)

Subscribe function for 'capabilitiesChanged' event.

function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parameters

event: "capabilitiesChanged"

listener: CapabilitiesChangedListener

Inherited From CallAdapterSubscribers.on

on("captionsReceived", CaptionsReceivedListener)

Subscribe function for 'captionsReceived' event.

function on(event: "captionsReceived", listener: CaptionsReceivedListener)

Parameters

event: "captionsReceived"

listener: CaptionsReceivedListener

Inherited From CallAdapterSubscribers.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Subscribe function for 'diagnosticChanged' event.

This event fires whenever there is a change in user facing diagnostics about the ongoing call.

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parameters

event: "diagnosticChanged"

listener: DiagnosticChangedEventListner

Inherited From CallAdapterSubscribers.on

on("displayNameChanged", DisplayNameChangedListener)

Subscribe function for 'displayNameChanged' event.

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parameters

event: "displayNameChanged"

listener: DisplayNameChangedListener

Inherited From CallAdapterSubscribers.on

on("error", (e: AdapterError) => void)

Subscribe function for 'error' event.

function on(event: "error", listener: (e: AdapterError) => void)

Parameters

event: "error"

listener: (e: AdapterError) => void

Inherited From CallAdapterSubscribers.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Subscribe function for 'isCaptionLanguageChanged' event.

function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parameters

event: "isCaptionLanguageChanged"

listener: IsCaptionLanguageChangedListener

Inherited From CallAdapterSubscribers.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Subscribe function for 'isCaptionsActiveChanged' event.

function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parameters

event: "isCaptionsActiveChanged"

listener: IsCaptionsActiveChangedListener

Inherited From CallAdapterSubscribers.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Subscribe function for 'isLocalScreenSharingActiveChanged' event.

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parameters

event: "isLocalScreenSharingActiveChanged"

listener: IsLocalScreenSharingActiveChangedListener

Inherited From CallAdapterSubscribers.on

on("isMutedChanged", IsMutedChangedListener)

Subscribe function for 'isMutedChanged' event.

function on(event: "isMutedChanged", listener: IsMutedChangedListener)

Parameters

event: "isMutedChanged"

listener: IsMutedChangedListener

Remarks

The event will be triggered whenever current user or remote user mute state changed

Inherited From CallAdapterSubscribers.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Subscribe function for 'isSpeakingChanged' event.

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parameters

event: "isSpeakingChanged"

listener: IsSpeakingChangedListener

Inherited From CallAdapterSubscribers.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Subscribe function for 'isSpokenLanguageChanged' event.

function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parameters

event: "isSpokenLanguageChanged"

listener: IsSpokenLanguageChangedListener

Inherited From CallAdapterSubscribers.on

on("mutedByOthers", PropertyChangedEvent)

Subscribe function for 'mutedByOthers' event.

function on(event: "mutedByOthers", listener: PropertyChangedEvent)

Parameters

event: "mutedByOthers"

listener: PropertyChangedEvent

Inherited From CallAdapterSubscribers.on

on("participantsJoined", ParticipantsJoinedListener)

Subscribe function for 'participantsJoined' event.

function on(event: "participantsJoined", listener: ParticipantsJoinedListener)

Parameters

event: "participantsJoined"

listener: ParticipantsJoinedListener

Inherited From CallAdapterSubscribers.on

on("participantsLeft", ParticipantsLeftListener)

Subscribe function for 'participantsLeft' event.

function on(event: "participantsLeft", listener: ParticipantsLeftListener)

Parameters

event: "participantsLeft"

listener: ParticipantsLeftListener

Inherited From CallAdapterSubscribers.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

Subscribe function for 'realTimeTextReceived' event.

function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parameters

event: "realTimeTextReceived"

listener: RealTimeTextReceivedListener

Inherited From CallAdapterSubscribers.on

on("roleChanged", PropertyChangedEvent)

Subscribe function for 'roleChanged' event.

function on(event: "roleChanged", listener: PropertyChangedEvent)

Parameters

event: "roleChanged"

listener: PropertyChangedEvent

Inherited From CallAdapterSubscribers.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Subscribe function for 'selectedMicrophoneChanged' event.

This event fires whenever the user selects a new microphone device.

function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Parameters

event: "selectedMicrophoneChanged"

listener: PropertyChangedEvent

Inherited From CallAdapterSubscribers.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Subscribe function for 'selectedSpeakerChanged' event.

This event fires whenever the user selects a new speaker device.

function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Parameters

event: "selectedSpeakerChanged"

listener: PropertyChangedEvent

Inherited From CallAdapterSubscribers.on

on("spotlightChanged", SpotlightChangedListener)

Subscribe function for 'spotlightChanged' event.

function on(event: "spotlightChanged", listener: SpotlightChangedListener)

Parameters

event: "spotlightChanged"

listener: SpotlightChangedListener

Inherited From CallAdapterSubscribers.on

on("transferAccepted", TransferAcceptedListener)

Subscribe function for 'transferRequested' event.

function on(event: "transferAccepted", listener: TransferAcceptedListener)

Parameters

event: "transferAccepted"

listener: TransferAcceptedListener

Inherited From CallAdapterSubscribers.on

onReactionClick(Reaction)

Send reaction emoji

function onReactionClick(reaction: Reaction): Promise<void>

Parameters

reaction: Reaction

Returns

Promise<void>

Inherited From CallAdapterCallOperations.onReactionClick

onStateChange((state: CallAdapterState) => void)

Subscribes the handler to stateChanged events.

function onStateChange(handler: (state: CallAdapterState) => void)

Parameters

handler: (state: CallAdapterState) => void

Inherited From AdapterState.onStateChange

permitAudio(string[])

Permit Teams meeting attendees audio by their user ids.

function permitAudio(userIds: string[]): Promise<void>

Parameters

userIds: string[]

Returns

Promise<void>

Inherited From CallAdapterCallOperations.permitAudio

permitOthersAudio()

Permit Teams meeting audio.

function permitOthersAudio(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.permitOthersAudio

permitOthersVideo()

Permit Teams meeting video.

function permitOthersVideo(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.permitOthersVideo

permitVideo(string[])

Permit Teams meeting attendees audio by their user ids.

function permitVideo(userIds: string[]): Promise<void>

Parameters

userIds: string[]

Returns

Promise<void>

Inherited From CallAdapterCallOperations.permitVideo

queryCameras()

Query for available camera devices.

function queryCameras(): Promise<VideoDeviceInfo[]>

Returns

Promise<VideoDeviceInfo[]>

An array of video device information entities <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Remarks

This method should be called after askDevicePermission()

Inherited From CallAdapterDeviceManagement.queryCameras

queryMicrophones()

Query for available microphone devices.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Returns

Promise<AudioDeviceInfo[]>

An array of audio device information entities <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Remarks

This method should be called after askDevicePermission()

Inherited From CallAdapterDeviceManagement.queryMicrophones

querySpeakers()

Query for available speaker devices.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Returns

Promise<AudioDeviceInfo[]>

An array of audio device information entities <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Remarks

This method should be called after askDevicePermission()

Inherited From CallAdapterDeviceManagement.querySpeakers

raiseHand()

Raise hand for current user

function raiseHand(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.raiseHand

removeParticipant(CommunicationIdentifier)

Remove a participant from the call.

function removeParticipant(participant: CommunicationIdentifier): Promise<void>

Parameters

participant: CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> of the participant to be removed

Returns

Promise<void>

Inherited From CallAdapterCallOperations.removeParticipant

removeParticipant(string)

Remove a participant from the call.

function removeParticipant(userId: string): Promise<void>

Parameters

userId: string

Id of the participant to be removed

Returns

Promise<void>

Inherited From CallAdapterCallOperations.removeParticipant

resumeCall()

Resumes the call from a LocalHold state.

function resumeCall(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.resumeCall

returnFromBreakoutRoom()

Return to origin call of breakout room

function returnFromBreakoutRoom(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

send dtmf tone to another participant in a 1:1 PSTN call

function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>

Parameters

dtmfTone: DtmfTone

Returns

Promise<void>

Inherited From CallAdapterCallOperations.sendDtmfTone

setCamera(VideoDeviceInfo, VideoStreamOptions)

Set the camera to use in the call.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Parameters

sourceInfo: VideoDeviceInfo

Camera device to choose, pick one returned by queryCameras

options: VideoStreamOptions

Options to control how the camera stream is rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returns

Promise<void>

Inherited From CallAdapterDeviceManagement.setCamera

setCaptionLanguage(string)

Function to set caption language

function setCaptionLanguage(language: string): Promise<void>

Parameters

language: string

language set for caption

Returns

Promise<void>

Inherited From CallAdapterCallOperations.setCaptionLanguage

setMicrophone(AudioDeviceInfo)

Set the microphone to use in the call.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parameters

sourceInfo: AudioDeviceInfo

Microphone device to choose, pick one returned by queryMicrophones

Returns

Promise<void>

Inherited From CallAdapterDeviceManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

Set the speaker to use in the call.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parameters

sourceInfo: AudioDeviceInfo

Speaker device to choose, pick one returned by querySpeakers

Returns

Promise<void>

Inherited From CallAdapterDeviceManagement.setSpeaker

setSpokenLanguage(string)

Function to set spoken language

function setSpokenLanguage(language: string): Promise<void>

Parameters

language: string

spoken language

Returns

Promise<void>

Inherited From CallAdapterCallOperations.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Recalculate the seating positions for together mode.

function setTogetherModeSceneSize(width: number, height: number)

Parameters

width: number

Width of the container

height: number

Height of the container

Remarks

This method is implemented for composite

Inherited From CallAdapterCallOperations.setTogetherModeSceneSize

startCamera(VideoStreamOptions)

Start the camera This method will start rendering a local camera view when the call is not active

function startCamera(options?: VideoStreamOptions): Promise<void>

Parameters

options: VideoStreamOptions

Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.startCamera

startCaptions(StartCaptionsAdapterOptions)

Function to Start captions

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

Parameters

options: StartCaptionsAdapterOptions

options for start captions

Returns

Promise<void>

Inherited From CallAdapterCallOperations.startCaptions

startNoiseSuppressionEffect()

Start the noise suppression effect.

function startNoiseSuppressionEffect(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.startNoiseSuppressionEffect

startScreenShare()

Start sharing the screen during a call.

function startScreenShare(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.startScreenShare

startSpotlight(string[])

Start spotlight for local and remote participants by their user ids. If no array of user ids is passed then action is performed on local participant.

function startSpotlight(userIds?: string[]): Promise<void>

Parameters

userIds: string[]

Returns

Promise<void>

Inherited From CallAdapterCallOperations.startSpotlight

startTogetherMode()

Start Together mode.

function startTogetherMode(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Start the video background effect.

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

Parameters

videoBackgroundEffect: VideoBackgroundEffect

Returns

Promise<void>

Inherited From CallAdapterCallOperations.startVideoBackgroundEffect

stopAllSpotlight()

Stop all spotlights

function stopAllSpotlight(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.stopAllSpotlight

stopCamera()

Stop the camera This method will stop rendering a local camera view when the call is not active

function stopCamera(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funtion to stop captions

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

Parameters

options: StopCaptionsAdapterOptions

Returns

Promise<void>

Inherited From CallAdapterCallOperations.stopCaptions

stopNoiseSuppressionEffect()

Stop the noise suppression effect.

function stopNoiseSuppressionEffect(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.stopNoiseSuppressionEffect

stopScreenShare()

Stop sharing the screen

function stopScreenShare(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.stopScreenShare

stopSpotlight(string[])

Stop spotlight for local and remote participants by their user ids. If no array of user ids is passed then action is performed on local participant.

function stopSpotlight(userIds?: string[]): Promise<void>

Parameters

userIds: string[]

Returns

Promise<void>

Inherited From CallAdapterCallOperations.stopSpotlight

stopVideoBackgroundEffects()

Stop the video background effect.

function stopVideoBackgroundEffects(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Send the end of call survey result

function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

Parameters

survey: CallSurvey

Returns

Promise<undefined | CallSurveyResponse>

Inherited From CallAdapterCallOperations.submitSurvey

unmute()

Unmute the current user during the call or enable microphone locally

function unmute(): Promise<void>

Returns

Promise<void>

Inherited From CallAdapterCallOperations.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Override the background picker images for background replacement effect.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parameters

backgroundImages: VideoBackgroundImage[]

Array of custom background images.

Inherited From CallAdapterCallOperations.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Update the selected video background effect.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parameters

selectedVideoBackground: VideoBackgroundEffect

Inherited From CallAdapterCallOperations.updateSelectedVideoBackgroundEffect

Share via

CommonCallAdapter interface

Inherited Properties

Methods

Inherited Methods

Inherited Property Details

sendRealTimeText

Property Value

Method Details

joinCall(boolean)

Parameters

joinCall(JoinCallOptions)

Parameters

startCall(CommunicationIdentifier[], StartCallOptions)

Parameters

startCall(string[], StartCallOptions)

Parameters

Inherited Method Details

addParticipant(CommunicationUserIdentifier)

Parameters

Returns

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Parameters

Returns

askDevicePermission(PermissionConstraints)

Parameters

Returns

Remarks

createStreamView(string, VideoStreamOptions)

Parameters

Returns

Remarks

createTogetherModeStreamView(TogetherModeStreamOptions)

Parameters

Returns

Remarks

dispose()

disposeLocalVideoStreamView()

Returns

disposeRemoteVideoStreamView(string)

Parameters

Returns

disposeScreenShareStreamView(string)

Parameters

Returns

Remarks

disposeStreamView(string, VideoStreamOptions)

Parameters

Returns

Remarks

disposeTogetherModeStreamView()

Returns

Remarks

forbidAudio(string[])

Parameters

Returns

forbidOthersAudio()

Returns

forbidOthersVideo()

Returns

forbidVideo(string[])

Parameters

Returns

getState()

Returns

holdCall()

Returns

leaveCall(boolean)

Parameters

Returns

lowerHand()

Returns

mute()

Returns

muteAllRemoteParticipants()

Returns

muteParticipant(string)

Parameters

Returns

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)