Quality parameters

This topic presents a list of quality of experience (QoE/QoS) data, including context data values, that Adobe collects via solution variables.

This section contains the following information:

Table data description:

  • Label: The name of the parameter.
  • 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: Initiate is the analytics call sent on video start, Ad Start is the analytics call sent on ad start, Chapter Start is the analytics call sent on chapter start, and Close is the compiled analytics call sent directly from the heartbeat server to the analytics server at the end of the media session, or the end of the ad. 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

Quality Metadata

Label

Implementation

Network Parameters

Reporting

Average Bitrate

  • SDK Key: bitrate*
  • API Key: media.qoe.bitrate
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 800-899
  • Adobe Analytics:

    a.media.qoe.bitrateAverageBucket

  • Heartbeat:

    l:stream:bitrate

  • Available: Yes
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name: Average Bitrate
  • Context Data: a.media.qoe.bitrateAverageBucket
  • Data Feed: videoqoebitrateaverageevar
  • Audience Manager: c_contextdata.a.media.qoe.bitrateAverageBucket

The average bitrate (in kbps). The value is predefined buckets at 100kbps intervals. The Average Bitrate is computed as a weighted average of all bitrate values related to the play duration that occurred during a playback session

* createQoSObject(bitrate, startupTime, fps, droppedFrames)

Time to Start

  • SDK Key: startupTime*
  • API Key: media.qoe.timeToStart
  • Required: No
  • Type: number
  • Sent with: Media Start, Media Close
  • Min. SDK Version: Any
  • Sample value: 30,000 (milliseconds)
  • Adobe Analytics:

    a.media.qoe.timeToStart

  • Heartbeat:

    l:stream:startup_time

  • Available: Yes
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name: Time to Start
  • Context Data: a.media.qoe.timeToStart
  • Data Feed: videoqoetimetostartevar
  • Audience Manager: c_contextdata.a.media.qoe.timeToStart

This value defaults to zero if you do not set it through the QoSObject. You set this value in milliseconds.

The value will be displayed in the time format (HH:MM:SS) in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.

* createQoSObject(bitrate, startupTime, fps, droppedFrames)

FPS

  • SDK Key: fps*
  • API Key: media.qoe.framesPerSecond
  • Required: No
  • Type: number
  • Sent with: Media Start, Media Close
  • Min. SDK Version: Any
  • Sample value: 24
  • Adobe Analytics:

  • Heartbeat:

    l:stream:fps

  • Available: No
  • Reserved Variable: N/A
  • Report Name: N/A
  • Context Data:
  • Data Feed:
  • Audience Manager:

The current value of the stream frame-rate (in frames per second).

* createQoSObject(bitrate, startupTime, fps, droppedFrames)

Dropped Frames

  • SDK Key: droppedFrames
  • API Key: media.qoe.droppedFrames
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 3
  • Adobe Analytics:

    a.media.qoe.droppedFrameCount

  • Heartbeat:

    l:stream:dropped_frames

  • Available: Yes
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name: Dropped Frames
  • Context Data: a.media.qoe.droppedFrameCount
  • Data Feed: videoqoedroppedframecountevar
  • Audience Manager: c_contextdata.a.media.qoe.droppedFrameCount

The number of dropped frames (Integer). This value is computed as a sum of all frames dropped during a playback session.

This value is taken from the last value of l:stream:dropped_frames.

* createQoSObject(bitrate, startupTime, fps, droppedFrames)

Buffer Events

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 2
  • Adobe Analytics:

    a.media.qoe.bufferCount

  • Heartbeat:

    s:event:type=buffer

  • Available: Yes
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name: Buffer Events
  • Context Data: a.media.qoe.bufferCount
  • Data Feed: videoqoebuffercountevar
  • Audience Manager: c_contextdata.a.media.qoe.bufferCount

The number of buffer events. This metric is computed as a count of the different buffer states that occurred during a playback session.

This is a count of how many times the player enters a buffer state from other states, e.g., playing or pausing.

