Skip to content

ApplicationCallEventListener

Kenan Genjac edited this page Jul 2, 2024 · 5 revisions



onRinging(callRingingEvent)

Description

Method that is triggered when a call is ringing

Arguments

  • callRingingEvent: CallRingingEvent - Event instance which is used when a call is ringing. Does not contain any additional data.

Returns

  • N/A



onEarlyMedia(callEarlyMediaEvent)

Description

Method that is triggered when there is media to be played before establishing a call.

Arguments

  • callEarlyMediaEvent: CallEarlyMediaEvent - Event instance which is used when there is media to be played before establishing a call. Does not contain any additional data.

Returns

  • N/A



onEstablished(callEstablishedEvent)

Description

Method that is triggered when a call is established.

Arguments

  • callEstablishedEvent: CallEstablishedEvent - Event instance relevant for establishing a call. Does not contain any additional data.

Returns

  • N/A



onHangup(callHangupEvent)

Description

Method that is triggered when a call has been hung up. This covers both normal hang up and when a call has been hung up because of an error.

Arguments

  • callHangupEvent: CallHangupEvent - Event instance which contains data relevant to the hangup. Contains data about the hangup error code, which informs if the call ended without an error or with a certain error ( depending on the code).

Returns

  • N/A



onError(errorEvent)

Description

Method that is triggered when a call has encountered an error which does not hang up the call.

Arguments

  • errorEvent: ErrorEvent - Event instance which contains data relevant to the error. Contains data about the error code.

Returns

  • N/A



onCameraVideoAdded(cameraVideoAddedEvent)

Description

Method that is triggered when camera video has been added locally on a call.

Arguments

  • cameraVideoAddedEvent: CameraVideoAddedEvent - Event instance which contains the local camera RTC video track.

Returns

  • N/A



onCameraVideoUpdated(cameraVideoUpdatedEvent)

Description

Method that is triggered when camera video has been updated (in any way changed) locally on a call.

Arguments

  • cameraVideoUpdatedEvent: CameraVideoUpdatedEvent - Event instance which contains the updated local camera RTC video track.

Returns

  • N/A



onCameraVideoRemoved()

Description

Method that is triggered when camera video has been removed locally on a call.

Arguments

  • none

Returns

  • N/A



onScreenShareAdded(screenShareAddedEvent)

Description

Method that is triggered when screen sharing has been started locally on a call.

Arguments

  • screenShareAddedEvent: ScreenShareAddedEvent - Event instance which contains the local screenshare RTC video track.

Returns

  • N/A



onScreenShareRemoved(screenShareRemovedEvent)

Description

Method that is triggered when screen sharing has been stopped locally on a call.

Arguments

  • screenShareRemovedEvent: ScreenShareRemovedEvent - Event instance which contains the reason for the screenshare removal.

Returns

  • N/A



onConferenceJoined(conferenceJoinedEvent)

Description

Method that is triggered when the call has been added into a conference.

Arguments

  • conferenceJoinedEvent: ConferenceJoinedEvent - Event instance which contains data about the conference that has been joined. Contains data about the conference id, name, and the participants already inside the conference.

Returns

  • N/A



onConferenceLeft(conferenceLeftEvent)

Description

Method that is triggered when the call has been removed from a conference.

Arguments

  • conferenceLeftEvent: ConferenceLeftEvent - Event instance which contains data about the manner in which the conference has been left. Contains data about the error code that the conference has been left with, be it no error or other.

Returns

  • N/A



onParticipantJoining(participantJoiningEvent)

Description

Method that is triggered when another participant is being added to the conference.

Arguments

  • participantJoiningEvent: ParticipantJoiningEvent - Event instance which contains data about the participant that is currently trying to join the conference.

Returns

  • N/A



onParticipantJoined(participantJoinedEvent)

Description

Method that is triggered when another participant has been added to the conference.

Arguments

  • participantJoinedEvent: ParticipantJoinedEvent - Event instance which contains data about the participant that has joined the conference.

Returns

  • N/A



onParticipantLeft(participantLeftEvent)

Description

Method that is triggered when another participant has left the conference.

Arguments

  • participantLeftEvent: ParticipantLeftEvent - Event instance which contains data about the participant that has left the conference.

Returns

  • N/A



onParticipantCameraVideoAdded(participantCameraVideoAddedEvent)

Description

Method that is triggered when another participant has added their camera video to the conference.

Arguments

  • participantCameraVideoAddedEvent: ParticipantCameraVideoAddedEvent - Event instance which contains data about the added remote camera video and which specific participant added it.

Returns

  • N/A



onParticipantCameraVideoRemoved(participantCameraVideoRemovedEvent)

Description

Method that is triggered when another participant has removed their camera video from the conference.

Arguments

Returns

  • N/A



onParticipantScreenShareAdded(participantScreenShareAddedEvent)

Description

Method that is triggered when another participant has shared their screen to the conference.

