Versions Compared

Key

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

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":

...

 {
        "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":

...

"stream_type":"2110-30",
"enabled":true,

"bit_per_sample":"16 bit",

"channel_mapping":"5.1+2",

"network":[
{
"interface_ip":"192.168.200.15",
"multicast_ip":"232.105.26.178",
"multicast_port":5000
},
{
"interface_ip":"192.168.201.15",
"multicast_ip":"232.105.26.178",
"multicast_port":5000
}
]
},
{
"uuid":"2348f537-dbc7-42c6-93ab-f4c47bd74b9d",
"stream_type":"2110-30",
"enabled":true,
"bit_per_sample":"16 bit",
"channel_mapping":"5.1+2",
"network":[
{
"interface_ip":"192.168.200.15",

"multicast_ip":"232.105.26.179",

"multicast_port":5000
},
{
"interface_ip":"192.168.201.15",

"multicast_ip":"232.105.26.179",

...

 [
                    {
                        "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

TypeDescription

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