Logo

Data dictionaries

Media Player Data Dictionary

The Datazoom Media Player Data Dictionary specifically tracks a user's engagement with content played in a media player (i.e., when Media Type equals “content”), such as video or audio streams.

When a Datazoom Application Collector is configured with a Media Player Extension, the Datazoom SDK automatically makes these content-centric events, metadata, and fluxdata collectable.

Key Features:

  • Content-Focused: This dictionary tracks the primary content experience. Interactions with advertisements (pre-roll, mid-roll, post-roll) are tracked separately in the Ad Framework Data Dictionary.

  • Configurable: Usage of these data points can be managed dynamically via the Datazoom Console, allowing you to select or deselect specific metrics on demand.

  • Extensible: You can supplement these automatic data points with unlimited custom events and metadata using the Datazoom SDK APIs to capture player interactions specific to your implementation.

  • Additive: The Media Player Data Dictionary adds to the Application Data Dictionary, meaning application-level context is maintained alongside playback data.

Events

Audio Track Changed

audio_track_changed

Supported Collectors 10
Supported Media Types
Content
Notes
For the HTML5 collector, this is currently only supported by Safari.

Buffer End

buffer_end

Supported Collectors 21
Supported Media Types
Content
Notes
A buffering event has just completed. The player fires this event which returns a value of 1 to indicate that playback has resumed.

Buffer Start

buffer_start

Supported Collectors 21
Supported Media Types
Content
Notes
When the Buffer Start event is thrown and a value received, it is correlated to a specific playback time by comparing it to the playback length within the manifest. Once the Buffer End event has thrown, the delta between the two can be used to forensically analyze a series of chunks to determine the veracity of the content files. If the issue is corrupt chunks, a new encode can be produced.

Cast End

cast_end

Supported Collectors 15

Cast Start

cast_start

Supported Collectors 15

Cast Transfer

cast_transfer

Supported Collectors 9

Error

error

Supported Collectors 20
Supported Media Types
Content

Exit Fullscreen

exit_fullscreen

Supported Collectors 18

Fullscreen

fullscreen

Supported Collectors 18

Heartbeat

heartbeat

Supported Collectors 24
Notes
Configure heartbeats by visiting your collector configurations pages from the Collectors page, scroll to the Heartbeats setting in the Event Control section. By default, heartbeats fire every 60 seconds.

Media Loaded

media_loaded

Supported Collectors 22
Supported Media Types
Content

Media Object Request

media_object_request

Supported Collectors 7
Supported Media Types
Content
Notes
Primarily intended for open tracing via CMCD.

Media Request

media_request

Supported Collectors 24
Supported Media Types
Content
Notes
Identify problems that may be occurring in the video player which prevent successful playback after a user requests playback.

Milestone

milestone

Supported Collectors 20
Supported Media Types
Content
Notes
Configure milestones by visiting your collector configurations pages from the Collectors page, scroll to the Milestones setting in the Event Control section. By default, for content, milestones fire when the user passes 5%, 10%, 25%, 50%, 75%, 90%, & 95% point in the content playback timeline and, for ads, when the user passes 25%, 50%, & 75% point in the ad playback timeline.

Mute

mute

Supported Collectors 17

Pause

pause

Supported Collectors 24
Supported Media Types
Content

Playback Complete

playback_complete

Supported Collectors 23
Supported Media Types
Content

Playback Start

playback_start

Supported Collectors 24
Supported Media Types
Content

Player Ready

player_ready

Supported Collectors 24
Notes
“player has been initialized” independent of any media selection and when the player instance is handed over to us. A player can remain idle waiting for the next event which may or may not happen.

Playing

playing

Supported Collectors 23
Supported Media Types
Content

Qualified View

qualified_view

Supported Collectors 24
Supported Media Types
Content
Notes
Configure qualified view thresholds by visiting your collector configurations pages from the Collectors page, scroll to the Qualified View setting in the Event Control section. By default, for content, qualified view thresholds are 30 seconds and 60 seconds and, for ads, the qualified view threshold is 5 seconds.

Quality Change Request

quality_change_request

Supported Collectors 3
Notes
This is usually represented as a High, Med, Low setting that the user can select depending on their network capability. This event is different than Rendition Change which is fired automatically as video quality is adjusted dynamically as a response to actual network conditions.

Rendition Change

rendition_change

Supported Collectors 18
Supported Media Types
Content

Resize

resize

Supported Collectors 12

Resume

resume

Supported Collectors 22
Supported Media Types
Content

Seek End

seek_end

Supported Collectors 17
Supported Media Types
Content
Notes
This event includes attributes Seek Start Point & Seek End Point to mark the starting & ending points of a seek event.

