API Signature: GET http://{SignageIP}:9646/api/playlist
The above API helps a client application get the current playlist on a signage with the list of assets and related metadata.
API Response
[ { "Order":1, "Duration":60, "Id":1135, "Name":"Aaaaa", "Notes":null, "Url":"https://xomnistorage4075.blob.core.windows.net/videos/42cdb84f-7255-4723-9786-375202ed7d71", "Tags":[ ], "Metadata":[ ], "IsVisible":true, "LibraryItemType":2, "CategoryId":6, "ThumbnailUrl":"https://xomnistorage4075.blob.core.windows.net/images/c00066c9-caaa-40f6-8da4-b8293867b45e", "HasRelatedPlaylist":false }, { "Order":2, "Duration":60, "Id":347, "Name":"Chad video", "Notes":null, "Url":"https://xomnistorage4075.blob.core.windows.net/videos/11a11ac1-0aaf-44ff-9a27-8234f4db300a", "Tags":[ "osman" ], "Metadata":[ ], "IsVisible":true, "LibraryItemType":2, "CategoryId":6, "ThumbnailUrl":"https://xomnistorage4075.blob.core.windows.net/images/e51d4e5a-12b7-4265-b08c-04fe712fbb71", "HasRelatedPlaylist":false } ]
Field | Description |
Order | Asset order within the current playlist playback. |
Duration | Amount of a seconds an asset will be shown on the screen. Duration does not apply to videos. |
Id | Unique ID for the asset. |
Name | The given name of the asset. |
Notes | Notes given by the user for the asset. |
Url | Direct access URL for the asset. |
Tags | A collection of tags assigned to the asset. |
Metadata | A collection of additional metadata assigned to the asset. |
IsVisible | Indicates if the asset is going to be used in the playback of the current playlist. |
LibraryItem Type | 1 for Image, 2 for Video. |
ThumbnailUrl | Direct access URL for the asset thumbnail. |
Output Status Codes
Status Code | Description |
404 - Not Found | Remote device or an attached playlist not found. |