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 TypeValue Definition
playback_began_player_loadingThe time when player starts to load videocommon propertiescommon propertiescommon properties
playback_began_player_startup_timeThe time when player starts to load manifestcommon propertiescommon propertiescommon properties
playback_began_video_startup_timeThe time when the first frame displayedcommon propertiescommon propertiescommon properties
playback_video_beganThe time when video start to playbackcommon propertiescommon propertiescommon properties
current_positionfloat
playback_video_pausedThe time when the playback has been pausedcommon propertiescommon propertiescommon properties
current_positionfloat
playback_video_buffering_beganThe time when the buffering state began during playbackcommon propertiescommon propertiescommon properties
current_positionfloat
playback_video_buffering_endedThe time when the buffering state ended during playbackcommon propertiescommon propertiescommon properties
current_positionfloat
playback_video_endedThe time when the playback has been endedcommon propertiescommon propertiescommon properties
current_positionfloat
playback_seeking_beganThe start time of seeking during playbackcommon propertiescommon propertiescommon properties
current_positionfloat
playback_seeking_endedThe end time of seeking during playbackcommon propertiescommon propertiescommon properties
current_positionfloat
playback_error_occurredThe error code of playercommon propertiescommon propertiescommon properties
current_positionfloat
errorcodestringerror code definition
playback_ad_beganThe time when AD begancommon propertiescommon propertiescommon properties
current_positionfloat
playback_ad_endedThe time when AD begancommon propertiescommon propertiescommon properties
current_positionfloat
playback_streaming_quality_change_downloadPlayer switches profile (ABR)common propertiescommon propertiescommon properties
bitrateintkbps
widthint
heightint
playback_streaming_quality_change_renderBuffered segments of previous profiles are all played, start playing switched profilecommon propertiescommon propertiescommon properties
bitrateintkbps
widthint
heightint
playback_speed_changeThe speed changed during playbackcommon propertiescommon propertiescommon properties
playback_speedfloat0.5x, 1x, 2x, 4x...
current_positionfloat
playback_audio_track_changeAudio track changed time during playbackcommon propertiescommon propertiescommon properties
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 playbackcommon propertiescommon propertiescommon properties
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 playbackcommon propertiescommon propertiescommon properties
volumefloat0-1.0
playback_audio_mute_changeMute/unmute state switched during playbackcommon propertiescommon propertiescommon properties
mutedbool

API Events

Event NameEvent DefinitionProperty NameValue TypeValue Definition
playShowed when play() API is calledcommon propertiescommon propertiescommon properties
current_positionfloat
pauseShowed when pause() API is calledcommon propertiescommon propertiescommon properties
current_positionfloat
seekShowed when seek() API is calledcommon propertiescommon propertiescommon properties
rewindShowed when rewind() API is called. Rewind the playback with specific secondscommon propertiescommon propertiescommon properties
forwardShowed when forward() API is called. Forward the playback with specific secondscommon propertiescommon propertiescommon properties
quality_setting_changeShowed when setQuality() API is called. Set the playback qualitycommon propertiescommon propertiescommon properties
quality_namestring
min_heightint
max_heightint
min_widthint
max_widthint
max_bitrateintkbps
min_bitrateintkbps
max_frameratefloat
min_frameratefloat
speed_setting_changeShowed when setPlaybackSpeed() API is called. Set the playback speedcommon propertiescommon propertiescommon properties
playback_speedfloat0.5x, 1x, 2x, 4x...
current_positionfloat
audio_track_setting_changeShowed when setAudioTrack() API is called. Set the audio trackcommon propertiescommon propertiescommon properties
langstringLanguage code follows the `RFC 5646` standard, utilizing the shortest `ISO 639` code. e.g., `en`, `ja`, or `zh`
subtitle_setting_changeShowed when setSubtitle() API is called. Set the subtitle trackcommon propertiescommon propertiescommon properties
langstringLanguage code follows the `RFC 5646` standard, utilizing the shortest `ISO 639` code. e.g., `en`, `ja`, or `zh`
audio_volume_setting_changeShowed when setVolume() API is called. Adjust the audio volumecommon propertiescommon propertiescommon properties
volumefloat0-1.0
audio_mute_setting_changeShowed when mute()/unmute() API is called. Mute/ummute the audio volumecommon propertiescommon propertiescommon properties
mutedbool