Event Logs

Common Properties

Property Name	Value Type	Values
playback_module_version	string	x.x.x
system_time	date time	unix timestamp
user_id	string	empty or user inputs
content_streaming_type	string	vod, live

Playback Events

Event Name	Event Definition	Property Name	Value Type	Value Definition
playback_began_player_loading	The time when player starts to load video	common properties	common properties	common properties
playback_began_player_startup_time	The time when player starts to load manifest	common properties	common properties	common properties
playback_began_video_startup_time	The time when the first frame displayed	common properties	common properties	common properties
playback_video_began	The time when video start to playback	common properties	common properties	common properties
		current_position	float	second(s)
playback_video_paused	The time when the playback has been paused	common properties	common properties	common properties
		current_position	float	second(s)
playback_video_buffering_began	The time when the buffering state began during playback	common properties	common properties	common properties
		current_position	float	second(s)
playback_video_buffering_ended	The time when the buffering state ended during playback	common properties	common properties	common properties
		current_position	float	second(s)
playback_video_ended	The time when the playback has been ended	common properties	common properties	common properties
		current_position	float	second(s)
playback_seeking_began	The start time of seeking during playback	common properties	common properties	common properties
		current_position	float	second(s)
playback_seeking_ended	The end time of seeking during playback	common properties	common properties	common properties
		current_position	float	second(s)
playback_error_occurred	The error code of player	common properties	common properties	common properties
		current_position	float	second(s)
		errorcode	string	error code definition
playback_ad_began	The time when AD began	common properties	common properties	common properties
		current_position	float	second(s)
playback_ad_ended	The time when AD began	common properties	common properties	common properties
		current_position	float	second(s)
playback_streaming_quality_change_download	Player switches profile (ABR)	common properties	common properties	common properties
		bitrate	uint	kbps
		width	uint
		height	uint
		bandwidth	uint
playback_streaming_quality_change_render	Buffered segments of previous profiles are all played, start playing switched profile	common properties	common properties	common properties
		bitrate	uint	kbps
		width	uint
		height	uint
		bandwidth	uint
playback_speed_change	The speed changed during playback	common properties	common properties	common properties
		playback_speed	float	0.5x, 1x, 2x, 4x...
		current_position	float	second(s)
playback_audio_track_change	Audio track changed time during playback	common properties	common properties	common properties
		lang	string	Language 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_subtitle_change	Subtitle changed time during playback	common properties	common properties	common properties
		lang	string	Language 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_change	Audio volume adjusted during playback	common properties	common properties	common properties
		volume	float	0-1.0
playback_audio_mute_change	Mute/unmute state switched during playback	common properties	common properties	common properties
		muted	bool

API Events

Event Name	Event Definition	Property Name	Value Type	Value Definition
play	Showed when play() API is called	common properties	common properties	common properties
		current_position	float	second(s)
pause	Showed when pause() API is called	common properties	common properties	common properties
		current_position	float	second(s)
seek	Showed when seek() API is called	common properties	common properties	common properties
rewind	Showed when rewind() API is called. Rewind the playback with specific seconds	common properties	common properties	common properties
forward	Showed when forward() API is called. Forward the playback with specific seconds	common properties	common properties	common properties
quality_setting_change	Showed when setQuality() API is called. Set the playback quality	common properties	common properties	common properties
		quality_name	string
		min_height	uint
		max_height	uint
		min_width	uint
		max_width	uint
		max_bitrate	uint	kbps
		min_bitrate	uint	kbps
		max_framerate	float
		min_framerate	float
speed_setting_change	Showed when setPlaybackSpeed() API is called. Set the playback speed	common properties	common properties	common properties
		playback_speed	float	0.5x, 1x, 2x, 4x...
		current_position	float	second(s)
audio_track_setting_change	Showed when setAudioTrack() API is called. Set the audio track	common properties	common properties	common properties
		lang	string	Language code follows the `RFC 5646` standard, utilizing the shortest `ISO 639` code. e.g., `en`, `ja`, or `zh`
subtitle_setting_change	Showed when setSubtitle() API is called. Set the subtitle track	common properties	common properties	common properties
		lang	string	Language code follows the `RFC 5646` standard, utilizing the shortest `ISO 639` code. e.g., `en`, `ja`, or `zh`
audio_volume_setting_change	Showed when setVolume() API is called. Adjust the audio volume	common properties	common properties	common properties
		volume	float	0-1.0
audio_mute_setting_change	Showed when mute()/unmute() API is called. Mute/ummute the audio volume	common properties	common properties	common properties
		muted	bool