Media Player Data Dictionary

ABS Shift

The direction of the rendition change relative to the previous rendition. An attribute of the Rendition Change event.

Error Code

Error code emitted by the player

Error Message

Error message emitted by the player

Heartbeat Count

Count of Heartbeat events per content session.

Inner Error

Returns the error that occurred during Google IMA ad processing.

Milestone Percent

The point represented by the customer configurable percentage relative to the duration. Attribute of the Milestone event.

Qualified View Trigger

The point represented by the customer configurable duration of playback. Attribute of the Qualified View event.

Seek End Point

The point within in the content timeline at which the Seek End event is triggered.

Seek Start Point

The point within in the content timeline at which the Seek Start event is triggered.

Startup Duration - Content

The total time a user spent waiting for content to begin playback excluding any time related to requesting, loading or playing pre-roll ads.

Startup Duration - Total

The total time a user spent waiting for content to begin playback excluding any time spent viewing pre-roll ads.

Asset ID

Unique identifier of the content shown according to the player. This may be produced by the CMS or publishing system.

Description

Description of the content (e.g., provided by the CMS, VAST response, etc) emitted by the media player

Duration

The length of VOD content or ad media. Value is absent for live content.

Frame Rate

The frames per second of the video encoding.

Media Tags

A keyword or label assigned to an asset to describe its content and context

Media Type

Whether the event relates to an Ad or Content asset.

Player Height

Height of the display port.

Player Width

Width of the display port.

Source

The URL of the current media file

Title

The title of the content as reported by the media player.

Autostart

Returns whether the player is configured to autostart. Generally, when autostart is configured, video will start playing as soon as it is loaded; however, in some cases, browsers will prevent it.

Cast App Session ID

The App Session ID from a related casting device. -- When collected by the receiver, this value represents the original user app session that was started on the sender device. -- When collected by the sender, the value will represent the app session created on the receiver device.

Cast Content Session ID

The Content Session ID from a related casting device. -- When collected by the receiver, this value represents the content session on the sender device. -- When collected by the sender, this value represents the content session on the receiver device.

Casting

Is the player in casting mode?

Controls

Whether the controls are available for user interaction in the player. (i.e. play, pause, seek)

Default Muted

Identifies whether the audio/video should be muted by default

Default Playback Rate

The default speed of the audio / video playback in relation to normal playback time (e.g., .5x, 1x, 1.5x, 2x).

Fullscreen

Whether the player is in fullscreen mode or not.

Loop

Whether the media player is configured to start over again when the content finishes.

Muted

Whether the player is muted or if the device volume is muted and observable.

Player Name

The name of the media player.

Player Version

The version of the media player.

Preload

The way in which the media player is configured to preload the content. -- "none": the media should not be preloaded; -- "metadata": only metadata (e.g. length) is fetched; -- "auto": the whole video file can be downloaded, even if the user is not expected to use it.

Ready State

Identifies the current ready state of the audio/video

Streaming Protocol

The streaming protocol used to deliver the content; if not collectable, then it is the container type.

Streaming Type

Whether the content is Live, VOD or DVR as reported by the media player.

Subtitles

Whether subtitles are currently enabled.

Buffer Length (CMCD)

The buffer length associated with the media object being requested.

Buffer Starvation (CMCD)

Key is included without a value if the buffer was starved at some point between the prior request and this object request, resulting in the player being in a rebuffering state and the video or audio playback being stalled. This key MUST NOT be sent if the buffer was not starved since the prior request. If the object type ‘ot’ key is sent along with this key, then the ‘bs’ key refers to the buffer associated with the particular object type. If no object type is communicated, then the buffer state applies to the current session.

Content ID (CMCD)

A unique string identifying the current content.

Deadline (CMCD)

Deadline from the request time until the first sample of this Segment/Object needs to be available in order to not create a buffer underrun or any other playback problems.

Encoded Bitrate (CMCD)

The encoded bitrate of the audio or video object being requested. This may not be known precisely by the player; however, it MAY be estimated based upon playlist/manifest declarations. If the playlist declares both peak and average bitrate values, the peak value should be transmitted.

Measured throughput (CMCD)

The throughput between client and server, as measured by the client and MUST be rounded to the nearest 100 kbps. This value, however derived, SHOULD be the value that the client is using to make its next Adaptive Bitrate switching decision. If the client is connected to multiple servers concurrently, it must take care to report only the throughput measured against the receiving server. If the client has multiple concurrent connections to the server, then the intent is that this value communicates the aggregate throughput the client sees across all those connections.

Next Object Request (CMCD)

Relative path of the next object to be requested. This can be used to trigger pre-fetching by the CDN. This MUST be a path relative to the current request. This string MUST be URLEncoded [5]. The client SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a pre-fetch to take place.

Object Duration (CMCD)

The playback duration in milliseconds of the object being requested. If a partial segment is being requested, then this value MUST indicate the playback duration of that part and not that of its parent segment. This value can be an approximation of the estimated duration if the explicit value is not known.

Object Type (CMCD)

The media type of the current object being requested: m = text file, such as a manifest or playlist a = audio only v = video only av = muxed audio and video i = init segment c = caption or subtitle tt = ISOBMFF timed text track k = cryptographic key, license or certificate. o = other If the object type being requested is unknown, then this key MUST NOT be used.

Playback Rate (CMCD)

1 if real-time, 2 if double speed, 0 if not playing. SHOULD only be sent if not equal to 1.

Request ID (CMCD)

A unique identifier that is established to track an individual media object request made from the client to a CDN.

Requested Maximum Throughput (CMCD)

The requested maximum throughput that the client considers sufficient for delivery of the asset. Values MUST be rounded to the nearest 100kbps. For example, a client would indicate that the current segment, encoded at 2Mbps, is to be delivered at no more than 10Mbps, by using rtp=10000. Note: This can benefit clients by preventing buffer saturation through over-delivery and can also deliver a community benefit through fair-share delivery. The concept is that each client receives the throughput necessary for great performance, but no more. The CDN may not support the rtp feature.

Session ID (CMCD)

A GUID identifying the current playback session. A playback session typically ties together segments belonging to a single media asset. Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID specification [7].

Startup (CMCD)

Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be rendering when this request is made. This key MUST not be sent if it is FALSE.

Stream Type (CMCD)

Describes if the content being streamed is Live or On Demand.

Streaming Format (CMCD)

The streaming format that defines the current request. d = MPEG DASH h = HTTP Live Streaming (HLS) s = Smooth Streaming o = other If the streaming format being requested is unknown, then this key MUST NOT be used.

Top Bitrate (CMCD)

The highest bitrate rendition in the manifest or playlist that the client is allowed to play, given current codec, licensing and sizing constraints.

Version (CMCD)

The version of the CMCD specification used for interpreting the defined key names and values.

Content Session ID

A unique id for the current video playback session.

Dolby Millicast Metadata All

Dolby Millicast Metadata All