kava-events.md

KAVA Events List:

Here you can see the list of all available KAVA Events:

• VIEW
• IMPRESSION
• PLAY_REQUEST
• PLAY
• RESUME
• PAUSE
• REPLAY
• SEEK
• PLAY_REACHED_25_PERCENT
• PLAY_REACHED_50_PERCENT
• PLAY_REACHED_75_PERCENT
• PLAY_REACHED_100_PERCENT
• SOURCE_SELECTED
• FLAVOR_SWITCH
• AUDIO_SELECTED
• CAPTIONS
• ERROR

KAVA Events Documentation:

Here we will see some explanation about each event. When does it sent and what parameters it have.

VIEW - Collective event that represent report for every 10 seconds of active playback.

• Event ID: 99
• Event Parameters:
  • COMMON_PARAMS
  • playTimeSum
  • bufferTime
  • bufferTimeSum
  • actualBitrate
  • averageBitrate
• Sent every 10 second of active playback (when player is paused, view timer should be paused/stopped).
• 30 seconds without VIEW event will reset KAVA session, so all the VIEW specific parameters should be reset also.
• Server may notify Kava (via response field "viewEventsEnabled" = false) to shut down VIEW events. When it happens, VIEW events should be blocked from sending until server decides to enable VIEW events again.

---

IMPRESSION - Sent when the player is loaded on the page with some entry ID.
It will be triggered only once per entry.

• Event ID: 1
• Player Event: SOURCE_SELECTED
• Event Parameters: - COMMON_PARAMS

---

PLAY_REQUEST - Sent when play was requested by application.

• Event ID: 2
• Player Event: PLAY
• Event Parameters: - COMMON_PARAMS

---

PLAY - Sent when actual playback has been started for the first time.

• Event ID: 3
• Player Event: PLAYING
• Event Parameters:
  • COMMON_PARAMS
  • bufferTime
  • bufferTimeSum
  • actualBitrate
  • joinTime

---

RESUME - Sent when actual playback has been resumed (!NOT for the first time).

• Event ID: 4
• Player Event: PLAYING
• Event Parameters:
  • COMMON_PARAMS
  • bufferTime
  • bufferTimeSum
  • actualBitrate

---

PAUSE - Sent when playback was paused (Player PAUSE event received).

• Event ID: 33
• Player Event: PAUSE
• Event Parameters: - COMMON_PARAMS
• During pause Kava should prevent from counting VIEW event timer.

---

REPLAY - Sent when replay called by application (Player REPLAY event received).

• Event ID: 34
• Player Event: PLAYING
• Event Parameters:
  • COMMON_PARAMS
• Replay should reset all the parameters related to playback except PLAYER_REACHED events.

---

SEEK - Sent when seek requested.

• Event ID: 35
• Player Event: SEEKING
• Event Parameters:
  • COMMON_PARAMS
  • targetPosition

---

PLAY_REACHED_25_PERCENT - Sent when player reached 25% of the playback. No matter if by seeking or regular playback.

• Event ID: 11
• Event Parameters:
  • COMMON_PARAMS
• Sent only once per entry.

---

PLAY_REACHED_50_PERCENT - Sent when player reached 50% of the playback. No matter if by seeking or regular playback.

• Event ID: 12
• Event Parameters:
  • COMMON_PARAMS
• Sent only once per entry.
• If reached before 25% (by seeking or startTime) first will fire:
  • PLAY_REACHED_25_PERCENT event.

---

PLAY_REACHED_75_PERCENT - Sent when player reached 75% of the playback. No matter if by seeking or regular playback.

• Event ID: 13
• Event Parameters:
  • COMMON_PARAMS
• Sent only once per entry.
• If reached before 50% (by seeking or startTime) first will fire: - PLAY_REACHED_25_PERCENT event. - PLAY_REACHED_50_PERCENT event.

---

PLAY_REACHED_100_PERCENT - Sent when player reached 100% of the playback(Player END event). No matter if by seeking or regular playback.

• Event ID: 14
• Event Parameters:
  • COMMON_PARAMS
• Sent only once per entry.
• If reached before 75% (by seeking or startFrom) first will fire: - PLAY_REACHED_25_PERCENT event. - PLAY_REACHED_50_PERCENT event. - PLAY_REACHED_75_PERCENT event.

---

SOURCE_SELECTED - Sent when video track changed manually (Not ABR selection).

• Event ID: 39
• Player Event: VIDEO_TRACK_CHANGED - player.isAdaptiveBitrateEnabled() should be false.
• Event Parameters:
  • COMMON_PARAMS
  • actualBitrate

---

FLAVOR_SWITCH - Sent when video track changed by ABR mode.

• Event ID: 43
• Player Event: VIDEO_TRACK_CHANGED - player.isAdaptiveBitrateEnabled() should be true.
• Event Parameters:
  • COMMON_PARAMS
  • actualBitrate

---

AUDIO_SELECTED - Sent when audio track changed.

• Event ID: 42
• Player Event: AUDIO_TRACK_CHANGED
• Event Parameters:
  • COMMON_PARAMS
  • language

---

CAPTIONS - Sent when text track changed.

• Event ID: 38
• Player Event: TEXT_TRACK_CHANGED
• Event Parameters:
  • COMMON_PARAMS
  • caption

---

ERROR - Sent when error occurs. (Player ERROR event received).

• Event ID: 98
• Player Event: ERROR
• Event Parameters:
  • COMMON_PARAMS
  • errorCode