Skip to content

Latest commit

 

History

History
246 lines (181 loc) · 8.35 KB

kava-events.md

File metadata and controls

246 lines (181 loc) · 8.35 KB

KAVA Events List:

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

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.

  • Sent on first play and every 10 seconds 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.

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.

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

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:
  • Replay should reset all the parameters related to playback except PLAYER_REACHED events.

BUFFER_START - Sent when playback buffering started.

  • Event ID: 45
  • Player Event: BUFFER_START
  • Event Parameters:

BUFFER_END - Sent when playback buffering ended.

  • Event ID: 46
  • Player Event: BUFFER_END
  • Event Parameters:

SEEK - Sent when seek requested.

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:
  • 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:
  • 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:
  • 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:
  • 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:

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:

AUDIO_SELECTED - Sent when audio track changed.

CAPTIONS - Sent when text track changed.

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

SPEED - Sent when playback rate has changed.

  • Event ID: 41
  • Player Event: RATE_CHANGE
  • Event Parameters:

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