Player

Play existing media file on player

Will preempt everything other than urgent alerts.

PUT

/api/v1/player/play

curl --request PUT \
  --url 'https://voyager.korbyt.com/api/v1/player/play?name=sample_player&id=1&media_name=surrealism&media_id=1&duration=15&start=%3Cstring%3E&end=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

[
  {
    "player_id": "24",
    "player_name": "RMG-PWA-329C5899",
    "player_output": "1",
    "push_id": "27"
  }
]

On success, response includes an integer push_id that can be used with the DELETE method to revoke this content assignment.

Expiration must be in the form ###m (example 10m for 10 minutes) or in UTC (2018-10-09T12:30:00Z)

Authorizations

Authorizationstringheaderrequired

Access token from POST /api/v1/auth/login

Query Parameters

namestringquery

player name

Example: sample_player

idintegerquery

player id

Example: 1

media_namestringquery

media name (optionaly including folder path as well)

Example: surrealism

media_idintegerquery

media id

Example: 1

durationintegerquery

length of time to play media item (defaults to 15 seconds)

Example: 15

startstringquery

Start datetime (format: yyyy-mm-dd hh:mm:ss) player local time)

endstringquery

end datetime (format: yyyy-mm-dd hh:mm:ss) player local time)

Response

itemsobject[]

Show child attributes

Still need help? Share an idea