getPlayerManifest

GET

/api/v1/player/manifest

curl --request GET \
  --url https://example.com/api/v1/player/manifest \
  --header 'Authorization: Bearer <token>'

Get player manifest. Requires an authenticated player credential.

Authorizations

• deviceBearer

Parameters

Header Parameters

If-None-Match

string

Responses

200

Stable screen-specific manifest or no-assignment manifest

Media typeapplication/json

object

data

required

object

schemaVersion

required

The Server selects a version from the Player’s reported presentation capabilities. New versions do not change responses for older Players. Version 21 adds Plugin API v2 plugin_state entries and is sent only to a Player that reports plugin.host at version 2.

integer

Allowed values: 11 12 13 14 15 16 17 18 19 20 21

manifestVersion

required

integer format: int64

>= 1

screenId

required

string format: uuid

generatedAt

required

string format: date-time

mode

required

string

Allowed value: presentation

playlist

required

One of:

null

null

object

object

key

additional properties

any

layout

One of:

null

null

object

object

key

additional properties

any

layouts

Array<object>

object

key

additional properties

any

assets

required

Array<object>

object

key

additional properties

any

canvas

One of:

null

null

object

object

width

required

integer

height

required

integer

viewport

One of:

null

null

object

object

x

required

integer

y

required

integer

width

required

integer

height

required

integer

rotation

required

integer

order

required

integer

schedules

Array<object>

object

id

required

string format: uuid

playlistId

string | null format: uuid

layoutId

string | null format: uuid

displayAction

One of:

null

null

object

A bounded Display Control action. A schedule may contain one action instead of a playlist or Layout. The server validates that only the field belonging to the selected type is present.

object

type

required

string

Allowed values: display_power_on display_power_off display_set_input display_set_volume display_mute display_unmute display_set_brightness

input

string

/^[A-Za-z0-9._:-]{1,32}$/

volume

integer

<= 100

brightness

integer

<= 100

type

required

string

Allowed values: weekly one_time

timezone

required

string

priority

required

integer

>= -999 <= 999

specificity

required

integer

startDate

string | null format: date

endDate

string | null format: date

oneTimeStart

string | null format: date-time

oneTimeEnd

string | null format: date-time

dailyStart

string | null

dailyEnd

string | null

daysOfWeek

Array<integer>

widgets

Array<object>

object

key

additional properties

any

dataSources

Array<object>

object

key

additional properties

any

plugins

Array

<= 64 items

One of:

object

object

id

required

string format: uuid

type

required

string

version

required

integer

>= 1

config

required

object

key

additional properties

any

object

Plugin API v2 Player state for one bundled plugin. The Player Plugin Host routes it by plugin and stateType. It carries no configuration a Player does not need and is never resolved through a renderer feature list.

object

id

required

string format: uuid

type

required

string

Allowed value: plugin_state

version

required

integer

Allowed value: 1

plugin

required

string

/^[a-z][a-z0-9_]{0,79}$/

definitionVersion

required

integer

>= 1 <= 1000000

stateType

required

string

/^[a-z][a-z0-9_]{0,79}$/

stateVersion

required

integer

>= 1 <= 1000

state

required

At most 16 KiB of JSON, sixteen nested levels, and 2048 values.

object

key

additional properties

any

media

required

One of:

null

null

Array<object>

Verified media variants the state uses. Each variant is also in assets.

Array<object>

<= 16 items

object

assetId

required

string format: uuid

variantId

required

string format: uuid

validUntil

string format: date-time

object

object

id

required

string

<= 128 characters

type

required

string

Allowed value: external_plugin

version

required

integer

Allowed value: 1

definitionVersion

required

integer

>= 1 <= 1000000

package

required

object

packageId

required

string

<= 128 characters

packageDigest

required

string

/^sha256:[0-9a-f]{64}$/

contributionId

required

string

<= 128 characters

frame

required

object

sha256

required

string

/^[0-9a-f]{64}$/

fileSize

required

integer

>= 1 <= 1114112

downloadPath

required

string

<= 1024 characters

runtime

required

object

surfaces

required

Array<string>

>= 1 items <= 7 items unique items

Allowed values: strip.top strip.bottom corner.top-left corner.top-right corner.bottom-left corner.bottom-right overlay

tier

required

string

Allowed values: emergency live scheduled ambient

state

required

Canonical JSON is bounded to 16 KiB, 16 nested levels, and 2048 values.

object

key

additional properties

any

validUntil

required

string format: date-time

presentationOverride

One of:

null

null

object

Active Quick Present session. The stopped timestamp and reason appear once the session ends.

object

id

required

string format: uuid

targetType

required

string

Allowed values: screen group

targetId

required

string format: uuid

targetName

required

string

contentType

required

string

Allowed values: playlist layout asset

contentId

required

string format: uuid

contentName

required

string

durationSeconds

required

integer

startedAt

required

string format: date-time

expiresAt

string format: date-time

afterAction

required

string

Allowed values: resume

wakeDisplay

required

boolean

stoppedAt

string format: date-time

stopReason

string

Example

{
  "data": {
    "schemaVersion": 11,
    "mode": "presentation",
    "schedules": [
      {
        "displayAction": {
          "type": "display_power_on"
        },
        "type": "weekly"
      }
    ],
    "plugins": [
      {
        "type": "plugin_state",
        "version": 1
      }
    ],
    "presentationOverride": {
      "targetType": "screen",
      "contentType": "playlist",
      "afterAction": "resume"
    }
  }
}

304

Manifest ETag matched

401

Device credential invalid or revoked

403

Screen disabled