Skip to content

CallsApiEvent

Kenan Genjac edited this page Jun 28, 2024 · 8 revisions



RINGING

Description

Event triggered when a call is ringing.

Payload

event = {}



EARLY_MEDIA

Description

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

Payload

event = { stream: MediaStream }



ESTABLISHED

Description

Event triggered when a call is established.

Payload

event = { stream: MediaStream }



HANGUP

Description

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

Payload

event = { errorCode: ErrorCode, totalMediaStats: TotalMediaStats }



ERROR

Description

Event triggered when a call has encountered an error which does not hang up the call.

Payload

event = { errorCode: ErrorCode }



CAMERA_VIDEO_ADDED

Description

Event triggered when camera video has been added locally on a call.

Payload

event = { stream: MediaStream }



CAMERA_VIDEO_UPDATED

Description

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

Payload

event = { stream: MediaStream }



CAMERA_VIDEO_REMOVED

Description

Event triggered when camera video has been removed locally on a call.

Payload

event = {}



SCREEN_SHARE_ADDED

Description

Event triggered when screen sharing has been started locally on a call.

Payload

event = { stream: MediaStream }



SCREEN_SHARE_REMOVED

Description

Event triggered when screen sharing has been stopped locally on a call.

Payload

event = { reason: VideoRemovalReason }



ROOM_JOINED

Description

Event triggered when the participant has joined a room.

Payload

event = { id: string, name: string, participants: Participant[], stream: MediaStream, recordingType: RecordingType }



ROOM_LEFT

Description

Event triggered when the participant has left a room.

Payload

event = { errorCode: ErrorCode, totalMediaStats: TotalMediaStats }



CONFERENCE_JOINED

Description

Event triggered when the call has been added into a conference.

Payload

event = { id: string, name: string, participants: Participant[], recordingType: RecordingType }



CONFERENCE_LEFT

Description

Event triggered when the call has left a conference.

Payload

event = { errorCode: ErrorCode }



PARTICIPANT_JOINING

Description

Event triggered when another participant is being added to the conference or room.

Payload

event = { participant: Participant }



PARTICIPANT_JOINED

Description

Event triggered when another participant has been added to the conference or room.

Payload

event = { participant: Participant }



PARTICIPANT_LEFT

Description

Event triggered when another participant has left the conference or room.

Payload

event = { participant: Participant }



PARTICIPANT_MUTED

Description

Event triggered when another participant has been muted in the conference or room.

Payload

event = { participant: Participant }



PARTICIPANT_UNMUTED

Description

Event triggered when another participant has been unmuted in the conference or room.

Payload

event = { participant: Participant }



PARTICIPANT_DEAF

Description

Event triggered when another participant has been deafened in the conference or room.

Payload

event = { participant: Participant }



PARTICIPANT_UNDEAF

Description

Event triggered when another participant has been undeafened in the conference or room.

Payload

event = { participant: Participant }



PARTICIPANT_STARTED_TALKING

Description

Event triggered when another participant starts talking in the conference or room.

Payload

event = { participant: Participant }



PARTICIPANT_STOPPED_TALKING

Description

Event triggered when another participant stops talking in the conference or room.

Payload

event = { participant: Participant }



PARTICIPANT_CAMERA_VIDEO_ADDED

Description

Event triggered when another participant has added their camera video to the conference or room.

Payload

event = { participant: Participant, stream: MediaStream }



PARTICIPANT_CAMERA_VIDEO_REMOVED

Description

Event triggered when another participant has removed their camera video from the conference or room.

Payload

event = { participant: Participant }



PARTICIPANT_SCREEN_SHARE_ADDED

Description

Event triggered when another participant has shared their screen to the conference or room.

Payload

event = { participant: Participant, stream: MediaStream }



PARTICIPANT_SCREEN_SHARE_REMOVED

Description

Event triggered when another participant has removed their shared screen from the conference or room.

Payload

event = { participant: Participant }



REMOTE_MUTED

Description

Event triggered when the remote user has been muted.

Payload

event = {}



REMOTE_UNMUTED

Description

Event triggered when the remote user has been unmuted.

Payload

event = {}



REMOTE_CAMERA_VIDEO_ADDED

Description

Event triggered when the remote user has added their camera video.

Payload

event = { stream: MediaStream }



REMOTE_CAMERA_VIDEO_REMOVED

Description

Event triggered when the remote user has removed their camera video.

Payload

event = {}



REMOTE_SCREEN_SHARE_ADDED

Description

Event triggered when the remote user has shared their screen.

Payload

event = { stream: MediaStream }



REMOTE_SCREEN_SHARE_REMOVED

Description

Event triggered when the remote user has removed their screen share.

Payload

event = {}



NETWORK_QUALITY_CHANGED

Description

Event triggered when the participant's network quality has changed.

Payload

event = { networkQuality: NetworkQuality, currentMediaStats: CurrentMediaStats }



REMOTE_NETWORK_QUALITY_CHANGED

Description

Event triggered when remote participant's network quality has changed.

Payload

event = { networkQuality: NetworkQuality };



PARTICIPANT_NETWORK_QUALITY_CHANGED

Description

Event triggered when one of the participant's network quality has changed.

Payload

event = { participant: Participant, networkQuality: NetworkQuality };



DIALOG_JOINED

Description

Event triggered when the call joins a dialog.

Payload

event = { id: string, remote: Participant, recordingType: RecordingType }



DIALOG_LEFT

Description

Event triggered when the call leaves the dialog.

Payload

event = { errorCode: ErrorCode }



ROOM_REJOINING

Description

Event triggered when the room call initiates rejoining process.

Payload

event = {}



ROOM_REJOINED

Description

Event triggered when the room call has been successfully rejoined.

Payload

event = { id: string, name: string, participants: Participant[], stream: MediaStream }



RECONNECTING

Description

Event triggered when the call initiates reconnecting process.

Payload

event = {}



RECONNECTED

Description

Event triggered when the call has been successfully reconnected.

Payload

event = { stream: MediaStream }



CALL_RECORDING_STARTED

Description

Event triggered when call recording has been started.

Payload

event = { recordingType: RecordingType }



CALL_RECORDING_STOPPED

Description

Event triggered when call recording has been stopped.

Payload

event = { }



CONFERENCE_RECORDING_STARTED

Description

Event triggered when conference recording has been started.

Payload

event = { recordingType: RecordingType }



CONFERENCE_RECORDING_STOPPED

Description

Event triggered when conference recording has been stopped.

Payload

event = { }



DIALOG_RECORDING_STARTED

Description

Event triggered when dialog recording has been started.

Payload

event = { recordingType: RecordingType }



DIALOG_RECORDING_STOPPED

Description

Event triggered when dialog recording has been stopped.

Payload

event = { }



ROOM_RECORDING_STARTED

Description

Event triggered when a Room recording has been started.

Payload

event = { recordingType: RecordingType }

Tutorials

Migration guides

Reference documentation

Clone this wiki locally