Arguments

  • participantScreenShareAddedEvent: ParticipantScreenShareAddedEvent - Event instance which contains data about the added remote screenshare video and which specific participant added it.

Returns

  • N/A



onParticipantScreenShareRemoved(participantScreenShareRemovedEvent)

Description

Method that is triggered when another participant has removed their shared screen from the conference.

Arguments

  • participantScreenShareRemovedEvent: ParticipantScreenShareRemovedEvent - Event instance which contains data describing which participant removed their screenshare video.

Returns

  • N/A



onParticipantMuted(participantMutedEvent)

Description

Method that is triggered when another participant has been muted in the conference.

Arguments

  • participantMutedEvent: ParticipantMutedEvent - Event instance which contains data describing which participant has been muted.

Returns

  • N/A



onParticipantUnmuted(participantUnmutedEvent)

Description

Method that is triggered when another participant has been unmuted in the conference.

Arguments

  • participantUnmutedEvent: ParticipantUnmutedEvent - Event instance which contains data describing which participant has been unmuted.

Returns

  • N/A



onParticipantDeaf(participantDeafEvent)

Description

Method that is triggered when another participant has been deafened in the conference.

Arguments

  • participantDeafEvent: ParticipantDeafEvent - Event instance which contains data describing which participant has been deafened.

Returns

  • N/A



onParticipantUndeaf(participantUndeafEvent)

Description

Method that is triggered when another participant has been undeafened in the conference.

Arguments

  • participantUndeafEvent: ParticipantUndeafEvent - Event instance which contains data describing which participant has been undeafened.

Returns

  • N/A



onParticipantStartedTalking(participantStartedTalkingEvent)

Description

Method that is triggered when another participant starts talking in the conference.

Arguments

Returns

  • N/A



onParticipantStoppedTalking(participantStoppedTalkingEvent)

Description

Method that is triggered when another participant stops talking in the conference.

Arguments

Returns

  • N/A



onDialogJoined(dialogJoinedEvent)

Description

Method that is triggered when the call joins a dialog.

Arguments

  • dialogJoinedEvent: DialogJoinedEvent - Event instance which contains data about the joined dialog, including the dialog id and the remote participant.

Returns

  • N/A



onDialogLeft(dialogLeftEvent)

Description

Method that is triggered when the call leaves the dialog.

Arguments

  • dialogLeftEvent: DialogLeftEvent - Event instance which contains data about the manner in which the dialog has been left, including the error code that the dialog has been left with, be it no error or other.

Returns

  • N/A



onReconnecting(reconnectingEvent)

Description

Method that is triggered when the call initiates reconnecting process.

Arguments

  • reconnectingEvent: ReconnectingEvent - Event instance which is used when the call initiates the reconnecting process. Does not contain any additional data.

Returns

  • N/A



onReconnected(reconnectedEvent)

Description

Method that is triggered when the call has been successfully reconnected.

Arguments

  • reconnectedEvent: ReconnectedEvent - Event instance which is used when the call has been reconnected. Does not contain any additional data.

Returns

  • N/A



onCallRecordingStarted(callRecordingStartedEvent)

Description

Method that is triggered when the call recording has been started.

Arguments

  • callRecordingStartedEvent: CallRecordingStartedEvent - Event instance which contains data about the current recording type in the call when the call recording is started.

Returns

  • N/A



onCallRecordingStopped(callRecordingStoppedEvent)

Description

Method that is triggered when the call recording has been stopped.

Arguments

  • callRecordingStoppedEvent: CallRecordingStoppedEvent - Event instance which is used when a call recording has been stopped. Does not contain any additional data.

Returns

  • N/A



onConferenceRecordingStarted(conferenceRecordingStartedEvent)

Description

Method that is triggered when the conference recording has been started.

Arguments

  • conferenceRecordingStartedEvent: ConferenceRecordingStartedEvent - Event instance which contains data about the current recording type in the conference when the conference recording is started.

Returns

  • N/A



onConferenceRecordingStopped(conferenceRecordingStoppedEvent)

Description

Method that is triggered when the conference recording has been stopped.

Arguments

  • conferenceRecordingStoppedEvent: ConferenceRecordingStoppedEvent - Event instance which is used when a conference recording has been stopped. Does not contain any additional data.

Returns

  • N/A



onDialogRecordingStarted(dialogRecordingStartedEvent)

Description

Method that is triggered when the dialog recording has been started.

Arguments

  • dialogRecordingStartedEvent: DialogRecordingStartedEvent - Event instance which contains data about the current recording type in the dialog when the dialog recording is started.

Returns

  • N/A



onDialogRecordingStopped(dialogRecordingStoppedEvent)

Description

Method that is triggered when the dialog recording has been stopped.

Arguments

  • dialogRecordingStoppedEvent: DialogRecordingStoppedEvent - Event instance which is used when a dialog recording has been stopped. Does not contain any additional data.

Returns

  • N/A

Tutorials

Migration guides

Reference documentation

Clone this wiki locally