CallAdapter interface

Send real time text

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

Property Value

Inherited From CommonCallAdapter.sendRealTimeText

Join the call with microphone initially on/off.

function joinCall(microphoneOn?: boolean): undefined | Call

Parameters

Returns

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): undefined | Call

Parameters

Returns

Start the call.

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

Parameters

Returns

Start the call.

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

Parameters

Returns

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

Parameters

Returns

Inherited From CommonCallAdapter.addParticipant

Add a participant to the call.

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

Parameters

Returns

Inherited From CommonCallAdapter.addParticipant

Ask for permissions of devices.

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

Parameters

Returns

Remarks

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

Inherited From CommonCallAdapter.askDevicePermission

Create the html view for a stream.

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

Parameters

Returns

Remarks

This method is implemented for composite

Inherited From CommonCallAdapter.createStreamView

Create the html view for a stream.

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

Parameters

Returns

Remarks

This method is implemented for composite

Inherited From CommonCallAdapter.createTogetherModeStreamView

Dispose of the Composite

function dispose()

Inherited From CommonCallAdapter.dispose

Dispose the html view for a local video stream

function disposeLocalVideoStreamView(): Promise<void>

Returns

Inherited From CommonCallAdapter.disposeLocalVideoStreamView

Dispose the html view for a remote video stream

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

Parameters

Returns

Inherited From CommonCallAdapter.disposeRemoteVideoStreamView

Dispose the html view for a screen share stream

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

Parameters

Returns

Remarks

this method is implemented for composite

Inherited From CommonCallAdapter.disposeScreenShareStreamView

Dispose the html view for a stream.

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

Parameters

Returns

Remarks

This method is implemented for composite

Inherited From CommonCallAdapter.disposeStreamView

Dispose the html view for a stream.

function disposeTogetherModeStreamView(): Promise<void>

Returns

Remarks

This method is implemented for composite

Inherited From CommonCallAdapter.disposeTogetherModeStreamView

Forbid Teams meeting attendees audio by their user ids.

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

Parameters

Returns

Inherited From CommonCallAdapter.forbidAudio

Forbid Teams meeting audio.

function forbidOthersAudio(): Promise<void>

Returns

Inherited From CommonCallAdapter.forbidOthersAudio

Forbid Teams meeting video.

function forbidOthersVideo(): Promise<void>

Returns

Inherited From CommonCallAdapter.forbidOthersVideo

Forbid Teams meeting attendees video by their user ids.

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

Parameters

Returns

Inherited From CommonCallAdapter.forbidVideo

Get the current State

function getState(): CallAdapterState

Returns

Inherited From CommonCallAdapter.getState

Holds the call.

function holdCall(): Promise<void>

Returns

Inherited From CommonCallAdapter.holdCall

Leave the call

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

Parameters

Returns

Inherited From CommonCallAdapter.leaveCall

lower hand for current user

function lowerHand(): Promise<void>

Returns

Inherited From CommonCallAdapter.lowerHand

Mute the current user during the call or disable microphone locally

function mute(): Promise<void>

Returns

Inherited From CommonCallAdapter.mute

Mute All participants

function muteAllRemoteParticipants(): Promise<void>

Returns

Inherited From CommonCallAdapter.muteAllRemoteParticipants

Mute a participant

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

Parameters

Returns

Inherited From CommonCallAdapter.muteParticipant

Unsubscribe function for 'breakoutRoomsUpdated' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'callEnded' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'callIdChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'capabilitiesChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'captionsReceived' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'diagnosticChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'displayNameChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'error' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'isCaptionLanguageChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'isCaptionsActiveChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'isLocalScreenSharingActiveChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'isMutedChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'isSpeakingChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'isSpokenLanguageChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'mutedByOthers' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'participantsJoined' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'participantsLeft' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'realTimeTextReceived' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'roleChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'selectedMicrophoneChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'selectedSpeakerChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'spotlightChanged' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribe function for 'transferRequested' event.

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

Parameters

Inherited From CommonCallAdapter.off

Unsubscribes the handler to stateChanged events.

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

Parameters

Inherited From CommonCallAdapter.offStateChange

Subscribe function for 'breakoutRoomsUpdated' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'callEnded' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'callIdChanged' event.

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

Parameters

Remarks

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

Inherited From CommonCallAdapter.on

Subscribe function for 'capabilitiesChanged' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'captionsReceived' event.

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

Parameters

Inherited From CommonCallAdapter.on

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

Inherited From CommonCallAdapter.on

Subscribe function for 'displayNameChanged' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'error' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'isCaptionLanguageChanged' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'isCaptionsActiveChanged' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'isLocalScreenSharingActiveChanged' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'isMutedChanged' event.

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

Parameters

Remarks

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

Inherited From CommonCallAdapter.on

Subscribe function for 'isSpeakingChanged' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'isSpokenLanguageChanged' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'mutedByOthers' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'participantsJoined' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'participantsLeft' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'realTimeTextReceived' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'roleChanged' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'selectedMicrophoneChanged' event.

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

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'selectedSpeakerChanged' event.

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

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'spotlightChanged' event.

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

Parameters

