Control senders network connectivity

API URL Structure

GET http://{host}/api/4.0/senders/.json

GET http://{host}/api/4.0/senders/{sender_uuid}/.json

Retrieve list/single of available system senders and their associated network configuration.

Returned data structure

{
    "Sender": {
        "sender_uuid": "5dfa7956-04a4-440a-931e-c1da3d33b322",
        "sender_label": "abc6_uncom_video",
        "output_uuid": "31deebbf-4661-4edc-9a9b-4027fd646be0",
        "output_label": "abc6",
        "stream_type": "2110-20",
        "enabled": false,
        "sdp_file": "",
        "network": [
            {
                "ttl": "16",
                "interface_ip": "192.168.10.137",
                "destination_ip": "227.0.5.5",
                "destination_port": "2000"
            },
            {
                "ttl": "16",
                "interface_ip": "10.0.1.66",
                "destination_ip": "228.0.6.6",
                "destination_port": "2000"
            }
        ]
    }
}

DataFields

Field	Type	Description
Sender:output_uuid	UUID	Parent output identifier
Sender:sender_uuid	UUID	Sender essence identifier
Sender:stream_type	Enum:String	Sender type out of 21110-10/21110-20/21110-30/MPEG-TS
Sender:network:interface_ip	IP	Interface IP from which the stream would be streamed
Sender:network:destination_ip	IP	Destination stream multicast address
Sender:network:destination_port	Port	Destination stream multicast port

API URLStructure

PUT http://{host}/api/4.0/senders/{sender_uuid}/.json

Update a sender network connectivity. The full tree should be submitted.

Submitted data structure:

{
    "Sender": {
        "sender_uuid": "6b61fd29-249a-456d-b437-8cbd0d38187f",
        "enabled": true,
        "network": [
            {
                "interface_ip": "192.168.200.15",
                "destination_ip": "232.105.26.177",
                "destination_port": 5000
            },
            {
                "interface_ip": "192.168.201.15",
                "destination_ip": "232.105.26.177",
                "destination_port": 5000
            }
        ]
    }
}

DataFields

Field	Type	Description
Sender:sender_uuid	UUID	Sender essence identifier
Sender:network:interface_ip	IP	Interface IP from which the stream would be streamed
Sender:network:destination_ip	IP	Destination stream multicast address
Sender:network:destination_port	Port	Destination stream multicast port