Seek Start

seek_start

Supported Collectors 16
Supported Media Types
Content

Stall End

stall_end

Supported Collectors 21
Supported Media Types
Content

Stall Start

stall_start

Supported Collectors 21
Supported Media Types
Content

Stop

stop

Supported Collectors 22
Supported Media Types
Content
Notes
Notable condition where the `stop` events is not triggered: When playback reaches the end of the content timeline (i.e., the same condition for triggering `playback_complete`), the content session remains open, unaffected by the fact that playback has reached the end of content so if post-roll ads are played or play-head is rewinded afterward, the subsequent events belong to the same content session.

Subtitle Change

subtitle_change

Supported Collectors 12
Supported Media Types
Content

Unmute

unmute

Supported Collectors 17

Vendor Events All

vendor_events_all

Supported Collectors 1

Volume Change

volume_change

Supported Collectors 14

Metadata

Attributes

ABS Shift

abs_shift

Supported Collectors 19
Data type
string
Number Type
Not set
Required
true
Permitted Values
value list

Error Code

error_code

Supported Collectors 19
Data type
string
Number Type
Not set
Required
true

Error Message

error_msg

Supported Collectors 20
Data type
string
Number Type
Not set
Required
true

Heartbeat Count

heartbeat_count

Supported Collectors 24
Data type
number
Number Type
Int
Unit
count
Required
true

Inner Error

inner_error

Supported Collectors 9
Data type
string
Number Type
Not set
Required
true

Milestone Percent

milestone_percent

Supported Collectors 21
Data type
number
Number Type
Short
Unit
percentage
Required
true

Qualified View Trigger

qualified_view_sec

Supported Collectors 24
Data type
number
Number Type
Not set
Unit
seconds
Required
true

Seek End Point

seek_end_point_ms

Supported Collectors 15
Data type
number
Number Type
Not set
Unit
milliseconds
Required
true

Seek Start Point

seek_start_point_ms

Supported Collectors 15
Data type
number
Number Type
Not set
Unit
milliseconds
Required
true

Startup Duration - Content

startup_duration_content_ms

Supported Collectors 24
Data type
number
Number Type
Int
Unit
milliseconds
Required
true

Startup Duration - Total

startup_duration_total_ms

Supported Collectors 23
Data type
number
Number Type
Int
Unit
milliseconds
Required
true

Video

Asset ID

asset_id

Supported Collectors 12
Data type
string
Number Type
Not set

Description

description

Supported Collectors 8
Data type
string
Number Type
Not set

Duration

duration_sec

Supported Collectors 21
Data type
number
Number Type
Double
Unit
seconds

Frame Rate

frame_rate

Supported Collectors 3
Data type
number
Number Type
Short
Unit
fps

Media Tags

media_tags

Supported Collectors 1
Data type
array of string
Number Type
Not set

Media Type

media_type

Supported Collectors 24
Data type
string
Number Type
Not set
Required
true
Permitted Values
value list

Player Height

player_height

Supported Collectors 18
Data type
number
Number Type
Not set
Unit
pixels

Player Width

player_width

Supported Collectors 18
Data type
number
Number Type
Not set
Unit
pixels

Source

source

Supported Collectors 19
Data type
string
Number Type
Not set
Permitted Values
URL

Title

title

Supported Collectors 12
Data type
string
Number Type
Not set

Player

Autostart

autostart

Supported Collectors 16
Data type
bool
Number Type
Not set
Permitted Values
value list

Cast App Session ID

cast_app_session_id

Supported Collectors 9
Data type
string
Number Type
Not set
Permitted Values
UUID

Cast Content Session ID

cast_content_session_id

Supported Collectors 9
Data type
string
Number Type
Not set
Permitted Values
UUID

Casting

casting

Supported Collectors 14
Data type
bool
Number Type
Not set
Permitted Values
value list

Controls

controls

Supported Collectors 4
Data type
bool
Number Type
Not set
Permitted Values
value list

Default Muted

default_muted

Supported Collectors 19
Data type
bool
Number Type
Not set
Permitted Values
value list

Default Playback Rate

default_playback_rate

Supported Collectors 18
Data type
number
Number Type
Float
Unit
percentage

Fullscreen

fullscreen

Supported Collectors 17
Data type
bool
Number Type
Not set
Permitted Values
value list

Loop

loop

Supported Collectors 11
Data type
bool
Number Type
Not set
Permitted Values
value list

Muted

muted

Supported Collectors 18
Data type
bool
Number Type
Not set
Permitted Values
value list

Player Name

player_name

