Timed media information Schema

https://ns.adobe.com/xdm/context/media-timed

Information related to timed media such main content, ads, and chapters.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Experimental	No	Forbidden	Permitted	context/media-timed.schema.json

Schema Hierarchy

Timed media information https://ns.adobe.com/xdm/context/media-timed
- Extensibility base schema https://ns.adobe.com/xdm/common/extensible
- Timed media primary asset reference https://ns.adobe.com/xdm/context/media-timed-asset-reference
- Primary asset view details https://ns.adobe.com/xdm/context/media-timed-asset-view-details
- Timed media chapter information https://ns.adobe.com/xdm/context/media-timed-chapter
- Measure https://ns.adobe.com/xdm/data/measure

Timed media information Example

{
  "xdm:primaryAssetReference": {
    "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430",
    "dc:title": "Floki Begs Helga for Freedom",
    "xmpDM:duration": 87,
    "iptc4xmpExt:Series": {
      "iptc4xmpExt:Name": "nba_highlights",
      "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953"
    },
    "xdm:showType": "episode",
    "xdm:streamFormat": "long",
    "iptc4xmpExt:Season": {
      "iptc4xmpExt:Number": 1
    },
    "iptc4xmpExt:Episode": {
      "iptc4xmpExt:Number": 1
    },
    "iptc4xmpExt:Genre": [
      "sports"
    ],
    "iptc4xmpExt:Rating": [
      {
        "iptc4xmpExt:RatingValue": "TV14",
        "iptc4xmpExt:RatingSourceLink": "http://www.tvguidelines.org/ratings.htm"
      }
    ],
    "iptc4xmpExt:Creator": [
      {
        "iptc4xmpExt:Name": "ESPN"
      }
    ]
  },
  "xdm:primaryAssetViewDetails": {
    "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230",
    "xdm:playerName": "watchespn",
    "xdm:broadcastChannel": "WatchESPN",
    "xdm:broadcastContentType": "VOD",
    "xdm:streamFormat": "short",
    "xdm:playerSDKVersion": {
      "xdm:version": "1.0.8"
    },
    "xdm:broadcastNetwork": "nbcu",
    "xdm:adLoadType": "2",
    "xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8",
    "xdm:sessionTimeout": 1800
  },
  "xdm:mediaChapter": {
    "xdm:chapterAssetReference": {
      "@id": "https://data.adobe.io/entities/media-chapter-asset-reference/2144511",
      "dc:title": "Chapter1",
      "xmpDM:duration": 44
    },
    "xdm:chapterAssetViewDetails": {
      "xdm:index": 0,
      "xdm:offset": 0
    },
    "xdm:impressions": {
      "xdm:value": 1
    },
    "xdm:completes": {
      "xdm:value": 1
    },
    "xdm:timePlayed": {
      "xdm:value": 44
    },
    "xdm:federated": {
      "xdm:value": 0
    }
  }
}

Timed media information Properties

Property	Type	Required	Defined by
xdm:completes	Measure	Optional	Timed media information (this schema)
xdm:dropBeforeStarts	Measure	Optional	Timed media information (this schema)
xdm:federated	Measure	Optional	Timed media information (this schema)
xdm:impressions	Measure	Optional	Timed media information (this schema)
xdm:mediaChapter	Timed media chapter information	Optional	Timed media information (this schema)
xdm:mediaSegmentViews	Measure	Optional	Timed media information (this schema)
xdm:pauseTime	Measure	Optional	Timed media information (this schema)
xdm:pauses	Measure	Optional	Timed media information (this schema)
xdm:primaryAssetReference	Timed media primary asset reference	Optional	Timed media information (this schema)
xdm:primaryAssetViewDetails	Primary asset view details	Optional	Timed media information (this schema)
xdm:progress10	Measure	Optional	Timed media information (this schema)
xdm:progress25	Measure	Optional	Timed media information (this schema)
xdm:progress50	Measure	Optional	Timed media information (this schema)
xdm:progress75	Measure	Optional	Timed media information (this schema)
xdm:progress95	Measure	Optional	Timed media information (this schema)
xdm:resumes	Measure	Optional	Timed media information (this schema)
xdm:starts	Measure	Optional	Timed media information (this schema)
xdm:timePlayed	Measure	Optional	Timed media information (this schema)
xdm:totalTimePlayed	Measure	Optional	Timed media information (this schema)
`*`	any	Additional	this schema allows additional properties

