media-timed-chapter.schema.md

Timed Media Chapter Information Schema

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

Timed media chapter information

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

Schema Hierarchy

• Timed Media Chapter Information https://ns.adobe.com/xdm/context/media-timed-chapter
  • Extensibility base schema https://ns.adobe.com/xdm/common/extensible
  • Timed Media Chapter Asset Reference https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference
  • Timed Media Chapter View Details https://ns.adobe.com/xdm/context/media-timed-chapter-view-details
  • Measure https://ns.adobe.com/xdm/data/measure

Timed Media Chapter Information Example

{
  "@id": "https://data.adobe.io/entities/media-chapter/2144511",
  "dc:title": "Chapter1",
  "xmpDM:duration": 44
}

Timed Media Chapter Information Properties

Property	Type	Required	Defined by
xdm:chapterAssetReference	Timed Media Chapter Asset Reference	Optional	Timed Media Chapter Information (this schema)
xdm:chapterAssetViewDetails	Timed Media Chapter View Details	Optional	Timed Media Chapter Information (this schema)
xdm:completes	Measure	Optional	Timed Media Chapter Information (this schema)
xdm:federated	Measure	Optional	Timed Media Chapter Information (this schema)
xdm:impressions	Measure	Optional	Timed Media Chapter Information (this schema)
xdm:timePlayed	Measure	Optional	Timed Media Chapter Information (this schema)
*	any	Additional	this schema allows additional properties

xdm:chapterAssetReference

Chapter Asset Reference

Asset information about the chapter captured by the experience event.

xdm:chapterAssetReference

• is optional
• type: Timed Media Chapter Asset Reference
• defined in this schema

xdm:chapterAssetReference Type

• Timed Media Chapter Asset Reference – https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference

xdm:chapterAssetViewDetails

Chapter View Details

View details for the chapter playback captured by the experience event.

xdm:chapterAssetViewDetails

• is optional
• type: Timed Media Chapter View Details
• defined in this schema

xdm:chapterAssetViewDetails Type

• Timed Media Chapter View Details – https://ns.adobe.com/xdm/context/media-timed-chapter-view-details

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:federated

Federated

Indicates if an experience event was created through data federation (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:timePlayed

Time Spent

Describes the amount of time (in seconds) spent 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