Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...


Field

TypeDescription

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:


HashTagDescription

#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

...