Supported Collectors 24
Data type
string
Number Type
Not set
Required
true

Player Version

player_version

Supported Collectors 16
Data type
string
Number Type
Not set

Preload

preload

Supported Collectors 9
Data type
string
Number Type
Not set
Permitted Values
value list

Ready State

ready_state

Supported Collectors 10
Data type
number
Number Type
Short
Permitted Values
value list

Streaming Protocol

streaming_protocol

Supported Collectors 16
Data type
string
Number Type
Not set
Permitted Values
value list

Streaming Type

streaming_type

Supported Collectors 16
Data type
string
Number Type
Not set
Permitted Values
value list

Subtitles

subtitles

Supported Collectors 17
Data type
bool
Number Type
Not set
Permitted Values
value list

CMCD

Buffer Length (CMCD)

bl

Supported Collectors 5
Data type
number
Number Type
Int
Unit
milliseconds

Buffer Starvation (CMCD)

bs

Supported Collectors 4
Data type
bool
Number Type
Not set
Permitted Values
value list

Content ID (CMCD)

cid

Supported Collectors 3
Data type
string
Number Type
Not set

Deadline (CMCD)

dl

Supported Collectors 3
Data type
number
Number Type
Int
Unit
milliseconds

Encoded Bitrate (CMCD)

br

Supported Collectors 5
Data type
number
Number Type
Int
Unit
kbps

Measured throughput (CMCD)

mtp

Supported Collectors 5
Data type
number
Number Type
Int
Unit
kbps

Next Object Request (CMCD)

nor

Supported Collectors 2
Data type
string
Number Type
Not set

Next Range Request (CMCD)

nrr

Supported Collectors 0
Data type
string
Number Type
Not set

Object Duration (CMCD)

d

Supported Collectors 4
Data type
number
Number Type
Int
Unit
milliseconds

Object Type (CMCD)

ot

Supported Collectors 5
Data type
string
Number Type
Not set
Permitted Values
value list

Playback Rate (CMCD)

pr

Supported Collectors 4
Data type
number
Number Type
Short

Request ID (CMCD)

rid

Supported Collectors 7
Data type
string
Number Type
Not set

Requested Maximum Throughput (CMCD)

rtp

Supported Collectors 3
Data type
number
Number Type
Int
Unit
kbps

Session ID (CMCD)

sid

Supported Collectors 7
Data type
string
Number Type
Not set

Startup (CMCD)

su

Supported Collectors 4
Data type
bool
Number Type
Not set
Permitted Values
value list

Stream Type (CMCD)

st

Supported Collectors 4
Data type
string
Number Type
Not set
Permitted Values
value list

Streaming Format (CMCD)

sf

Supported Collectors 5
Data type
string
Number Type
Not set
Permitted Values
value list

Top Bitrate (CMCD)

tb

Supported Collectors 5
Data type
number
Number Type
Int
Unit
kbps

Version (CMCD)

v

Supported Collectors 4
Data type
number
Number Type
Short

User

Content Session ID

content_session_id

Supported Collectors 24
Data type
string
Number Type
Not set
Required
true
Permitted Values
UUID

Dolby Millicast

Dolby Millicast Metadata All

vendor_metadata_all

Supported Collectors 1
Number Type
Not set
Required
true

Fluxdata

Audio Track

current_audio_track

Supported Collectors 11
Device Platforms
Browser,Console,DTV,Mobile

Bandwidth

bandwidth_kbps

Supported Collectors 16
Device Platforms
Browser,Console,DTV,Mobile

Buffer Duration (Content Session)

buffer_duration_ms

Supported Collectors 16
Device Platforms
Browser,Console,DTV,Mobile

Buffer Length

buffer_length_ms

Supported Collectors 16
Device Platforms
Browser,Console,DTV,Mobile,Server API

Buffer Start Recency (Content Session)

time_since_last_buffer_start_ms

Supported Collectors 16
Device Platforms
Browser,Console,DTV,Mobile

Content Buffer Duration (Content Session)

buffer_duration_content_ms

Supported Collectors 20
Device Platforms
Browser,Console,DTV,Mobile

Content Buffer Start Recency (Content Session)

time_since_last_buffer_start_content_ms

Supported Collectors 21
Device Platforms
Browser,Console,DTV,Mobile

Content Error Count (App Session)

num_errors_content

Supported Collectors 17
Device Platforms
Browser,Console,DTV,Mobile

Content Media Request Count (App Session)

num_requests_content

Supported Collectors 23
Device Platforms
Browser,Console,DTV,Mobile

Content Media Request Recency (Content Session)

time_since_request_content_ms

