Skip to content

playerstatedata.schema.md

Latest commit

 

History

History
120 lines (69 loc) · 2.4 KB

playerstatedata.schema.md

File metadata and controls

120 lines (69 loc) · 2.4 KB

Player state data information Schema

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

Player state data information.

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

Player state data information Example

{
  "xdm:name": "pictureInPicture",
  "xdm:isSet": true,
  "xdm:count": 2,
  "xdm:time": 100
}

Player state data information Properties

Property Type Required Defined by
xdm:count integer Optional Player state data information (this schema)
xdm:isSet boolean Optional Player state data information (this schema)
xdm:name string Required Player state data information (this schema)
xdm:time integer Optional Player state data information (this schema)
* any Additional this schema allows additional properties

xdm:count

Player State Count

The number of times that player state was set on the stream.

xdm:count

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

xdm:count Type

integer

xdm:isSet

Player State Set

Whether or not the player state is set on that state.

xdm:isSet

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

xdm:isSet Type

boolean

xdm:name

Player State Name

The name of the player state.

xdm:name

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

xdm:name Type

string

xdm:name Known Values

Value Description
fullscreen Full Screen
mute Mute
closedCaptioning Closed Captioning
pictureInPicture Picture In Picture
inFocus In Focus

xdm:time

Player State Time

The total duration of that player state.

xdm:time

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

xdm:time Type

integer