CallAdapterCallManagement interface

Package:

@azure/communication-react

Warning

This API is now deprecated.

CallAdapter interface will be flatten, consider using CallAdapter directly

Functionality for managing the current call or start a new call

Extends

CallAdapterCallOperations

Inherited Properties

sendRealTimeText

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.
createStreamView(string, VideoStreamOptions)	Create the html view for a stream.
createTogetherModeStreamView(TogetherModeStreamOptions)	Create the html view for a stream.
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.
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
onReactionClick(Reaction)	Send reaction emoji
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.
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
setCaptionLanguage(string)	Function to set caption language
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): undefined | Call

Parameters

microphoneOn

boolean

Whether microphone is initially enabled

Returns

undefined | Call

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

Parameters

options

JoinCallOptions

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

Returns

undefined | Call

startCall(CommunicationIdentifier[], StartCallOptions)

Start the call.

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

Parameters

participants

CommunicationIdentifier[]

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

options

StartCallOptions

Returns

undefined | Call

startCall(string[], StartCallOptions)

Start the call.

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

Parameters

participants

string[]

An array of participant ids to join

options

StartCallOptions

Returns

undefined | Call

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

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

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

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

onReactionClick(Reaction)

Send reaction emoji

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

Parameters

reaction

Reaction

Returns

Promise<void>

Inherited From CallAdapterCallOperations.onReactionClick

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

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

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

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