Playback Events

The tables below outline all kinds of player callback events. You can refer to corresponding articles to learn how to integrate the Playback Event callback function.

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

API Callback Events

Event Name	Event Definition	Property Name	Value Type	Notes
play	User clicks the play button.	common properties	as Common Properties table
		current_position	float
pause	User clicks the pause button.	common properties	as Common Properties table
		current_position	float
seek	User dragging on the seekbar.	common properties	as Common Properties table
rewind	User clicks the rewind icon.	common properties	as Common Properties table
forward	User clicks the forward icon.	common properties	as Common Properties table
quality_setting_change	User switched profile.	common properties	as Common Properties table
		quality_name	string
		min_height	int
		max_height	int
		min_width	int
		max_width	int
		max_bitrate	int (kbps)
		min_bitrate	int (kbps)
		max_framerate	float
		min_framerate	float
speed_setting_change	User changes the speed.	common properties	as Common Properties table
		playback_speed	float	0.5x, 1x, 2x, 4x...
		current_position	float
audio_track_setting_change	User changes the audio tracks.	common properties	as Common Properties table
		lang	string	Language code follows the RFC 5646 standard, utilizing the shortest ISO 639 code. e.g., en, ja, or zh.
subtitle_setting_change	User changes the subtitle tracks.	common properties	as Common Properties table
		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	User adjust the audio volume.	common properties	as Common Properties table
		volume	float	0-1.0
audio_mute_setting_change	User triggered audio mute/unmute switch.	common properties	as Common Properties table
		muted	bool

Playback Callback Events

Event Name	Event Definition	Property Name	Value Type	Notes
playback_began_player_loading	The time when player starts to load video.	common properties	as Common Properties table
playback_began_player_startup_time	The time when player starts to load manifest.	common properties	as Common Properties table
playback_began_video_startup_time	The time when the first frame displayed.	common properties	as Common Properties table
playback_video_began	The time when video start to playback.	common properties	as Common Properties table
		current_position	float
playback_video_paused	The time when the playback has been paused.	common properties	as Common Properties table
		current_position	float
playback_video_buffering_began	The time when the buffering state began during playback.	common properties	as Common Properties table
		current_position	float
playback_video_buffering_ended	The time when the buffering state ended during playback.	common properties	as Common Properties table
		current_position	float
playback_video_ended	The time when the playback has been ended.	common properties	as Common Properties table
		current_position	float
playback_seeking_began	The start time of seeking during playback.	common properties	as Common Properties table
		current_position	float
playback_seeking_ended	The end time of seeking during playback.	common properties	as Common Properties table
		current_position	float
playback_error_occurred	The error code of player. Each platform should have different error codes.	common properties	as Common Properties table
		current_position	float
		errorcode	string
playback_ad_began	The time when AD began.	common properties	as Common Properties table
		current_position	float
playback_ad_ended	The time when AD ended.	common properties	as Common Properties table
		current_position	float
playback_streaming_quality_change_download	Player switches profile (ABR).	common properties	as Common Properties table
		bitrate	int (kbps)
		framerate	float	Web only
		width	int
		height	int
		bandwidth	xxx	iOS only
playback_streaming_quality_change_render	Buffered segments of previous profiles are all played, start playing switched profile.	as Common Properties table
		bitrate	int (kbps)
		framerate	float	Web only
		width	int
		height	int
		bandwidth	xxx	iOS only
playback_speed_change	The speed changed during playback.	common properties	as Common Properties table
		playback_speed	float	0.5x, 1x, 2x, 4x...
		current_position	float
playback_audio_track_change	Audio track changed time during playback.	common properties	as Common Properties table
		lang	string	Language code follows the RFC 5646 standard, utilizing the shortest ISO 639 code. e.g., en, ja, or zh.
playback_subtitle_change	Subtitle changed time during playback.	common properties	as Common Properties table
		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	as Common Properties table
		volume	float	0-1.0
playback_audio_mute_change	Mute/unmute state switched during playback.	common properties	as Common Properties table
		muted	bool