Skip to content

RoomCallEventListener

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



onRoomJoined(roomJoinedEvent)

Description

Method that is triggered when the user has joined the room

Arguments

  • roomJoinedEvent: RoomJoinedEvent - Event instance which contains data about the room that has been joined. Contains data about the room id, name, and the participants already inside the room.

Returns

  • N/A



onRoomLeft(roomLeftEvent)

Description

Method that is triggered when the user has left a room

Arguments

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

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



onParticipantJoining(participantJoiningEvent)

Description

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

Arguments

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

Returns

  • N/A



void onParticipantJoined(ParticipantJoinedEvent participantJoinedEvent)

Description

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

Arguments

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

Returns

  • N/A



void onParticipantLeft(ParticipantLeftEvent participantLeftEvent)

Description

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

Arguments

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

Returns

  • N/A



void onParticipantCameraVideoAdded(ParticipantCameraVideoAddedEvent participantCameraVideoAddedEvent)

Description

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

Arguments

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

Returns

  • N/A



void onParticipantCameraVideoRemoved(ParticipantCameraVideoRemovedEvent participantCameraVideoRemovedEvent)

Description

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

Arguments

Returns

  • N/A



onParticipantScreenShareAdded(participantScreenShareAddedEvent)

Description

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

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 room.

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 room.

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 room.

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 room.

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 room.

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 room.

Arguments

Returns

  • N/A



onParticipantStoppedTalking(participantStoppedTalkingEvent)

Description

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

Arguments

Returns

  • N/A



onRoomRejoining(roomRejoiningEvent)

Description

Method that is triggered when the room call initiates rejoining process.

Arguments

  • roomRejoiningEvent: RoomRejoiningEvent - Event instance which is used when the room call initiates the rejoining process. Does not contain any additional data.

Returns

  • N/A



onRoomRejoined(roomRejoinedEvent)

Description

Method that is triggered when the room call has been successfully rejoined.

Arguments

  • roomRejoinedEvent: RoomRejoinedEvent - Event instance which contains data about the room that has been rejoined. Contains data about the room id, name, and the participants already inside the room.

Returns

  • N/A



onRoomRecordingStarted(roomRecordingStartedEvent)

Description

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

Arguments

  • roomRecordingStartedEvent: RoomRecordingStartedEvent - Event instance which contains data about the current recording type in the room when the room recording is started.

Returns

  • N/A

Tutorials

Migration guides

Reference documentation

Clone this wiki locally