CallAdapterSubscribers interface

Call composite events that can be subscribed to.

Methods

off("callEnded", CallEndedListener)

Unsubscribe function for 'callEnded' event.

off("callIdChanged", CallIdChangedListener)

Unsubscribe function for 'callIdChanged' 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("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Unsubscribe function for 'isLocalScreenSharingActiveChanged' event.

off("isMutedChanged", IsMutedChangedListener)

Unsubscribe function for 'isMutedChanged' event.

off("isSpeakingChanged", IsSpeakingChangedListener)

Unsubscribe function for 'isSpeakingChanged' event.

off("participantsJoined", ParticipantsJoinedListener)

Unsubscribe function for 'participantsJoined' event.

off("participantsLeft", ParticipantsLeftListener)

Unsubscribe function for 'participantsLeft' event.

off("selectedMicrophoneChanged", PropertyChangedEvent)

Unsubscribe function for 'selectedMicrophoneChanged' event.

off("selectedSpeakerChanged", PropertyChangedEvent)

Unsubscribe function for 'selectedSpeakerChanged' event.

on("callEnded", CallEndedListener)

Subscribe function for 'callEnded' event.

on("callIdChanged", CallIdChangedListener)

Subscribe function for 'callIdChanged' 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("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Subscribe function for 'isLocalScreenSharingActiveChanged' event.

on("isMutedChanged", IsMutedChangedListener)

Subscribe function for 'isMutedChanged' event.

on("isSpeakingChanged", IsSpeakingChangedListener)

Subscribe function for 'isSpeakingChanged' event.

on("participantsJoined", ParticipantsJoinedListener)

Subscribe function for 'participantsJoined' event.

on("participantsLeft", ParticipantsLeftListener)

Subscribe function for 'participantsLeft' 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.

Method Details

off("callEnded", CallEndedListener)

Unsubscribe function for 'callEnded' event.

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

Parameters

event

"callEnded"

off("callIdChanged", CallIdChangedListener)

Unsubscribe function for 'callIdChanged' event.

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

Parameters

event

"callIdChanged"

off("diagnosticChanged", DiagnosticChangedEventListner)

Unsubscribe function for 'diagnosticChanged' event.

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

Parameters

event

"diagnosticChanged"

off("displayNameChanged", DisplayNameChangedListener)

Unsubscribe function for 'displayNameChanged' event.

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

Parameters

event

"displayNameChanged"

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

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Unsubscribe function for 'isLocalScreenSharingActiveChanged' event.

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

Parameters

event

"isLocalScreenSharingActiveChanged"

off("isMutedChanged", IsMutedChangedListener)

Unsubscribe function for 'isMutedChanged' event.

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

Parameters

event

"isMutedChanged"

off("isSpeakingChanged", IsSpeakingChangedListener)

Unsubscribe function for 'isSpeakingChanged' event.

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

Parameters

event

"isSpeakingChanged"

off("participantsJoined", ParticipantsJoinedListener)

Unsubscribe function for 'participantsJoined' event.

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

Parameters

event

"participantsJoined"

off("participantsLeft", ParticipantsLeftListener)

Unsubscribe function for 'participantsLeft' event.

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

Parameters

event

"participantsLeft"

off("selectedMicrophoneChanged", PropertyChangedEvent)

Unsubscribe function for 'selectedMicrophoneChanged' event.

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

Parameters

event

"selectedMicrophoneChanged"

off("selectedSpeakerChanged", PropertyChangedEvent)

Unsubscribe function for 'selectedSpeakerChanged' event.

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

Parameters

event

"selectedSpeakerChanged"

on("callEnded", CallEndedListener)

Subscribe function for 'callEnded' event.

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

Parameters

event

"callEnded"

on("callIdChanged", CallIdChangedListener)

Subscribe function for 'callIdChanged' event.

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

Parameters

event

"callIdChanged"

Remarks

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

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"

on("displayNameChanged", DisplayNameChangedListener)

Subscribe function for 'displayNameChanged' event.

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

Parameters

event

"displayNameChanged"

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

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Subscribe function for 'isLocalScreenSharingActiveChanged' event.

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

Parameters

event

"isLocalScreenSharingActiveChanged"

on("isMutedChanged", IsMutedChangedListener)

Subscribe function for 'isMutedChanged' event.

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

Parameters

event

"isMutedChanged"

Remarks

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

on("isSpeakingChanged", IsSpeakingChangedListener)

Subscribe function for 'isSpeakingChanged' event.

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

Parameters

event

"isSpeakingChanged"

on("participantsJoined", ParticipantsJoinedListener)

Subscribe function for 'participantsJoined' event.

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

Parameters

event

"participantsJoined"

on("participantsLeft", ParticipantsLeftListener)

Subscribe function for 'participantsLeft' event.

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

Parameters

event

"participantsLeft"

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"

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"