Events - Videos

Use this reference to interpret video-related events provided using the Experiences SDK onEventTriggered callback. It lists the video event structure and explains each event_action and its associated values.

Events have the structure outlined in the table that follows.

The tables in this document are wide. For ease of reading, view as HTML table or Google Sheet

Table structure

Field: The field name.
Field data: For fields with a variant type, this column specifies the name of the field data within the variant
Type: The type of the field or field data (if the field is a variant). Possible types include Number, Varchar, or Boolean.
Example: A sample value or instance of the field.
Description: An explanation of the field's meaning, if necessary.
From version: The SDK version from which this field started being reported.
web/mobile: Indicates whether the field reports data only when a viewer is on web ("web"), mobile ("mobile"), or both (no entry).
Options: Lists possible values for the field if it has a finite set of options.

Video events

Field	Field data	Type	Example	Description	Options
Video	video_session_id	Varchar	123-456-789	Video session unique ID
Video	video_id	Varchar	6643b5914e167da3d5a52b58	Video unique ID
Video	video_title	Varchar	Tottenham vs. Manchester City	Title of the video
Video	video_duration	Number	5321	Duration of the video in seconds
Video	video_session_trigger	Varchar	Widget	The origin for the entire session	Widget, Entry Point, Deeplink, Notification, Auto Play from Widget, Inline
Video	video_start_trigger	Varchar	Skip	The latest trigger that started the video	Widget, Entry Point, Deeplink, Notification, Auto Play from Widget, Inline, Skip, Viewing Mode Transition, App Foreground
Video	video_end_trigger	Varchar	Video Finished	The trigger that ended the video	Video Finished, Viewing Mode Transition, User Skip Next, User Skip Previous, Close Button, User Swipe To Dismiss, App Close, Inline, App Background
Video	video_current_time	Number	562	The exact time in the video (in seconds)
Video	next_video_id	Varchar	6643b5914e167da3d5a52b59	ID of the next video in the list	video_id
Video	cta_config	Varchar	`{"type": "Always Visible", "visible_duration": 10}`	CTA configuration	Always Visible, Visible After Overlay Hidden
Video	viewing_mode	Varchar	`{"current_mode": "Inline Preview", "next_mode": "Fullscreen"}`	Current and next viewing mode	Inline Preview, Inline Interactive, Fullscreen, Picture In Picture, Out Of Screen, Casting
Video	player_orientation	Varchar	Landscape	Video orientation	Portrait, Landscape
Video	device_orientation	Varchar	Portrait	Device orientation	Portrait, Landscape
Video	audio_state	Varchar	Mute	Indicates whether the video was muted or unmuted	Mute, Unmute
Video	seek_type	Varchar	Seek Bar	Indicates how the user initiated the seek	Seek Bar, Double Tap
Video	seek_total_time	Number	30	Total skipped time (seconds)
Video	seek_start_time	Number	120	Timestamp before seek started (seconds)
Video	seek_end_time	Number	150	Timestamp after seek ended (seconds)
Video	seek_direction	Varchar	Forward	Direction of the seek	Forward, Backward

In the table below, you'll find descriptions for each event_action, along with indicators showing whether the event_action reports a specific field (fields from the Video variant only).

Note, that each event_action reports not only the fields listed in the table below, but also all generic fields, as described on the events page.

Field	video_start	playback_initial_start	video_end	buffer_start	buffer_end	playback_pause	playback_play	forced_playback_pause	forced_playback_play	seek	like	unlike	share	cta_click	audio	cta_visible	cta_dismissed	viewing_mode_transition
video_session_id	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
video_id	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
video_title	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
video_duration	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
video_session_trigger	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
video_start_trigger	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
video_end_trigger			V
video_current_time	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
next_video_id			V
cta_config	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
viewing_mode	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
player_orientation	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
device_orientation	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
audio_state	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V	V
seek_type										V
seek_total_time										V
seek_start_time										V
seek_end_time										V
seek_direction										V

Updated 5 months ago

Did this page help you?