Skip to content

Latest commit

 

History

History
366 lines (215 loc) · 8.58 KB

mediadetails.schema.md

File metadata and controls

366 lines (215 loc) · 8.58 KB
Raw

Media details information Schema

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

Media details information.

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

Schema Hierarchy

Media details information Example

{
  "xdm:playhead": 831,
  "xdm:sessionDetails": {
    "xdm:name": "123456789",
    "xdm:length": 100,
    "xdm:contentType": "VOD",
    "xdm:playerName": "playerName",
    "xdm:channel": "channel"
  },
  "xdm:advertisingDetails": {
    "xdm:name": "123456789",
    "xdm:length": 100,
    "xdm:podPosition": 1,
    "xdm:playerName": "playerName"
  },
  "xdm:advertisingPodDetails": {
    "xdm:index": 2,
    "xdm:offset": 123
  },
  "xdm:chapterDetails": {
    "xdm:length": 100,
    "xdm:offset": 50,
    "xdm:index": 2
  },
  "xdm:errorDetails": {
    "xdm:name": "errorID",
    "xdm:source": "player"
  },
  "xdm:qoeDataDetails": {
    "xdm:bitrate": 100
  },
  "xdm:statesStart": [
    {
      "xdm:name": "mute"
    },
    {
      "xdm:name": "pictureInPicture"
    }
  ],
  "xdm:statesEnd": [
    {
      "xdm:name": "fullScreen"
    }
  ],
  "xdm:states": [
    {
      "xdm:name": "mute",
      "xdm:isSet": true,
      "xdm:count": 2,
      "xdm:time": 5
    }
  ],
  "xdm:customMetadata": [
    {
      "xdm:name": "customName",
      "xdm:value": "test1"
    },
    {
      "xdm:name": "test2",
      "xdm:value": "customValue"
    }
  ]
}

Media details information Properties

Property Type Required Defined by
xdm:advertisingDetails Advertising details information Optional Media details information (this schema)
xdm:advertisingPodDetails Advertising Pod details information Optional Media details information (this schema)
xdm:chapterDetails Chapter details information Optional Media details information (this schema)
xdm:customMetadata Custom metadata details information Optional Media details information (this schema)
xdm:errorDetails Error details information Optional Media details information (this schema)
xdm:playhead integer Optional Media details information (this schema)
xdm:qoeDataDetails Qoe Data details information Optional Media details information (this schema)
xdm:sessionDetails Session details information Optional Media details information (this schema)
xdm:sessionID string Optional Media details information (this schema)
xdm:states Player state data information Optional Media details information (this schema)
xdm:statesEnd Player state data information Optional Media details information (this schema)
xdm:statesStart Player state data information Optional Media details information (this schema)
* any Additional this schema allows additional properties

xdm:advertisingDetails

Advertising Details

Advertising details information related to the experience event.

xdm:advertisingDetails

  • is optional
  • type: Advertising details information
  • defined in this schema

xdm:advertisingDetails Type

xdm:advertisingPodDetails

Advertising Pod Details

Advertising pod details information related to the experience event.

xdm:advertisingPodDetails

  • is optional
  • type: Advertising Pod details information
  • defined in this schema

xdm:advertisingPodDetails Type

xdm:chapterDetails

Chapter Details

Chapter details information related to the experience event.

xdm:chapterDetails

  • is optional
  • type: Chapter details information
  • defined in this schema

xdm:chapterDetails Type

xdm:customMetadata

The Custom Metadata

The list of custom metadata.

xdm:customMetadata

  • is optional

  • type: Custom metadata details information

  • defined in this schema

xdm:customMetadata Type

Array type: Custom metadata details information

All items must be of the type:

xdm:errorDetails

Error Details

Error details information related to the experience event.

xdm:errorDetails

  • is optional
  • type: Error details information
  • defined in this schema

xdm:errorDetails Type

xdm:playhead

Playhead

If the content is live, the playhead must be the current second of the day, 0 <= playhead < 86400. If the content is recorded, the playhead must be the current second of content, 0 <= playhead < content length.

xdm:playhead

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

xdm:playhead Type

integer

  • minimum value: 0

xdm:qoeDataDetails

Qoe Data Details

Qoe data details information related to the experience event.

xdm:qoeDataDetails

  • is optional
  • type: Qoe Data details information
  • defined in this schema

xdm:qoeDataDetails Type

xdm:sessionDetails

Session Details

Session details information related to the experience event.

xdm:sessionDetails

  • is optional
  • type: Session details information
  • defined in this schema

xdm:sessionDetails Type

xdm:sessionID

Media Session ID

Identifies an instance of a content stream unique to an individual playback.

xdm:sessionID

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

xdm:sessionID Type

string

xdm:states

List Of States

The list of states.

xdm:states

  • is optional

  • type: Player state data information

  • defined in this schema

xdm:states Type

Array type: Player state data information

All items must be of the type:

xdm:statesEnd

List Of States End

The list of states end.

xdm:statesEnd

  • is optional

  • type: Player state data information

  • defined in this schema

xdm:statesEnd Type

Array type: Player state data information

All items must be of the type:

xdm:statesStart

List Of States Start

The list of states start.

xdm:statesStart

  • is optional

  • type: Player state data information

  • defined in this schema

xdm:statesStart Type

Array type: Player state data information

All items must be of the type: