Skip to content

Latest commit

 

History

History
480 lines (234 loc) · 10.1 KB

qoedatadetails.schema.md

File metadata and controls

480 lines (234 loc) · 10.1 KB
Raw

Qoe Data details information Schema

https://ns.adobe.com/xdm/datatypes/qoeDataDetails

Qoe Data details information.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted datatypes/qoedatadetails.schema.json

Qoe Data details information Example

{
  "xdm:bitrateAverageBucket": "800-899"
}

Qoe Data details information Properties

Property Type Required Defined by
xdm:bitrate integer Optional Qoe Data details information (this schema)
xdm:bitrateAverage number Optional Qoe Data details information (this schema)
xdm:bitrateAverageBucket string Optional Qoe Data details information (this schema)
xdm:bitrateChangeCount integer Optional Qoe Data details information (this schema)
xdm:bufferCount integer Optional Qoe Data details information (this schema)
xdm:bufferTime integer Optional Qoe Data details information (this schema)
xdm:droppedFrames integer Optional Qoe Data details information (this schema)
xdm:errorCount integer Optional Qoe Data details information (this schema)
xdm:externalErrors string[] Optional Qoe Data details information (this schema)
xdm:framesPerSecond integer Optional Qoe Data details information (this schema)
xdm:hasBitrateChangeImpactedStreams boolean Optional Qoe Data details information (this schema)
xdm:hasBufferImpactedStreams boolean Optional Qoe Data details information (this schema)
xdm:hasDroppedFrameImpactedStreams boolean Optional Qoe Data details information (this schema)
xdm:hasErrorImpactedStreams boolean Optional Qoe Data details information (this schema)
xdm:hasStallImpactedStreams boolean Optional Qoe Data details information (this schema)
xdm:isDroppedBeforeStart boolean Optional Qoe Data details information (this schema)
xdm:mediaSdkErrors string[] Optional Qoe Data details information (this schema)
xdm:playerSdkErrors string[] Optional Qoe Data details information (this schema)
xdm:stallCount integer Optional Qoe Data details information (this schema)
xdm:stallTime integer Optional Qoe Data details information (this schema)
xdm:timeToStart integer Optional Qoe Data details information (this schema)
* any Additional this schema allows additional properties

xdm:bitrate

Bitrate

The bitrate value (in kbps).

xdm:bitrate

  • is optional
  • type: integer
  • defined in this schema

xdm:bitrate Type

integer

xdm:bitrateAverage

Average Bitrate

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.

xdm:bitrateAverage

  • is optional
  • type: number
  • defined in this schema

xdm:bitrateAverage Type

number

xdm:bitrateAverageBucket

Average Bitrate Bucket

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.

xdm:bitrateAverageBucket

  • is optional
  • type: string
  • defined in this schema

xdm:bitrateAverageBucket Type

string

xdm:bitrateChangeCount

Bitrate Changes

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

xdm:bitrateChangeCount

  • is optional
  • type: integer
  • defined in this schema

xdm:bitrateChangeCount Type

integer

xdm:bufferCount

Buffer Events

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.

xdm:bufferCount

  • is optional
  • type: integer
  • defined in this schema

xdm:bufferCount Type

integer

xdm:bufferTime

Total Buffer Duration

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.

xdm:bufferTime

  • is optional
  • type: integer
  • defined in this schema

xdm:bufferTime Type

integer

xdm:droppedFrames

Dropped Frames

The number of frames dropped during playback of the main content.

xdm:droppedFrames

  • is optional
  • type: integer
  • defined in this schema

xdm:droppedFrames Type

integer

xdm:errorCount

Errors

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

xdm:errorCount

  • is optional
  • type: integer
  • defined in this schema

xdm:errorCount Type

integer

xdm:externalErrors

External Error IDs

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.

xdm:externalErrors

  • is optional

  • type: string[]

  • defined in this schema

xdm:externalErrors Type

Array type: string[]

All items must be of the type: string

xdm:framesPerSecond

Frames Per Second

The current value of the stream frame-rate (in frames per second). The field is mapped to the fps field on the close call and can be accessed through processing rules.

xdm:framesPerSecond

  • is optional
  • type: integer
  • defined in this schema

xdm:framesPerSecond Type

integer

xdm:hasBitrateChangeImpactedStreams

Bitrate Change Impacted Streams

The number of streams in which bitrate changes occurred. This metric is set to true only if at least one bitrate change event occurred during a playback session.

xdm:hasBitrateChangeImpactedStreams

  • is optional
  • type: boolean
  • defined in this schema

xdm:hasBitrateChangeImpactedStreams Type

boolean

xdm:hasBufferImpactedStreams

Buffer Impacted Streams

The number of streams impacted by buffering. This metric is set to true only if at least one buffer event occurred during a playback session.

xdm:hasBufferImpactedStreams

  • is optional
  • type: boolean
  • defined in this schema

xdm:hasBufferImpactedStreams Type

boolean

xdm:hasDroppedFrameImpactedStreams

Dropped Frame Impacted Streams

The number of streams in which frames were dropped. This metric is set to true only if at least one frame was dropped during a playback session.

xdm:hasDroppedFrameImpactedStreams

  • is optional
  • type: boolean
  • defined in this schema

xdm:hasDroppedFrameImpactedStreams Type

boolean

xdm:hasErrorImpactedStreams

Error Impacted Streams

The number of streams in which an error event occurred (i.e., trackError was called during the playback session, and a type=error heartbeat call was generated). This metric is set to true only if at least one error occurred during playback.

xdm:hasErrorImpactedStreams

  • is optional
  • type: boolean
  • defined in this schema

xdm:hasErrorImpactedStreams Type

boolean

xdm:hasStallImpactedStreams

Stalling Impacted Streams

The number of streams in which a stalled event occurred. This metric is set to true only if at least one stall occurred during playback.

xdm:hasStallImpactedStreams

  • is optional
  • type: boolean
  • defined in this schema

xdm:hasStallImpactedStreams Type

boolean

xdm:isDroppedBeforeStart

Drops Before Starts

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

xdm:isDroppedBeforeStart

  • is optional
  • type: boolean
  • defined in this schema

xdm:isDroppedBeforeStart Type

boolean

xdm:mediaSdkErrors

Media SDK Error IDs

The unique error IDs generated by Media SDK during playback.

xdm:mediaSdkErrors

  • is optional

  • type: string[]

  • defined in this schema

xdm:mediaSdkErrors Type

Array type: string[]

All items must be of the type: string

xdm:playerSdkErrors

Player SDK Error IDs

The unique error IDs generated by the player SDK. Customers must provide the error codes/ids at implementation time via provided error APIs.

xdm:playerSdkErrors

  • is optional

  • type: string[]

  • defined in this schema

xdm:playerSdkErrors Type

Array type: string[]

All items must be of the type: string

xdm:stallCount

Stalling Events

The number of times the playback was stalled during a playback session.

xdm:stallCount

  • is optional
  • type: integer
  • defined in this schema

xdm:stallCount Type

integer

xdm:stallTime

Total Stalling Duration

The total time (seconds; integer) the playback was stalled during a playback session.

xdm:stallTime

  • is optional
  • type: integer
  • defined in this schema

xdm:stallTime Type

integer

xdm:timeToStart

Time To Start

Describes the duration (in seconds) passed between video load and start.

xdm:timeToStart

  • is optional
  • type: integer
  • defined in this schema

xdm:timeToStart Type

integer