Total Buffer Duration

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version:
  • Sample value: 30 (Seconds)
  • Adobe Analytics:

    a.media.qoe.bufferTime

  • Heartbeat:

    l:event:duration

  • Available: Yes
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name: Total Buffer Duration
  • Context Data: a.media.qoe.bufferTime
  • Data Feed: videoqoebuffertimeevar
  • Audience Manager: c_contextdata.a.media.qoe.bufferTime

Release Date: 09/13/18

The total amount of time, in seconds, spent buffering. This value is computed as a sum of all buffer events durations that occurred during a playback session.

The value will be displayed in the time format (HH:MM:SS) in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.

Bitrate Changes

  • SDK Key:
  • API Key: media.qoe.bitrateChange
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 3
  • Adobe Analytics:

    a.media.qoe.bitrateChangeCount

  • Heartbeat:

    s:event:type=bitrate_change

  • Available: Yes
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name: Bitrate Changes
  • Context Data: a.media.qoe.bitrateChangeCount
  • Data Feed: videoqoebitratechangecountevar
  • Audience Manager: c_contextdata.a.media.qoe.bitrateChangeCount

The number of bitrate changes (Integer). This value is computed as a sum of all bitrate change events that occurred during a playback session.

Errors / Error Events

  • SDK Key:
  • API Key:
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 1
  • Adobe Analytics:

    a.media.qoe.errorCount

  • Heartbeat:

    s:event:type=error

  • Available: Yes
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name: Errors
  • Context Data: a.media.qoe.errorCount
  • Data Feed: videoqoeerrorcountevar
  • Audience Manager: c_contextdata.a.media.qoe.errorCount

The number of errors occurred (Integer). This value is computed as a sum of all error events that occurred during a playback session.

Player SDK Error IDs
  • SDK Key: Automatically set
  • API Key:
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value:
  • Adobe Analytics:

    a.media.qoe.playerSdkErrors

  • Heartbeat:

    s:event:type=error

  • Available: Yes
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name: Errors
  • Context Data: a.media.qoe.playerSdkErrors
  • Data Feed:

    videoqoeplayersdkerrors

  • Audience Manager: c_contextdata.a.media.qoe.playerSdkErrors
The unique error IDs generated by the player SDK. Customers must provide the error codes/ids at implementation time via provided error APIs.
External Error IDs
  • SDK Key: Automatically set
  • API Key:
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value:
  • Adobe Analytics:

    a.media.qoe.externalErrors

  • Heartbeat:

    s:event:type=error

  • Available: Yes
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name: Errors
  • Context Data: a.media.qoe.externalErrors
  • Data Feed:

    videoqoeextneralerrors

  • Audience Manager: c_contextdata.a.media.qoe.externalErrors
The unique error IDs from any external source, e.g., CDN errors. Customers must provide the error codes/ids at implementation time via provided error APIs.
Media SDK Error IDs
  • SDK Key: Automatically set
  • API Key:
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value:
  • Adobe Analytics:

    a.media.qoe.mediaSdkErrors

  • Heartbeat:

    s:event:type=error

  • Available: Yes
  • Reserved Variable: eVar
  • Expiration: On HIT
  • Report Name: Errors
  • Context Data: a.media.qoe.mediaSdkErrors
  • Data Feed: mediaqoeexternalerrors
  • Audience Manager: c_contextdata.a.media.qoe.mediaSdkErrors
The unique error IDs generated by Media SDK during playback.

Session End

  • SDK Key: Automatically set
  • API Key:
  • Type: string
  • Sent with: Media Close
  • Min. SDK Version: 2.1
  • Sample value: end
  • Adobe Analytics: N/A
  • Heartbeats:

    s:event:type=end

  • Available: Use custom processing rule
  • Reserved Variable: event
  • Report Name: N/A
  • Context Data:
  • Data Feed:
  • Audience Manager:

The end event means that the SDK is sending a close call to the backend. On the receipt of this event, the backend will close the session for this video, and do no further processing.

Quality Metrics

Label

Implementation

Network Parameters

Reporting

