API URL Structure
GET http://\{host}/api/3.0/sources_to_output/{output_id}/.json
Would retrieve a specific output Mosaic associated layouts & sources.
The "output_id" can be used with either the internal id ("id") or with user defined id ("uuid") - both would be used as a unique identifier.
Returned data structure
{"Output":{
"id": 621
,"uuid" : "XAY111"
,"title": "Output Mosaic 1"
,"Layouts" : [
{
"id":10
,"uuid" : "A1234GG"
,"title":"Default",
,"layout_type_id":1
,"layout_type_title":"4X4"
,"Sources": [
{
"url" : "input1:225.0.1.3:3000:192.168.0.1"
,"secondary_url" : null
,"access_type_id" : 5
,"service_type_id" : 2
,"title" : "Source_1"
,"umd_1" : "A Source"
,"umd_2" : "Test"
,"layout_box_id" : "1"
,"coordinates" : "8,10,200,100"
,"is_persistent" : "0"
},
…
{}
]
},
…
{}
],
}}
DataFields
Field | Parent | Type | Description |
| Output | - | JSON | Main header of the data structure |
| id | Output | Numeric | Internal index |
| uuid | Output | Alphanumeric | User defined index for output mosaic identification |
| title | Output | String | Used for UI output mosaic identification |
Layouts | Output | JSON Array | In round robin mode can list more than one layout per output |
id | Layout | Numeric | Internal index |
uuid | Layout | Alphanumeric | User defined index for layout identification |
title | Layout | String | Used for UI layout identification |
layout_type_id | Layout | Numeric | Associated layout type ( structure & location of all internal tiles ) index |
layout_type_title | Layout | String | Associated layout type title, used for UI identification |
Sources | Layout | JSON Array | List the sources associated with the displayed visual layout |
url | Source | String | Source channel address – "{network_name}:udp://{ssm}@{ip_address}:{port} ": network_name : The name of the network ( associated with the physical interface ) the content should be pulled from. |
secondary_url | Source | String | In case of 2002-7 source, the Secondary channel address |
access_type_id | Source | Enumeration | Identification of the source access type – MPEGTS \ 2022-6 \ 2022-6 & 2022-7 etc … |
service_type_id | Source | Enumeration | Identification of the source service type – HD \ SD etc … Used for internal hardware |
title | Source | String | Used for UI channel identification |
umd_1 | Source | String | "Hard Name" UMD text associated with the displayed mosaic tile |
umd_2 | Source | String | "Soft Name" UMD text associated with the displayed mosaic tile |
layout_box_id | Source | Numeric | Identification of the tile index inside the displayed layout |
coordinates | Source | String | The X,Y,Width,Hight coordinates of the tile inside the displayed layout |
is_persistent | Source | Boolean | If persistent, channel would be kept in internal DB even if not displayed |
Assumptions:
"uuid": for both output mosaics & layouts would be set on initial configuration, and as such can be regarded a static data.
"network_name": this field supply a logical network name which would be assigned on initial configuration to the 100Gb interfaces, as a result can be used as a static data with the API.