DocumentationAnalyticsMedia Analytics Guide

Player state parameters player-state-parameters

Last update: Tue Jun 06 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
  • Admin
  • Developer

This topic presents a list of player state data that Adobe collects via solution variables.

Table data description:

  • Implementation: Information on implementation values and requirements

    • Key - Variable, set either manually in your app, or automatically by the Adobe Media SDK.
    • Required - Indicates whether the parameter is required for basic video tracking.
    • Type - Specifies the type of the variable to be set, string or number.
    • Sent With - Indicates when the data is sent: Media Start is the analytics call sent on media start, Ad Start is the analytics call sent on ad start, and so on; the Close calls are the compiled analytics calls sent directly from the heartbeat server to the analytics server at the end of the media session, or the end of the ad, chapter, etc. The close calls are not available in network packet calls.
    • Min. SDK Version - Indicates which SDK version you would need to access the parameter.
    • Sample Value - Provides example of common variable usage.

  • Network Parameters: Displays the values that are passed to Adobe Analytics or Heartbeat servers. This column shows the names of the parameters that are seen in the network calls generated by Adobe Media SDKs.

  • Reporting: Information on how to view and analyze the video data.

    • Available - Indicates whether the data is available in reporting by default (Yes), or requires custom set-up (Custom)
    • Reserved Variable - Indicates whether the data is captured as an event, eVar, prop, or classification in a reserved variable.
    • Report Name - Name of Adobe Aanlytics report for variable
    • Context Data - Name of the Adobe Analytics context data passed to the reporting server and used in processing rules.
    • Data Feed - Column name for variable found in Clickstream or Live Stream data feeds
    • Audience Manager - Trait name found in Adobe Audience Manager
IMPORTANT
Do not change the classification names for any variables listed below that are described under Reporting/Reserved Variable as “classification”.
The media classifications are defined when a report suite is enabled for media tracking. From time to time, Adobe adds new properties, and, when this occurs, customers must re-enable their report suites to get access to the new media properties. During the update process Adobe determines whether the classifications are enabled by checking the names of the variables. If any of them is missing, Adobe adds the missing ones again.

Player State Properties player-state-properties

The player state tracking capabilities can be attached to an audio or video stream. Standardized player state tracking metrics are stored as solution variables. The standard states are: fullscreen, mute, closedCaptioning, pictureInPicture, and inFocus.

Full Screen Properties

Streams Impacted by Full Screen

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The number of streams impacted by Full Screen. This metric is set to 1 only if at least one Full Screen State occurred during a playback session.
    Important
    If this event is set, the only possible value is TRUE. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.fullscreen.set
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Streams Impacted by Full Screen
  • Context Data
    a.media.states.fullscreen.set
  • Data Feed
    videostatefullscreen
  • Audience Manager
    c_contextdata.a.media.states.fullscreen.set
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    fullScreen.playerStateSet
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.isSet

Full Screen Counts

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The number of times a Full Screen was displayed. This metric is set to 1 only if at least one Full Screen State occurred during a playback session.
    Important
    If this event is set, the count is equal to the number of times the video was in the Full Screen state. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.fullscreen.count
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Full Screen Count
  • Context Data
    a.media.states.fullscreen.count
  • Data Feed
    videostatefullscreencount
  • Audience Manager
    c_contextdata.media.states.fullscreen.count
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    fullScreen.playerStateCount
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.count

Full Screen Total Duration

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The length of time a Full Screen was displayed. This metric is set to 1 only if at least one Full Screen State occurred during a playback session.
    Important
    If this event is set, the time is equal to how long the video was in the Full Screen state. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.fullscreen.time
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Full Screen Total Duration
  • Context Data
    a.media.states.fullscreen.time
  • Data Feed
    videostatefullscreentime
  • Audience Manager
    c_contextdata.media.states.fullscreen.time
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    fullScreen.playerStateTime
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.time

Close Caption Properties

Streams Impacted by Closed Captioning

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The number of streams impacted by Closed Captioning. This metric is set to 1 only if at least one Closed Caption State occurred during a playback session.
    Important
    If this event is set, the only possible value is TRUE. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.closedcaptioning.set
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Streams Impacted by Closed Captioning
  • Context Data
    a.media.states.closedcaptioning.set
  • Data Feed
    videostateclosedcaptioning
  • Audience Manager
    c_contextdata.a.media.states.
    closedcaptioning.set
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    closeCaption.playerStateSet
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.isSet

Closed Captioning Counts

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The number of times Closed Captioning was displayed. This metric is set to 1 only if at least one Closed Captioning State occurred during a playback session.
    Important
    If this event is set, the count is equal to the number of times the video was in the Closed Captioning state. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.closedcaptioning.count
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Closed Captioning Count
  • Context Data
    a.media.states.closedcaptioning.count
  • Data Feed
    videostateclosedcaptioningcount
  • Audience Manager
    c_contextdata.media.states.
    closedcaptioning.count
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    closeCaption.playerStateCount
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.count

Closed Captioning Total Duration

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The length of time Closed Captioning was displayed. This metric is set to 1 only if at least one Full Screen State occurred during a playback session.
    Important
    If this event is set, the time is equal to how long the video was in the Closed Captioning state. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.closedcaptioning.time
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Closed Captioning Total Duration
  • Context Data
    a.media.states.closedcaptioning.time
  • Data Feed
    videostateclosedcaptioningtime
  • Audience Manager
    c_contextdata.media.states.
    closedcaptioning.time
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    closeCaption.playerStateTime
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.time

