...
...
...
...
API URL Structure
GET
...
http://{host}/api/4.0/channels/config/.json
GET http://
...
{host}/api/
...
4.0
...
/channels/config/{
...
channel_
...
uuid}/.json
Would retrieve a
...
list/specific channels and their associated data structure.
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
{
"...
Channel":...
Field
...
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.
ip_address : The Source Multicast address port : The Source accepted port
ssm : In case of IGMP V.3, the source specific address
...
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
requirements calculation
...
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
...
{
"uuid": "e241ecd8-82bc-4868-9550-dde8bb35f1e8",
"title": "BBC HD",
"modified": "1655477714481",
"created": "1655477571277",
"access_type": "MPTS",
"snooze_on_profile_change": 10,
"service_type": "HD Video",
"enabled": true,
"device_id": 9010,
"note": "",
"tally_settings": "",
"Profiles": [
{
"uuid": "ecfbc7b8-f400-44e8-9bb3-c1e8808091e8",
"label": "Default",
"notification_set_uuid": "f3a31bc3-e53f-4b63-9605-cd0b6121e602",
"notification_set_label": "Default",
"threshold_set_uuid": "b026dd10-9b84-42db-805a-16f1e97b10da",
"threshold_set_label": "Default",
"is_default": true,
"title_color": "Default",
"border_color": "Default",
"pixelate_level": "None",
"Components": [
{
"content_type": "PMT",
"is_monitored": true,
"is_content_monitored": true,
"is_outofband": false,
"pid": 256,
"bitrate_min": 30164,
"bitrate_max": 30164,
"is_scrambled": false,
"is_pcr": false
},
{
"content_type": "Video",
"is_monitored": true,
"is_content_monitored": true,
"is_outofband": false,
"pid": 2318,
"bitrate_min": 19109516,
"bitrate_max": 19109516,
"is_scrambled": false,
"is_pcr": true
},
{
"content_type": "Audio",
"is_monitored": true,
"is_content_monitored": true,
"is_outofband": false,
"pid": 2320,
"bitrate_min": 261665,
"bitrate_max": 261665,
"is_scrambled": false,
"is_pcr": false
},
{
"content_type": "Teletext",
"is_monitored": true,
"is_content_monitored": true,
"is_outofband": false,
"pid": 2321,
"bitrate_min": 37346,
"bitrate_max": 37346,
"is_scrambled": false,
"is_pcr": false
},
{
"content_type": "Other",
"is_monitored": true,
"is_content_monitored": true,
"is_outofband": false,
"pid": 2309,
"bitrate_min": 0,
"bitrate_max": 0,
"is_scrambled": false,
"is_pcr": false
},
{
"content_type": "Other",
"is_monitored": true,
"is_content_monitored": true,
"is_outofband": false,
"pid": 2310,
"bitrate_min": 0,
"bitrate_max": 0,
"is_scrambled": false,
"is_pcr": false
},
{
"content_type": "Other",
"is_monitored": true,
"is_content_monitored": true,
"is_outofband": false,
"pid": 2311,
"bitrate_min": 0,
"bitrate_max": 0,
"is_scrambled": false,
"is_pcr": false
},
{
"content_type": "Other",
"is_monitored": true,
"is_content_monitored": true,
"is_outofband": false,
"pid": 2312,
"bitrate_min": 0,
"bitrate_max": 0,
"is_scrambled": false,
"is_pcr": false
},
{
"content_type": "Other",
"is_monitored": true,
"is_content_monitored": true,
"is_outofband": false,
"pid": 2313,
"bitrate_min": 496997,
"bitrate_max": 496997,
"is_scrambled": false,
"is_pcr": false
},
{
"content_type": "Audio",
"is_monitored": true,
"is_content_monitored": true,
"is_outofband": false,
"pid": 2319,
"bitrate_min": 420389,
"bitrate_max": 420389,
"is_scrambled": false,
"is_pcr": false
}
],
"Receivers": [
{
"uuid": "a2ae2a30-8e07-40d6-bd98-78714c79afe7",
"stream_type": "MPEG-TS/Video",
"program_number": 6940,
"enabled": true,
"network": [
{
"multicast_ip": "239.10.10.20",
"interface_ip": "192.168.10.137",
"source_ip": null,
"multicast_port": 2000
},
{
"multicast_ip": null,
"interface_ip": null,
"source_ip": null,
"multicast_port": null
}
]
}
]
}
]
}
}
DataFields
Field | Type | Description |
Channel:uuid | UUID | Parent channel identifier |
Channel:Profiles:Receivers:uuid | UUID | Receiver essence identifier |
Channel:Profiles:Receivers:stream_type | Enum:String | Receiver type out of 21110-10/21110-20/21110-30/MPEG-TS |
Channel:Profiles:Receivers:network:interface_ip | IP | Interface IP from which the stream would be joined |
Channel:Profiles:Receivers:network:multicast_ip | IP | Source stream multicast address |
Channel:Profiles:Receivers:network:multicast_port | Port | Source stream multicast port |
Channel:Profiles:Receivers:network:source_ip | IP | Source IP address for SSM based IGMP |