Skip to main content

Event Logs

Common Properties

Property NameValue TypeValues
playback_module_versionstringx.x.x
system_timedate timeunix timestamp
user_idstringempty or user inputs
content_streaming_typestringRESOURCE_TYPE_VOD_EVENT, RESOURCE_TYPE_LIVE_EVENT

Playback Events

Event NameEvent DefinitionProperty NameValue TypeNotes
playback_began_player_loadingThe time when player starts to load video.common propertiesas Common Properties table
playback_began_player_startup_timeThe time when player starts to load manifest.common propertiesas Common Properties table
playback_began_video_startup_timeThe time when the first frame displayed.common propertiesas Common Properties table
playback_video_beganThe time when video start to playback.common propertiesas Common Properties table
current_positionfloat
playback_video_pausedThe time when the playback has been paused.common propertiesas Common Properties table
current_positionfloat
playback_video_buffering_beganThe time when the buffering state began during playback.common propertiesas Common Properties table
current_positionfloat
playback_video_buffering_endedThe time when the buffering state ended during playback.common propertiesas Common Properties table
current_positionfloat
playback_video_endedThe time when the playback has been ended.common propertiesas Common Properties table
current_positionfloat
playback_seeking_beganThe start time of seeking during playback.common propertiesas Common Properties table
current_positionfloat
playback_seeking_endedThe end time of seeking during playback.common propertiesas Common Properties table
current_positionfloat
playback_error_occurredThe error code of player. Each platform should have different error codes.common propertiesas Common Properties table
current_positionfloat
errorcodestring
playback_ad_beganThe time when AD began.common propertiesas Common Properties table
current_positionfloat
playback_ad_endedThe time when AD ended.common propertiesas Common Properties table
current_positionfloat
playback_streaming_quality_change_downloadPlayer switches profile (ABR).common propertiesas Common Properties table
bitrateint (kbps)
frameratefloatWeb only
widthint
heightint
bandwidthxxxiOS only
playback_streaming_quality_change_renderBuffered segments of previous profiles are all played, start playing switched profile.as Common Properties table
bitrateint (kbps)
frameratefloatWeb only
widthint
heightint
bandwidthxxxiOS only
playback_speed_changeThe speed changed during playback.common propertiesas Common Properties table
playback_speedfloat0.5x, 1x, 2x, 4x...
current_positionfloat
playback_audio_track_changeAudio track changed time during playback.common propertiesas Common Properties table
langstringLanguage code follows the RFC 5646 standard, utilizing the shortest ISO 639 code. e.g., en, ja, or zh.
playback_subtitle_changeSubtitle changed time during playback.common propertiesas Common Properties table
langstringLanguage code follows the RFC 5646 standard, utilizing the shortest ISO 639 code. e.g., en, ja, or zh. Use off to indicate that the subtitle is turned off.
playback_audio_volume_changeAudio volume adjusted during playback.common propertiesas Common Properties table
volumefloat0-1.0
playback_audio_mute_changeMute/unmute state switched during playback.common propertiesas Common Properties table
mutedbool

API Events

Event NameEvent DefinitionProperty NameValue TypeNotes
playUser clicks the play button.common propertiesas Common Properties table
current_positionfloat
pauseUser clicks the pause button.common propertiesas Common Properties table
current_positionfloat
seekUser dragging on the seekbar.common propertiesas Common Properties table
rewindUser clicks the rewind icon.common propertiesas Common Properties table
forwardUser clicks the forward icon.common propertiesas Common Properties table
quality_setting_changeUser switched profile.common propertiesas Common Properties table
quality_namestring
min_heightint
max_heightint
min_widthint
max_widthint
max_bitrateint (kbps)
min_bitrateint (kbps)
max_frameratefloat
min_frameratefloat
speed_setting_changeUser changes the speed.common propertiesas Common Properties table
playback_speedfloat0.5x, 1x, 2x, 4x...
current_positionfloat
audio_track_setting_changeUser changes the audio tracks.common propertiesas Common Properties table
langstringLanguage code follows the RFC 5646 standard, utilizing the shortest ISO 639 code. e.g., en, ja, or zh.
subtitle_setting_changeUser changes the subtitle tracks.common propertiesas Common Properties table
langstringLanguage code follows the RFC 5646 standard, utilizing the shortest ISO 639 code. e.g., en, ja, or zh.
audio_volume_setting_changeUser adjust the audio volume.common propertiesas Common Properties table
volumefloat0-1.0
audio_mute_setting_changeUser triggered audio mute/unmute switch.common propertiesas Common Properties table
mutedbool