Layout

Field definitions:
Name Description Required
id Id of the layout Yes
name Name of the layout Yes
is_deployed A boolean value indicating whether or not a client has reported that it has already downloaded the layout. If false, the client must notify the Signagelive API of the download after all media has been downloaded. This will be false when the layout is first deployed and if any changes are made to the schedule, layout design or content. Yes
width Width of the layout design Yes
height Height of the layout design Yes
background_color background color expressed as a hexadecimal RGB No – omitted if a background image is being used
background_asset_id The ID of the media asset that should be displayed as the layout background. No – omitted if a background image is not set
zones Array of zones for the layout. Zones define content areas, which may contain playlists, rss tickers, web pages, video capture output etc. Yes

Zone Object

Name Description Required
id Id of the zone Yes
x x coordinate of the zone relative to the layout position Yes
y y coordinate of the zone relative to the layout position Yes
width width of the zone Yes
height height Yes
z-index The zones position in the layouts z order Yes
background_color background color expressed as a hexadecimal RGB No – omitted if a background image is being used
background_asset_id Media asset reference object indicating the media asset object that should be displayed as the zone background. If both an asset ID and a color are specified, the media asset will take precedence. No – omitted if a background image is not set
default_media_asset_id The ID of the media asset to display if there is not a default playlist specified, and there is no scheduled item configured to play in the zone at any given time Yes
default_playlist_id The ID of the default playlist. The default playlist, if configured, will play when there are no scheduled items for the zone at any given time. Yes
type The type of zone, supported values are:

  • media
  • text
Yes
scheduled_playlists Array of scheduled playlist objects arranged in a linear schedule, earliest first. Yes – although the array could be empty
configuration_parameters Array of key values pairs containing configuration parameters to configure the zone e.g. ticker scroll direction, shape etc Yes – although the array could be empty
Note on scaling of layouts/zones.

Layouts are designed to fit the screen, irrespective of the difference between the layout’s design size and client screen resolution.

Media players are expected to calculate the relative size and positions of layout zones based upon the ratio of the screen resolution and the layout design.

Configuration parameters for text zones

Where a zone type is “text”, the following configuration parameters may be used to configure the appearance and behaviour of the zone:

Name Description Required
font The name of the font to be used when displaying the text. No
font_asset_id The ID of the media asset which represents the font file which must be downloaded to install the font when the layout designer has selected a non standard font. No
font_size The size of the font in points. If not specified, the text should be scaled to fit the window appropriately. No
font_color The text color expressed as a hexadecimal RGB. No
bold A string representation of a boolean value (“true” or “false”) indicating whether the text should be bold. No
italic A string representation of a boolean value (“true” or “false”) indicating whether the text should be italic. No
underline A string representation of a boolean value (“true” or “false”) indicating whether the text should be underlined. No
animation How the text should be animated. Possible values:

  • scroll_right_to_left – Text scrolls from right to left.
  • scroll_left_to_right – Text scrolls from left to right.
  • scroll_bottom_to_top – Text scrolls from bottom to top.
  • scroll_top_to_bottom – Text scrolls from top to bottom.
  • fade – Text fades in and out
  • none – No animation. A single text item is displayed
No
speed A number from 1-10 indicating how fast the text should scroll/fade in and out, 1 being slow and 10 being fast. No – default will be 5
pause The amount of time, in seconds, to pause the ticker when each text item is shown on screen. No – default will be 0
seperator_asset_id The ID of the media asset to be used as a “separator” image – it appears between the individual text assets. No

 

Scheduled Playlist Object

A scheduled playlist object define when a particular playlist will be played.

Field definitions:
Name Description Required
playlist_id The ID of the playlist to be played. Yes
start The start date/time of the playlist. Yes
end The end date/time of the playlist. Yes