Pattern

We invite you to read the article explaining how AV Insights works in order to understand the different events and their sequence.

You can also read the introduction to sending events.

 

Common standard properties

Property	Description	Type	Mandatory	Example
av_content_id	Content ID	string	Yes	'bc35'
av_session_id	Session ID	uuid*	Yes	'799d9f3b-7307-4113-a260-2e1371e35fe6'
av_content	Content Label	string		'Broadchurch 3.5'
av_content_type	Content Type	string		'TV Show'
av_content_duration	Content Duration (in milliseconds)	int		2760000
av_content_linked	Linked Content Label	string		'myLinkedContent'
av_publication_date	Publication Date (timestamp)	date		1501065673
av_content_genre	Content genre(s)	array of string		["Crime","Drama","Mystery"]
av_show	Show Label	string		'Broadchurch'
av_show_season	Show Season Label	string		'3'
av_episode_id	Episode ID	string		'5'
av_episode	Episode Label	string		'Episode #3.5'
av_channel	Channel Label	string		'ITV'
av_author	Author Name	string		'Chris Chibnall'
av_content_version	Content Version (full length, …)	string		'Full length'
av_duration_range	Duration range	string		'0-10'
av_broadcasting_type	Broadcasting Type	string		'Live'
av_broadcaster	Broadcaster Name	string		'ITV'
av_ad_type	Ad Type	string		'Mid-roll'
av_player	Player Label	string		'Main'
av_player_version	Player Version	string		'1.55'
av_player_position	Player Position	string		'Homepage'
av_auto_mode	Auto play mode	boolean		true
av_language	Media language	string		'fr'
av_subtitles	Subtitles	string		'en'
av_launch_reason	Launch reason	string		'auto'

* uuid type requires a version 4 (random) or version 5 (named) RFC 4122-compliant UUID, otherwise, our processing will generate one to replace the tagged value.

 

Events

 

av.heartbeat

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.buffer.heartbeat

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.rebuffer.heartbeat

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.play

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.buffer.start

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.rebuffer.start

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.start

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.resume

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.pause

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.stop

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.forward

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.backward

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.seek.start

Property	Description	Type	Mandatory	Example
av_duration	Time spent since previous event (ms)	int	Yes	5000
av_position	Current event cursor position	int	Yes	15000
av_previous_event	Previous event name	string	Yes	'av.heartbeat'
av_previous_position	Previous event cursor position	int	Yes	10000

 

av.ad.click

 

av.ad.skip

 

av.error

Property	Description	Type	Mandatory	Example
av_player_error	Error message	string		'Content not available'

 

av.display

 

av.close

 

av.volume

 

av.subtitle.on

 

av.subtitle.off

 

av.fullscreen.on

 

av.fullscreen.off

 

av.quality

 

av.speed

 

av.share

Last update: 21/10/2020