Inherited From CommonCallAdapter.on

Subscribe function for 'transferRequested' event.

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

Parameters

Inherited From CommonCallAdapter.on

Send reaction emoji

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

Parameters

Returns

Inherited From CommonCallAdapter.onReactionClick

Subscribes the handler to stateChanged events.

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

Parameters

Inherited From CommonCallAdapter.onStateChange

Permit Teams meeting attendees audio by their user ids.

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

Parameters

Returns

Inherited From CommonCallAdapter.permitAudio

Permit Teams meeting audio.

function permitOthersAudio(): Promise<void>

Returns

Inherited From CommonCallAdapter.permitOthersAudio

Permit Teams meeting video.

function permitOthersVideo(): Promise<void>

Returns

Inherited From CommonCallAdapter.permitOthersVideo

Permit Teams meeting attendees audio by their user ids.

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

Parameters

Returns

Inherited From CommonCallAdapter.permitVideo

Query for available camera devices.

function queryCameras(): Promise<VideoDeviceInfo[]>

Returns

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

Remarks

This method should be called after askDevicePermission()

Inherited From CommonCallAdapter.queryCameras

Query for available microphone devices.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Returns

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

Remarks

This method should be called after askDevicePermission()

Inherited From CommonCallAdapter.queryMicrophones

Query for available speaker devices.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Returns

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

Remarks

This method should be called after askDevicePermission()

Inherited From CommonCallAdapter.querySpeakers

Raise hand for current user

function raiseHand(): Promise<void>

Returns

Inherited From CommonCallAdapter.raiseHand

Remove a participant from the call.

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

Parameters

Returns

Inherited From CommonCallAdapter.removeParticipant

Remove a participant from the call.

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

Parameters

Returns

Inherited From CommonCallAdapter.removeParticipant

Resumes the call from a LocalHold state.

function resumeCall(): Promise<void>

Returns

Inherited From CommonCallAdapter.resumeCall

Return to origin call of breakout room

function returnFromBreakoutRoom(): Promise<void>

Returns

Inherited From CommonCallAdapter.returnFromBreakoutRoom

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

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

Parameters

Returns

Inherited From CommonCallAdapter.sendDtmfTone

Set the camera to use in the call.

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

Parameters

Returns

Inherited From CommonCallAdapter.setCamera

Function to set caption language

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

Parameters

Returns

Inherited From CommonCallAdapter.setCaptionLanguage

Set the microphone to use in the call.

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

Parameters

Returns

Inherited From CommonCallAdapter.setMicrophone

Set the speaker to use in the call.

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

Parameters

Returns

Inherited From CommonCallAdapter.setSpeaker

Function to set spoken language

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

Parameters

Returns

Inherited From CommonCallAdapter.setSpokenLanguage

Recalculate the seating positions for together mode.

function setTogetherModeSceneSize(width: number, height: number)

Parameters

Remarks

This method is implemented for composite

Inherited From CommonCallAdapter.setTogetherModeSceneSize

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

Returns

Inherited From CommonCallAdapter.startCamera

Function to Start captions

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

Parameters

Returns

Inherited From CommonCallAdapter.startCaptions

Start the noise suppression effect.

function startNoiseSuppressionEffect(): Promise<void>

Returns

Inherited From CommonCallAdapter.startNoiseSuppressionEffect

Start sharing the screen during a call.

function startScreenShare(): Promise<void>

Returns

Inherited From CommonCallAdapter.startScreenShare

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

Returns

Inherited From CommonCallAdapter.startSpotlight

Start Together mode.

function startTogetherMode(): Promise<void>

Returns

Inherited From CommonCallAdapter.startTogetherMode

Start the video background effect.

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

Parameters

Returns

Inherited From CommonCallAdapter.startVideoBackgroundEffect

Stop all spotlights

function stopAllSpotlight(): Promise<void>

Returns

Inherited From CommonCallAdapter.stopAllSpotlight

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

function stopCamera(): Promise<void>

Returns

Inherited From CommonCallAdapter.stopCamera

Funtion to stop captions

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

Parameters

Returns

Inherited From CommonCallAdapter.stopCaptions

Stop the noise suppression effect.

function stopNoiseSuppressionEffect(): Promise<void>

Returns

Inherited From CommonCallAdapter.stopNoiseSuppressionEffect

Stop sharing the screen

function stopScreenShare(): Promise<void>

Returns

Inherited From CommonCallAdapter.stopScreenShare

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

Returns

Inherited From CommonCallAdapter.stopSpotlight

Stop the video background effect.

function stopVideoBackgroundEffects(): Promise<void>

Returns

Inherited From CommonCallAdapter.stopVideoBackgroundEffects

Send the end of call survey result

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

Parameters

Returns

Inherited From CommonCallAdapter.submitSurvey

Unmute the current user during the call or enable microphone locally

function unmute(): Promise<void>

Returns

Inherited From CommonCallAdapter.unmute

Override the background picker images for background replacement effect.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parameters

Inherited From CommonCallAdapter.updateBackgroundPickerImages

Update the selected video background effect.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parameters

Inherited From CommonCallAdapter.updateSelectedVideoBackgroundEffect