Web Player SDK

Playback Events

To receive playback events, integrate the PlaybackEvent callback function in the SDK by attaching the onPlayLogFired handler:

const player = createPlayer('player-container', {
  license, // license is not required when testing in local development environment
  source: [
    {
      type: 'application/dash+xml',
      src: dashUrl,
    },
    {
      type: 'application/x-mpegurl',
      src: hlsUrl,
    }
  ],
  onPlayLogFired: (eventName, data) = {
    // Your own log service integration here
    console.debug(eventName, data)
  }
})

 

Playback Events

Event Name

 Event Definition Property Name Value Type
play "If the play api is invoked , the event will be sent
The position on seekbar. In seconds."		 player_name string
playback_module_version string
system_time date time
user_id string
pause If the play api is invoked , the event will be sent
The position on seekbar. In seconds.		 player_name string
playback_module_version string
system_time date time
user_id string
seek If the play api is invoked , the event will be sent
The position on seekbar. In seconds.		 player_name string
playback_module_version string
system_time date time
user_id string
rewind If the play api is invoked , the event will be sent
The position on seekbar. In seconds.		 player_name string
playback_module_version string
system_time date time
user_id string
forward If the play api is invoked , the event will be sent
The position on seekbar. In seconds.		 player_name string
playback_module_version string
system_time date time
user_id string
playback_began_player_loading The time when player starts to load video player_name string
playback_module_version string
system_time date time
user_id string

playback_began_player_

startup_time

 The time when player starts to load manifest player_name string
playback_module_version string
system_time date time
user_id string

playback_began_video_

startup_time

 The time when the first frame displayed. player_name string
playback_module_version string
system_time date time
user_id string
playback_video_began The time when video buffering ended player_name string
playback_module_version string
system_time date time
user_id string
current_position float
playback_video_paused The time when the playback has been paused player_name string
playback_module_version string
system_time date time
user_id string
current_position float

playback_video_buffering_

began

 The time when the buffering state began during playback. player_name string
playback_module_version string
system_time date time
user_id string
current_position float

playback_video_buffering_

ended

 The time when the buffering state ended during playback. player_name string
playback_module_version string
system_time date time
user_id string
current_position float
playback_video_ended The time when the playback has been ended player_name string
playback_module_version string
system_time date time
user_id string
current_position float
playback_seeking_began The start time of seeking during playback. player_name string
playback_module_version string
system_time date time
user_id string
current_position float
playback_seeking_ended The end time of seeking during playback. player_name string
playback_module_version string
system_time date time
user_id string
current_position float
playback_error_occurred The error code of player. Each platform should have different error codes. player_name string
playback_module_version string
system_time date time
user_id string
current_position float
errorcode string
playback_ad_began The time when AD began player_name string
playback_module_version string
system_time date time
user_id string
current_position float
playback_ad_ended The time when AD ended player_name string
playback_module_version string
system_time date time
user_id string
current_position float

playback_streaming_quality_

change_download

 Player switches profile (ABR) player_name string
playback_module_version string
system_time date time
user_id string
bitrate (kbps) int
framerate float
width int
height int

playback_streaming_quality_

change_render

 Buffered segments of previous profiles are all played, start playing switched profile player_name string
playback_module_version string
system_time date time
user_id string
bitrate (kbps) int
width int
height int
quality_setting_change User switched profile player_name string
playback_module_version string
system_time date time
user_id string
quality_name string
min_height int
max_height int
min_width int
max_width int
max_bitrate int
min_bitrate int
max_framerate float
min_framerate float
speed_setting_change "User changes the speed
0.5x, 1x, 2x, 4x..."		 player_name string
playback_module_version string
system_time date time
user_id string
playback_speed float
current_position float
playback_speed_change "The speed changed during playback:
0.5x, 1x, 2x, 4x..."		 player_name string
playback_module_version string
system_time date time
user_id string
playback_speed float
current_position float
audio_track_setting_change "User triggers the action of audio track switch.

Audio track language, is defined in ISO 639-1, ISO 3166 (optional)"		 player_name string
playback_module_version string
system_time date time
user_id string
lang string
playback_audio_track_change "Audio track changed time during playback.

Audio track language is defined in ISO 639-1, ISO 3166 (optional)"		 player_name string
playback_module_version string
system_time date time
user_id string
lang string
subtitle_setting_change "User triggers the action, of subtitle change.

Subtitle language is defined in ISO 639-1, ISO 3166 (optional)"		 player_name string
playback_module_version string
system_time date time
user_id string
lang string
playback_subtitle_change Subtitle changed time during playback.

Subtitle language is defined in ISO 639-1, ISO 3166 (optional)		 player_name string
playback_module_version string
system_time date time
user_id string
lang string
audio_volume_setting_change User triggered audio volume adjustment. player_name string
playback_module_version string
system_time date time
user_id string
volume float

playback_audio_volume_

change

 Audio volume adjusted during playback. player_name string
playback_module_version string
system_time date time
user_id string
volume float
audio_mute_setting_change User triggered audio mute/unmute switch. player_name string
playback_module_version string
system_time date time
user_id string
muted bool
playback_audio_mute_change Mute/unmute state switched during playback. player_name string
playback_module_version string
system_time date time
user_id string
muted bool

Updated