Supported Collectors 23
Device Platforms
Browser,Console,DTV,Mobile

Content Milestone Recency (Content Session)

time_since_last_milestone_content_ms

Supported Collectors 20
Device Platforms
Browser,Console,DTV,Mobile

Content Pause Duration (Content Session)

pause_duration_content_ms

Supported Collectors 23
Device Platforms
Browser,Console,DTV,Mobile

Content Playback Duration (Content Session)

playback_duration_content_ms

Supported Collectors 24
Device Platforms
Browser,Console,DTV,Mobile

Content Playback Start Count (App Session)

num_content_plays

Supported Collectors 23
Device Platforms
Browser,Console,DTV,Mobile

Content Playback Start Recency (Content Session)

time_since_started_content_ms

Supported Collectors 23
Device Platforms
Browser,Console,DTV,Mobile

Content Session Start Timestamp

content_session_start_ts_ms

Supported Collectors 23
Device Platforms
Browser,Console,DTV,Mobile

Content Stall Count (Content Session)

stall_count_content

Supported Collectors 20
Device Platforms
Browser,Console,DTV,Mobile

Content Stall Duration (Content Session)

stall_duration_content_ms

Supported Collectors 18
Device Platforms
Browser,Console,DTV,Mobile

Content Stall Start Recency (Content Session)

time_since_last_stall_start_content_ms

Supported Collectors 22
Device Platforms
Browser,Console,DTV,Mobile

Error Count (App Session)

num_errors

Supported Collectors 16
Device Platforms
Browser,Console,DTV,Mobile

Heartbeat Recency (Content Session)

time_since_last_heartbeat_ms

Supported Collectors 24
Device Platforms
Browser,Console,DTV,Mobile

Pause Duration (Content Session)

pause_duration_ms

Supported Collectors 23
Device Platforms
Browser,Console,DTV,Mobile

Pause Recency (Content Session)

time_since_last_pause_ms

Supported Collectors 23
Device Platforms
Browser,Console,DTV,Mobile

Playback Duration (Content Session)

playback_duration_ms

Supported Collectors 22
Device Platforms
Browser,Console,DTV,Mobile

Playback Rate

playback_rate

Supported Collectors 19
Device Platforms
Browser,Console,DTV,Mobile

Player State

player_state

Supported Collectors 24
Device Platforms
Browser,Console,DTV,Mobile
Permitted Values
value list

Player Viewable

player_viewable

Supported Collectors 15
Device Platforms
Browser,Console
Permitted Values
value list

Player Viewable Percent

player_viewable_percent

Supported Collectors 14
Device Platforms
Browser,Console

Playhead Position

playhead_position_sec

Supported Collectors 24
Device Platforms
Browser,Console,DTV,Mobile
Required
true

Playhead Position - Program Date Time

playhead_pdt_sec

Supported Collectors 9
Device Platforms
Browser,Console,DTV,Mobile

Promo Playback Duration (Content Session)

playback_duration_promo_ms

Supported Collectors 5
Device Platforms
Browser,Console,DTV,Mobile

Rendition Audio Bitrate

rendition_audio_bitrate_kbps

Supported Collectors 5
Device Platforms
Browser,Console,DTV,Mobile

Rendition Change Recency (Content Session)

time_since_last_rendition_change_ms

Supported Collectors 19
Device Platforms
Browser,Console,DTV,Mobile

Rendition Height

rendition_height

Supported Collectors 19
Device Platforms
Browser,Console,DTV,Mobile

Rendition Name

rendition_name

Supported Collectors 19
Device Platforms
Browser,Console,DTV,Mobile

Rendition Video Bitrate

rendition_video_bitrate_kbps

Supported Collectors 18
Device Platforms
Browser,Console,DTV,Mobile

Rendition Width

rendition_width

Supported Collectors 19
Device Platforms
Browser,Console,DTV,Mobile

Seek Start Recency (Content Session)

time_since_last_seek_start_ms

Supported Collectors 16
Device Platforms
Browser,Console,DTV,Mobile

Stall Count (Content Session)

stall_count

Supported Collectors 16
Device Platforms
Browser,Console,DTV,Mobile

Stall Duration (Content Session)

stall_duration_ms

Supported Collectors 20
Device Platforms
Browser,Console,DTV,Mobile

Stall Start Recency (Content Session)

time_since_last_stall_start_ms

Supported Collectors 22
Device Platforms
Browser,Console,DTV,Mobile

Subtitle Track

current_subtitles

Supported Collectors 15
Device Platforms
Browser,Console,DTV,Mobile

Volume

volume_level_percent

Supported Collectors 16
Device Platforms
Browser,Mobile