Documentation Center

Viz Channel Branding User Guide

Version 5.1 | Published October 26, 2023 ©

GET Playlist State (Version 2.0)

Retrieve the state-information of a playlist.


Syntax
GET /api/channels/[channel]/playlists/[playlist]/state
Request
GET /api/channels/test/playlists/continuous/state HTTP/1.1
Response if Playlist state is NOT SET
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=playliststate
<inthub:playlistState xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=playliststate" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/state" />
<inthub:state>not set</inthub:state>
</inthub:playlistState>
Response if Playlist state is RUNNING
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=playliststate
<inthub:playlistState xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=playliststate" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/state" />
<inthub:state>running</inthub:state>
</inthub:playlistState>
Response if Playlist state is STOPPED
HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=playliststate
<inthub:playlistState xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
<inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=playliststate" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/state" />
<inthub:state>stopped</inthub:state>
</inthub:playlistState>

Disallowed Actions

This end-point does not allow POST, PUT or DELETE, and will return a 'HTTP/1.1 405 Method Not Allowed'.