Playlist

A playlist object represents a collection of media files that are to be played. It can either be a default playlist which will play if no other content is scheduled (either full screen or within a layout) or as a scheduled playlist within a layout zone.

Field definitions:
Name Description Required
id The ID of the playlist within the Signagelive system Yes
name The name of the playlist as defined by its creator Yes
media_assets An array of playlist media asset objects in the order in which they are to be played Yes

 

Playlist Media Asset Object

A playlist media asset object represents a media file within a playlist or a background asset in a zone or layout. The ‘id’ will correspond to a media asset object in the media_assets array on the content object.

Field definitions:
Name Description Required
id The ID of the playlist media asset Yes
media_asset_id The ID of the media asset to be played Yes
duration The duration in seconds that the asset should play for. 0 indicates play to length for videos. Yes
validity The recurrence object specifying on which days of the week on which the item will play and between which times of day. Can be null. Yes
meta_data An array of string key/value pairs containing configuration information for the media asset Yes