Mute Properties

Streams Impacted by Mute

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The number of streams impacted by Mute. This metric is set to 1 only if at least one Mute State occurred during a playback session.
    Important
    If this event is set, the only possible value is TRUE. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.mute.set
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Streams Impacted by Mute
  • Context Data
    a.media.states.mute.set
  • Data Feed
    videostatemute
  • Audience Manager
    c_contextdata.a.media.states.mute.set
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    mute.playerStateSet
  • < Reporting XDM Field Path:
    mediaReporting.playerStateData.isSet

Mute Counts

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The number of times Mute was displayed. This metric is set to 1 only if at least one Mute State occurred during a playback session.
    Important
    If this event is set, the count is equal to the number of times the video was in the Mute state. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.mute.count
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Mute Count
  • Context Data
    a.media.states.mute.count
  • Data Feed
    videostatemutecount
  • Audience Manager
    c_contextdata.media.states.mute.count
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.mute.playerStateCount
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.count

Mute Total Duration

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The length of time Mute was displayed. This metric is set to 1 only if at least one Mute State occurred during a playback session.
    Important
    If this event is set, the time is equal to how long the video was in the Mute state. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.mute.time
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Mute Total Duration
  • Context Data
    a.media.states.mute.time
  • Data Feed
    videostatemutetime
  • Audience Manager
    c_contextdata.media.states.mute.time
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    mute.playerStateTime
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.time

Picture in Picture Properties

Streams Impacted by Picture in Picture

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The number of streams impacted by Picture in Picture. This metric is set to 1 only if at least one Picture in Picture State occurred during a playback session.
    Important
    If this event is set, the only possible value is TRUE. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.pictureinpicture.set
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Streams Impacted by Picture in Picture
  • Context Data
    a.media.states.pictureinpicture.set
  • Data Feed
    videostatepictureinpicture
  • Audience Manager
    c_contextdata.a.media.states.
    pictureinpicture.set
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    pictureInPicture.playerStateSet
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.isSet

Picture in Picture Counts

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The number of times Picture in Picture was displayed. This metric is set to 1 only if at least one Picture in Picture State occurred during a playback session.
    Important
    If this event is set, the count is equal to the number of times the video was in the Picture in Picture state. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.pictureinpicture.count
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Picture in Picture Count
  • Context Data
    a.media.states.pictureinpicture.count
  • Data Feed
    videostatepictureinpicturecount
  • Audience Manager
    c_contextdata.media.states.
    pictureinpicture.count
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    pictureInPicture.playerStateCount
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.count

Picture in Picture Total Duration

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The length of time Picture in Picture was displayed. This metric is set to 1 only if at least one Picture in Picture State occurred during a playback session.
    Important
    If this event is set, the time is equal to how long the video was in the Picture in Picture state. If this event is not set, no value is sent…
  • Adobe Analytics
    a.media.states.pictureinpicture.time
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Picture in Picture Total Duration
  • Context Data
    a.media.states.pictureinpicture.time
  • Data Feed
    videostatepictureinpicturetime
  • Audience Manager
    c_contextdata.media.states.
    pictureinpicture.time
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    pictureInPicture.playerStateTime
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.time

In Focus Properties

Streams Impacted by In Focus

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The number of streams impacted by In Focus. This metric is set to 1 only if at least one In Focus State occurred during a playback session.
    Important
    If this event is set, the only possible value is TRUE. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.infocus.set
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    Streams Impacted by In Focus
  • Context Data
    a.media.states.infocus.set
  • Data Feed
    videostateinfocus
  • Audience Manager
    c_contextdata.a.media.states.infocus.set
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.inFocus.playerStateSet
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.isSet

In Focus Counts

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The number of times In Focus was displayed. This metric is set to 1 only if at least one In Focus State occurred during a playback session.
    Important
    If this event is set, the count is equal to the number of times the video was in the In Focus state. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.infocus.count
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    In Focus Count
  • Context Data
    a.media.states.infocus.count
  • Data Feed
    videostateinfocuscount
  • Audience Manager
    c_contextdata.media.states.infocus.count
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    inFocus.playerStateCount
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.count

In Focus Total Duration

Implementation
Network Parameters
Reporting
  • SDK Key
    Automatically set
  • API Key
    N/A
  • Required
    No
  • Type
    number
  • Sent with
    Media Close
  • Min. SDK Version
    3.0
  • Sample Value
    TRUE
  • Description
    The length of time In Focus was displayed. This metric is set to 1 only if at least one In Focus State occurred during a playback session.
    Important
    If this event is set, the time is equal to how long the video was in In Focus state. If this event is not set, no value is sent.
  • Adobe Analytics
    a.media.states.infocus.time
  • Heartbeat
    N/A
  • Available
    Yes
  • Reserved Variable
    event
  • Report Name
    In Focus Total Duration
  • Context Data
    a.media.states.infocus.time
  • Data Feed
    videostateinfocustime
  • Audience Manager
    c_contextdata.media.states.infocus.time
  • XDM Field Path:
    media.mediaTimed.primaryAssetViewDetails.
    inFocus.playerStateTime
  • Reporting XDM Field Path:
    mediaReporting.playerStateData.time
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb