CallAdapterSubscribers interface
Call composite events that can be subscribed to.
Methods
off("call |
Unsubscribe function for 'callEnded' event. |
off("call |
Unsubscribe function for 'callIdChanged' event. |
off("diagnostic |
Unsubscribe function for 'diagnosticChanged' event. |
off("display |
Unsubscribe function for 'displayNameChanged' event. |
off("error", (e: Adapter |
Unsubscribe function for 'error' event. |
off("is |
Unsubscribe function for 'isLocalScreenSharingActiveChanged' event. |
off("is |
Unsubscribe function for 'isMutedChanged' event. |
off("is |
Unsubscribe function for 'isSpeakingChanged' event. |
off("participants |
Unsubscribe function for 'participantsJoined' event. |
off("participants |
Unsubscribe function for 'participantsLeft' event. |
off("selected |
Unsubscribe function for 'selectedMicrophoneChanged' event. |
off("selected |
Unsubscribe function for 'selectedSpeakerChanged' event. |
on("call |
Subscribe function for 'callEnded' event. |
on("call |
Subscribe function for 'callIdChanged' event. |
on("diagnostic |
Subscribe function for 'diagnosticChanged' event. This event fires whenever there is a change in user facing diagnostics about the ongoing call. |
on("display |
Subscribe function for 'displayNameChanged' event. |
on("error", (e: Adapter |
Subscribe function for 'error' event. |
on("is |
Subscribe function for 'isLocalScreenSharingActiveChanged' event. |
on("is |
Subscribe function for 'isMutedChanged' event. |
on("is |
Subscribe function for 'isSpeakingChanged' event. |
on("participants |
Subscribe function for 'participantsJoined' event. |
on("participants |
Subscribe function for 'participantsLeft' event. |
on("selected |
Subscribe function for 'selectedMicrophoneChanged' event. This event fires whenever the user selects a new microphone device. |
on("selected |
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"
- listener
- CallEndedListener
off("callIdChanged", CallIdChangedListener)
Unsubscribe function for 'callIdChanged' event.
function off(event: "callIdChanged", listener: CallIdChangedListener)
Parameters
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
off("diagnosticChanged", DiagnosticChangedEventListner)
Unsubscribe function for 'diagnosticChanged' event.
function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)
Parameters
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
off("displayNameChanged", DisplayNameChangedListener)
Unsubscribe function for 'displayNameChanged' event.
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parameters
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
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"
- listener
- IsMutedChangedListener
off("isSpeakingChanged", IsSpeakingChangedListener)
Unsubscribe function for 'isSpeakingChanged' event.
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parameters
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
off("participantsJoined", ParticipantsJoinedListener)
Unsubscribe function for 'participantsJoined' event.
function off(event: "participantsJoined", listener: ParticipantsJoinedListener)
Parameters
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
off("participantsLeft", ParticipantsLeftListener)
Unsubscribe function for 'participantsLeft' event.
function off(event: "participantsLeft", listener: ParticipantsLeftListener)
Parameters
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
off("selectedMicrophoneChanged", PropertyChangedEvent)
Unsubscribe function for 'selectedMicrophoneChanged' event.
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parameters
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
off("selectedSpeakerChanged", PropertyChangedEvent)
Unsubscribe function for 'selectedSpeakerChanged' event.
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parameters
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
on("callEnded", CallEndedListener)
Subscribe function for 'callEnded' event.
function on(event: "callEnded", listener: CallEndedListener)
Parameters
- event
-
"callEnded"
- listener
- CallEndedListener
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.
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
on("displayNameChanged", DisplayNameChangedListener)
Subscribe function for 'displayNameChanged' event.
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parameters
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
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"
- listener
- IsMutedChangedListener
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"
- listener
- IsSpeakingChangedListener
on("participantsJoined", ParticipantsJoinedListener)
Subscribe function for 'participantsJoined' event.
function on(event: "participantsJoined", listener: ParticipantsJoinedListener)
Parameters
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
on("participantsLeft", ParticipantsLeftListener)
Subscribe function for 'participantsLeft' event.
function on(event: "participantsLeft", listener: ParticipantsLeftListener)
Parameters
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
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
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