xdm:completes

Completes

Indicates if a timed media asset was watched to completion, this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead.

xdm:completes

is optional
type: Measure
defined in this schema

xdm:completes Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:dropBeforeStarts

Drop before starts

Indicates the user abandoned the media stream before the first frame for example, during the pre-roll ad break, or due to an error while loading the content from the CDN.

xdm:dropBeforeStarts

is optional
type: Measure
defined in this schema

xdm:dropBeforeStarts Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:federated

Federated

Indicates the experience event was created through data federation or data sharing.

xdm:federated

is optional
type: Measure
defined in this schema

xdm:federated Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:impressions

Impressions

Describes the intention to play a timed media asset. It does not measure success, as the user might abandon the content before the first frame is viewed.

xdm:impressions

is optional
type: Measure
defined in this schema

xdm:impressions Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:mediaChapter

Media chapter

Timed media chapter information.

xdm:mediaChapter

is optional
type: Timed media chapter information
defined in this schema

xdm:mediaChapter Type

Timed media chapter information – https://ns.adobe.com/xdm/context/media-timed-chapter

xdm:mediaSegmentViews

Media segment views

Indicates when at least one frame, not necessarily the first has been viewed.

xdm:mediaSegmentViews

is optional
type: Measure
defined in this schema

xdm:mediaSegmentViews Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:pauseTime

Total pause duration

Describes the duration in seconds in which playback was paused by the user.

xdm:pauseTime

is optional
type: Measure
defined in this schema

xdm:pauseTime Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:pauses

Pauses

The number of pause periods that occurred during playback.

xdm:pauses

is optional
type: Measure
defined in this schema

xdm:pauses Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:primaryAssetReference

Primary asset reference

Asset information about the main content that was played, present on all ads and chapters that occur during the content's playback.

xdm:primaryAssetReference

is optional
type: Timed media primary asset reference
defined in this schema

xdm:primaryAssetReference Type

Timed media primary asset reference – https://ns.adobe.com/xdm/context/media-timed-asset-reference

xdm:primaryAssetViewDetails

Primary asset view details

View details for the main content playback, present on all ads and chapters that occur during the content's playback.

xdm:primaryAssetViewDetails

is optional
type: Primary asset view details
defined in this schema

xdm:primaryAssetViewDetails Type

Primary asset view details – https://ns.adobe.com/xdm/context/media-timed-asset-view-details

xdm:progress10

10% Progress marker

Indicates that the playhead passed the 10% marker of media based on stream length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.

xdm:progress10

is optional
type: Measure
defined in this schema

xdm:progress10 Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:progress25

25% Progress marker

Indicates that the playhead passed the 25% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.

xdm:progress25

is optional
type: Measure
defined in this schema

xdm:progress25 Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:progress50

50% Progress marker

Indicates that the playhead passed the 50% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.

xdm:progress50

is optional
type: Measure
defined in this schema

xdm:progress50 Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:progress75

75% Progress marker

Indicates that the playhead passed the 75% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.

xdm:progress75

is optional
type: Measure
defined in this schema

xdm:progress75 Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:progress95

95% Progress marker

Indicates that the playhead passed the 95% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.

xdm:progress95

is optional
type: Measure
defined in this schema

xdm:progress95 Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:resumes

Resumes

Marks each playback that was resumed after more than 30 minutes of buffer, pause, or stall period.

xdm:resumes

is optional
type: Measure
defined in this schema

xdm:resumes Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:starts

Starts

Indicates the first frame of the timed media asset has been viewed for example, the viewer did not abandon during pre-roll ad, or buffering.

xdm:starts

is optional
type: Measure
defined in this schema

xdm:starts Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:timePlayed

Time spent

The amount of time spent in seconds by a user on a specific timed media asset.

xdm:timePlayed

is optional
type: Measure
defined in this schema

xdm:timePlayed Type

Measure – https://ns.adobe.com/xdm/data/measure

xdm:totalTimePlayed

Content play

Describes the total amount of time spent by a user on a specific timed media asset, which includes time spent watching ads.

xdm:totalTimePlayed

is optional
type: Measure
defined in this schema

xdm:totalTimePlayed Type

Measure – https://ns.adobe.com/xdm/data/measure

Files

media-timed.schema.md

Latest commit

History