CommonCallAdapter interface

Join the call with microphone initially on/off.

function joinCall(microphoneOn?: boolean)

Parameters

Start the call.

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

Parameters

Ask for permissions of devices.

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

Parameters

Returns

Remarks

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

Inherited From CallAdapterDeviceManagement.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 CallAdapterCallOperations.createStreamView

Dispose of the Composite

function dispose()

Inherited From Disposable.dispose

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 CallAdapterCallOperations.disposeStreamView

Get the current State

function getState(): CallAdapterState

Returns

Inherited From AdapterState.getState

Leave the call

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

Parameters

Returns

Inherited From CallAdapterCallOperations.leaveCall

Mute the current user during the call or disable microphone locally

function mute(): Promise<void>

Returns

Inherited From CallAdapterCallOperations.mute

Unsubscribe function for 'callEnded' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'callIdChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'diagnosticChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'displayNameChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'error' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'isLocalScreenSharingActiveChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'isMutedChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'isSpeakingChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'participantsJoined' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'participantsLeft' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'selectedMicrophoneChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribe function for 'selectedSpeakerChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.off

Unsubscribes the handler to stateChanged events.

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

Parameters

Inherited From AdapterState.offStateChange

Subscribe function for 'callEnded' event.

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

Parameters

Inherited From CallAdapterSubscribers.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 CallAdapterSubscribers.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 CallAdapterSubscribers.on

Subscribe function for 'displayNameChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.on

Subscribe function for 'error' event.

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

Parameters

Inherited From CallAdapterSubscribers.on

Subscribe function for 'isLocalScreenSharingActiveChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.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 CallAdapterSubscribers.on

Subscribe function for 'isSpeakingChanged' event.

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

Parameters

Inherited From CallAdapterSubscribers.on

Subscribe function for 'participantsJoined' event.

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

Parameters

Inherited From CallAdapterSubscribers.on

Subscribe function for 'participantsLeft' event.

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

Parameters

Inherited From CallAdapterSubscribers.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 CallAdapterSubscribers.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 CallAdapterSubscribers.on

Subscribes the handler to stateChanged events.

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

Parameters

Inherited From AdapterState.onStateChange

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 CallAdapterDeviceManagement.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 CallAdapterDeviceManagement.queryMicrophones

Query for available microphone 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 CallAdapterDeviceManagement.querySpeakers

Remove a participant from the call.

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

Parameters

Returns

Inherited From CallAdapterCallOperations.removeParticipant

Set the camera to use in the call.

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

Parameters

Returns

Inherited From CallAdapterDeviceManagement.setCamera

Set the microphone to use in the call.

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

Parameters

Returns

Inherited From CallAdapterDeviceManagement.setMicrophone

Set the speaker to use in the call.

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

Parameters

Returns

Inherited From CallAdapterDeviceManagement.setSpeaker

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 CallAdapterCallOperations.startCamera

Start sharing the screen during a call.

function startScreenShare(): Promise<void>

Returns

Inherited From CallAdapterCallOperations.startScreenShare

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 CallAdapterCallOperations.stopCamera

Stop sharing the screen

function stopScreenShare(): Promise<void>

Returns

Inherited From CallAdapterCallOperations.stopScreenShare

Unmute the current user during the call or enable microphone locally

function unmute(): Promise<void>

Returns

Inherited From CallAdapterCallOperations.unmute