Retrieve list of available Layouts
- Ramya Raman (Unlicensed)
API URL Structure
GET http://{host}/api/4.0/layouts/.json
GET http://{host}/api/4.0/layouts/{layout_uuid}/.json
PUT http://{host}/api/4.0/layouts/{layout_uuid}/.json
Would retrieve a list/specific layout and its associated data structure, when used with HTTP GET action. For entry update utilize the PUT HTTP action.
While updating all entries should be available, were in order to remove a channel from tile set it’s value into null. UMD and Tally information should be either static string or mapping into external (TSL or API based) data.
Returned data structure
{
"Layout": {
"uuid": "7c234d0c-3a7a-4764-bc12-e90a69857810",
"label": "Test",
"modified": "1655297509561",
"created": "1655113001545",
"text_mode": "Scroll",
"background": null,
"layout_type_uuid": "18deb7d5-2354-405f-a179-b483dc87125f",
"layout_type_label": "20 Channels",
"Tiles": [
{
"index": 1,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 2,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 3,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 4,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 5,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 6,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 7,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 8,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 9,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 10,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 11,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 12,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 13,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 14,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 15,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 16,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 17,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 18,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 19,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
},
{
"index": 20,
"channel_uuid": null,
"channel_label": null,
"content_type": "Channel",
"umd_1": "",
"umd_2": "",
"tally_settings": null,
"activation_mode": "Persistent"
}
]
}
}
DataFields
Field | Type | Description |
Layout:uuid | UUID | Layout identifier |
Layout:layout_type_uuid | UUID | Layout type identifier (mapping to the layout geometry) |
Layout:Tiles:index | Numeric | Tile index |
Layout:Tiles:channel_uuid | UUID | Mapping to the Channel/Composite Element associated with the tile for a Channel tile |
Layout:Tiles:timezone_uuid | UUID | Mapping to the Timezone associated with the tile for a Clock tile |
Layout:Tiles:content_type | Enum:String | Tile content out of Channel/Clock/Text types |
Layout:Tiles:umd_1 | String | UMD content associated with tile, can be Static or mapped to external UMD source |
Layout:Tiles:umd_2 | String | UMD content associated with tile, can be Static or mapped to external UMD source |
Layout:Tiles: tally_settings | String | Tally mapping to external source |
Layout:Tiles: content | String | Content/Text for text tile use case, formatted as HTML |
The following UMD Hashtags fields are available in order to manipulate the Tally & UMD functionality:
| HashTag | Description |
#B# | Proceeding text would be in BOLD |
#U# | Proceeding text would be Underlined |
#I# | Proceeding text would be Italics |
#R# | Proceeding text would be Regular |
#RGBXXXXXX# | Set proceeding text color in RGB |
#YUVXXXXXX# | Set proceeding text color in YUV |
#BRGBXXXXXX# | Set background color RGB |
#BYUVXXXXXX# | Set background color YUV |
#hide# | Hide the UMD |
#SDTNAME# | Insert SDT Name from compressed MPEGTS into UMD text |
#SDTPROV# | Insert SDT Provider from compressed MPEGTS into UMD text |
#TSID# | Insert Transport ID from compressed MPEGTS into UMD text |
#BITRATE# | Insert source bitrate into UMD text |
#RESOLUTION# | Insert source resolution into UMD text |
#TIMECODE# | Insert embedded Timecode into UMD text |
#CODEC# | Insert source codec into UMD text |
#TITLE# | Configured channel Title |
#T0# | Inserts a left tally light/square |
#T1# | Inserts a right tally light/square |
#TC0# | Use tally index 0 for text color |
#TBC0# | Use tally index 0 for background color |
#UC0# | Use umd index 0 for text color |
#U0# | Insert UMD index 0 text & color |
#UF0# | Insert UMD index 0 text without it’s color |
Field
Type
For Tally mapping the following configuration is available:
| Description | |
{label}[border=t0] | See below UMD & Tally control API – the tally setting defines the interface mapping to tile. Enables mapping of tally color into border color |
alarm=none | Disable on screen source alarm display |