Time To Start

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 30,000 (milliseconds)
  • Adobe Analytics:

    a.media.qoe.timeToStart

  • Heartbeat:

    l:stream:startup_time

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Time to Start
  • Context Data: a.media.qoe.timeToStart
  • Data Feed: videoqoetimetostart
  • Audience Manager: c_contextdata.a.media.qoe.timeToStart

Release Date: 09/13/18

This value defaults to zero if you do not set it through the QoSObject. You set this value in milliseconds.

The value will be displayed in the time format (HH:MM:SS) in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.

* createQoSObject(bitrate, startupTime, fps, droppedFrames)

Buffer Events

  • SDK Key: startupTime*
  • API Key: N/A
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 2
  • Adobe Analytics:

    a.media.qoe.bufferCount

  • Heartbeat:

    s:event:type=buffer

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Buffer Events
  • Context Data: a.media.qoe.bufferCount
  • Data Feed: videoqoebuffercount
  • Audience Manager: c_contextdata.a.media.qoe.bufferCount

The number of buffer events (Integer). This metric is computed as a count of buffer events that occurred during a playback session.

Total Buffer Duration

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 15
  • Adobe Analytics:

    a.media.qoe.bufferTime

  • Heartbeat:

    l:event:duration

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Total Buffer Duration
  • Context Data: a.media.qoe.bufferTime
  • Data Feed: videoqoebuffertime
  • Audience Manager: c_contextdata.a.media.qoe.bufferTime

Release Date: 09/13/18

The total amount of time spent buffering (seconds; integer). This value is computed as a sum of all buffer events durations that occurred during a playback session.

The value will be displayed in the time format (HH:MM:SS) in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.

Bitrate Changes

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: Event
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: "3" (Integer)
  • Adobe Analytics:

    a.media.qoe.bitrateChangeCount

  • Heartbeat:

    s:event:type=bitrate_change

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Bitrate Changes
  • Context Data: a.media.qoe.bitrateChangeCount
  • Data Feed: videoqoebitratechangecount
  • Audience Manager: c_contextdata.a.media.qoe.bitrateChangeCount

The number of bitrate changes. This value is computed as a sum of all bitrate change events that occurred during a playback session.

Errors

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 1
  • Adobe Analytics:

    a.media.qoe.errorCount

  • Heartbeat:

    s:event:type=error

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Error Events
  • Context Data: a.media.qoe.errorCount
  • Data Feed: videoqoeerrorcount
  • Audience Manager: c_contextdata.a.media.qoe.errorCount

The number of errors occurred (Integer). This value is computed as a sum of all error events that occurred during a playback session.

Dropped Frames

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 1
  • Adobe Analytics:

    a.media.qoe.droppedFrameCount

  • Heartbeat:

    l:stream:dropped_frames

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Dropped Frames
  • Context Data: a.media.qoe.droppedFrameCount
  • Data Feed: videoqoedroppedframecount
  • Audience Manager: c_contextdata.a.media.qoe.droppedFrameCount

The number of dropped frames (Integer). This value is computed as a sum of all frames dropped during a playback session.

Drops Before Start

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: string
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: TRUE
  • Adobe Analytics:

    a.media.qoe.dropBeforeStart

  • Heartbeat:

    s:event:type=aa_start

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Drops before Start
  • Context Data: a.media.qoe.dropBeforeStart
  • Data Feed: videoqoedropbeforestart
  • Audience Manager: c_contextdata.a.media.qoe.dropBeforeStart

The number of times a user quit the video before its start. This metric is set to 1 only if no content was rendered, regardless of ads.

Important: If this event is set, the only possible value is TRUE. If this event is not set, no value is sent.

Buffer Impacted Streams

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: string
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: TRUE
  • Adobe Analytics:

    a.media.qoe.buffer

  • Heartbeat:

    s:event:type=buffer

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Buffer Impacted Streams
  • Context Data: a.media.qoe.buffer
  • Data Feed: videoqoebuffer
  • Audience Manager: c_contextdata.a.media.qoe.buffer

The number of streams impacted by buffering. This metric is set to 1 only if at least one buffer event 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.

