Control receivers network connectivity
API URL Structure
GET http://{host}/api/4.0/receivers/.json
GET http://{host}/api/4.0/receivers/{receiver_uuid}/.json
Retrieve list/single of available system receivers and their associated network configuration.
Returned data structure
{
"Receiver": {
"receiver_uuid": "9af52a6f-6b25-4e0b-ad40-860c42aab8d7",
"receiver_label": "LEE_ICE_CH16-256",
"channel_uuid": "1b3cc4c7-7800-4857-9bcb-b25777771257",
"channel_label": "LEE_ICE_CH16",
"enabled": true,
"sdp_file": null,
"stream_type": "MPEG-TS/Video",
"program_number": 1,
"network": [
{
"multicast_ip": "239.10.10.25",
"interface_ip": "192.168.10.212",
"source_ip": "0.0.0.0",
"multicast_port": 2000
},
{
"multicast_ip": "0.0.0.0",
"interface_ip": null,
"source_ip": "0.0.0.0",
"multicast_port": 0
}
]
}
}
DataFields
Field | Type | Description |
Receiver:channel_uuid | UUID | Parent channel identifier |
Receiver:receiver_uuid | UUID | Receiver essence identifier |
Receiver:stream_type | Enum:String | Receiver type out of 21110-10/21110-20/21110-30 |
Receiver:sdp_file | String | The sender SDP file data |
Receiver:network:interface_ip | IP | Interface IP from which the stream would be joined |
Receiver:network:multicast_ip | IP | Source stream multicast address |
Receiver:network:multicast_port | Port | Source stream multicast port |
Receiver:network:source_ip | IP | Optional, Source IP address for SSM based IGMP |
API URLStructure
PUT http://{host}/api/4.0/receivers/{receiver_uuid}/.json
Update a receiver connectivity & configuration. The full tree should be submitted.
Submitted data structure:
{
"Receiver": {
"receiver_uuid": "af0b8425-96b4-4e1f-9c35-6d5763d5707f",
"enabled": true,
"sdp_file": {
"data":"v=0\r\no=- 1496222842 1496222842 IN IP4 172.29.226.25\r\ns=IPStudio Stream\r\nt=0 0\r\nm=video 5010 RTP/AVP 103\r\nc=IN IP4 232.250.98.80/32\r\na=source-filter:incl IN IP4 232.250.98.80 172.29.226.25\r\na=rtpmap: 103 raw/90000\r\na=fmtp: 103 sampling=YCbCr-4: 2: 2; width=1920; height=1080; depth=10; interlace=1; framerate=25; colorimetry=BT709-2\r\na=mediaclk:direct=1876655126 rate=90000\r\na=extmap: 1 urn:x-nmos:rtp-hdrext:origin-timestamp\r\na=extmap: 2 urn:ietf:params:rtp-hdrext:smpte-tc 3600@90000/25\r\na=extmap: 3 urn:x-nmos:rtp-hdrext:flow-id\r\na=extmap: 4 urn:x-nmos:rtp-hdrext:source-id\r\na=extmap: 5 urn:x-nmos:rtp-hdrext:grain-flags\r\na=extmap: 7 urn:x-nmos:rtp-hdrext:sync-timestamp\r\na=extmap: 9 urn:x-nmos:rtp-hdrext:grain-duration\r\na=ts-refclk:ptp=IEEE1588-2008: 08-00-11-FF-FE-21-E1-B0\r\n"
},
"network": [
{
"interface_ip": "192.168.200.15",
"multicast_ip": "232.105.26.179",
"source_ip": "232.105.26.177",
"multicast_port": 5000
},
{
"interface_ip": "192.168.201.15",
"multicast_ip": "232.105.26.179",
"source_ip": "232.105.26.178",
"multicast_port": 5000
}
]
}
}
DataFields
Field | Type | Description |
Receiver:receiver_uuid | UUID | Receiver essence identifier |
Receiver:sdp_file | String | The sender SDP file data |
Receiver:network:interface_ip | IP | Interface IP from which the stream would be joined |
Receiver:network:multicast_ip | IP | Source stream multicast address |
Receiver:network:multicast_port | Port | Source stream multicast port |
Receiver:network:source_ip | IP | Source IP address for SSM based IGMP |
Receiver:network:source_ip | IP | Optional, Source IP address for SSM based IGMP |