Bitrate Change Impacted Streams

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: string
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: TRUE
  • Adobe Analytics:

    a.media.qoe.bitrateChange

  • Heartbeat:

    s:event:type=bitrate_change

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Buffer Change Impacted Streams
  • Context Data: a.media.qoe.bitrateChange
  • Data Feed: videoqoebitratechange
  • Audience Manager: c_contextdata.a.media.qoe.bitrateChange

The number of streams in which bitrate changes occurred. This metric is set to 1 only if at least one bitrate change event 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.

Average Bitrate

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: 3200
  • Adobe Analytics:

    a.media.qoe.bitrateAverage

  • Heartbeat:

    l:stream:bitrate

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Average Bitrate
  • Context Data: a.media.qoe.bitrateAverage
  • Data Feed: videoqoebitrateaverage
  • Audience Manager: c_contextdata.a.media.qoe.bitrateAverage

The average bitrate (in kbps, integer). This metric is computed as a weighted average of all bitrate values related to the play duration that occurred during a playback session.

Error Impacted Streams

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: string
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: TRUE
  • Adobe Analytics:

    a.media.qoe.error

  • Heartbeat:

    s:event:type=error

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Error Impacted Streams
  • Context Data: a.media.qoe.error
  • Data Feed: videoqoeerror
  • Audience Manager: c_contextdata.a.media.qoe.error

The number of streams in which bitrate changes occurred. This metric is set to 1 only if at least one bitrate change event 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.

Dropped Frame Impacted Streams

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: string
  • Sent with: Media Close
  • Min. SDK Version: Any
  • Sample value: TRUE
  • Adobe Analytics:

    a.media.qoe.droppedFrames

  • Heartbeat:

    l:stream:dropped_frames

  • Available: Yes
  • Reserved Variable: event
  • Report Name: Dropped Frame Impacted Streams
  • Context Data: a.media.qoe.droppedFrames
  • Data Feed: videoqoedroppedframes
  • Audience Manager: c_contextdata.a.media.qoe.droppedFrames

The number of streams in which frames were dropped. This metric is set to 1 only if at least one frame was dropped 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.

Stalling Impacted Streams

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: string
  • Sent with: Media Close
  • Min. SDK Version: 1.5+
  • Sample value: TRUE
  • Adobe Analytics:

    a.media.qoe.stall

  • Heartbeat:

    s:event:type=stall

  • Available: Use custom processing rule
  • Reserved Variable: event
  • Report Name:
  • Data Feed: N/A
  • Context Data: a.media.qoe.stall
  • Audience Manager: c_contextdata.a.media.qoe.stall

The number of streams in which a stalled event occurred. This metric is set to 1 only if at least one stall occurred during playback. Customers will have to create their own processing rules to have the value available for reporting.

Important: If this event is set, the only possible value is TRUE. If this event is not set, no value is sent.

Stalling Events

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: string
  • Sent with: Media Close
  • Min. SDK Version: 1.5+
  • Sample value: "3" (Integer)
  • Adobe Analytics:

    a.media.qoe.stallCount

  • Heartbeat:

    s:event:type=stall

  • Available: Use custom processing rule
  • Reserved Variable: event
  • Report Name:
  • Context Data: a.media.qoe.stallCount
  • Data Feed: N/A
  • Audience Manager: c_contextdata.a.media.qoe.stallCount

The number of times the playback was stalled during a playback session. Customers will have to create their own processing rules to have the value available for reporting.

Total Stalling Duration

  • SDK Key: Automatically set
  • API Key: N/A
  • Required: No
  • Type: number
  • Sent with: Media Close
  • Min. SDK Version: 1.5+
  • Sample value: 12
  • Adobe Analytics:

    a.media.qoe.stallTime

  • Heartbeat:

    s:event:type=stall

  • Available: Use custom processing rule
  • Reserved Variable: event
  • Report Name:
  • Context Data: a.media.qoe.stallTime
  • Data Feed: N/A
  • Audience Manager: c_contextdata.a.media.qoe.stallTime

The total time (seconds; integer) the playback was stalled during a playback session. Customers will have to create their own processing rules to have the value available for reporting.