Versions Compared

Version Old Version 1 New Version Current
Changes made by

Ramya Raman

Ramya Raman

Saved on

Key

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

Version 6.0.4 onwards, MCM9000 supports capitalization of UUID and escape single quote on API 4.1.

GET receivers

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of receiver configuration data.

Resource URL

http://{host}/api/4.1/receivers/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/receivers/.json

Code Block
languagejson
[ {

Version 6.0.4 onwards, MCM9000 supports API 4.1.

API 4.1 is a replica of API 4.0 that allows,

  • Capitalization of UUID. For example, uuid : A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9

  • Allows single quotes. For example, don't care and dont care will be considered same.

Version 6.0.5 onwards MCM9000 supports, JXS TR-07 and TR-08 code type on API 4.1.

GET receivers

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of receiver configuration data.

Resource URL

http://{host}/api/4.1/receivers/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/receivers/.json

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        "Receiver": {
            "receiver_uuid": "007FA955-7AEB-41EE-AFE9-424B6BD5574D",
            "receiver_label": "6945_1-2318",
            "channel_uuid": "A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9",
            "channel_label": "6945_1",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "MPEG-TS/Video",
            "program_number": 6945,
            "network": [
                {
                    "multicast_ip": "238.20.20.20",
                    "interface_ip": "192.168.10.132",
                    "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
                }
            ]
        }
    },
    {
        "Receiver": {
            "receiver_uuid": "1225DEC3-0B91-4B9F-A42C-047CD48C7A7A",
            "receiver_label": "mdash_1-7001",
            "channel_uuid": "89E451E5-42D7-4978-9514-C5A562ACB6E3",
            "channel_label": "mdash_1",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "MPEG-DASH/Video",
            "url": "https://tv2-play-ew-live-aws-arn-dash.secure.footprint.net/__cl/cg:live/__c/tv2_fyn/__op/nd/__f/dash.mpd",
            "index": "video_1_720p5400",
            "attributes": {
                "bandwidth": 5400000,
                "codecs": "avc1.640020",
                "audio": null,
                "resolution": "1280x720"
            },
            "network": [
                {
                    "interface_ip": "192.168.10.132"
                }
            ]
        }
    },
    {
        "Receiver": {
            "receiver_uuid": "A9ED621C-B9D2-4627-B29E-6B59D8E8F09C",
            "receiver_label": "News-HD-501",
            "channel_uuid": "39CC542B-A530-4237-8627-832AD883E391",
            "channel_label": "News-HD",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "MPEG-TS/Video",
            "program_number": 5,
            "network": [
                {
                    "multicast_ip": "239.10.10.20",
                    "interface_ip": "192.168.10.132",
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                },
                {
                    "multicast_ip": "225.0.1.1",
                    "interface_ip": null,
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                }
            ]
        }
    },
    {
        "Receiver": {
            "receiver_uuid": "BD4AF8BE-0669-4D0A-A59B-D9363BDDFD4F",
            "receiver_label": "kan_3-7001",
            "channel_uuid": "A9501290-24B6-471B-A593-7FC52732A859",
            "channel_label": "kan_3",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "HLS/Video",
            "url": "https://kanlivep2event-i.akamaihd.net/hls/live/765937/765937/master.m3u8",
            "variant_url": "https://kanlivep2event-i.akamaihd.net/hls/live/765937/765937/source1_350/chunklist.m3u8",
            "attributes": {
                "bandwidth": 600000,
                "codecs": "avc1.77.21,mp4a.40.2",
                "audio": null,
                "resolution": "426x240"
            },
            "network": [
                {
                    "interface_ip": "192.168.10.132"
                }
            ]
        }
    },
    {
        "Receiver": {
            "receiver_uuid": "C89EAC11-8CA3-4C27-BD17-DBF225595CA8",
            "receiver_label": "BBC 1 CI-2315",
            "channel_uuid": "4AD1E355-1895-444C-A1DA-DA808D406853",
            "channel_label": "BBC 1 CI",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "MPEG-TS/Video",
            "program_number": 6904,
            "network": [
                {
                    "multicast_ip": "239.10.10.20",
                    "interface_ip": "192.168.10.132",
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                },
                {
                    "multicast_ip": "225.0.1.1",
                    "interface_ip": null,
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                }
            ]
        }
    }
]

 

  

GET receivers/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific receiver configuration data.

Resource URL

http://{host}/api/4.1/receivers/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired receiver.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/receivers/007FA955-7AEB-41EE-AFE9-424B6BD5574D/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Receiver": {
        "receiver_uuid": "007FA955-7AEB-41EE-AFE9-424B6BD5574D",
        "receiver_label": "6945_1-2318",
        "channel_uuid": "A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9",
        "channel_label": "6945_1",
        "enabled": true,
        "sdp_file": null,
        "stream_type": "MPEG-TS/Video",
        "program_number": 6945,
        "network": [
            {
                "multicast_ip": "238.20.20.20",
                "interface_ip": "192.168.10.132",
                "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
            }
        ]
    }
}

 

 

PUT receivers/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates the network configuration in the receivers.

Resource URL

http://{host}/api/4.1/receivers/{uuid}/.format

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired receiver to be updated.

Example Request

PUT 

  1. http://192.168.10.132/api/4.1/receivers/A9ED621C-B9D2-4627-B29E-6B59D8E8F09C/.json

Expand
titleBODY
Code Block
languagejson
{
        "Receiver": {
            "receiver_label": "News-HD-501",
            "channel_label": "News-HD",
            "enabled": true,
            "sdp_file": null,
            "stream_type": "MPEG-TS/Video",
            "program_number": 5,
            "network": [
                {
                    "multicast_ip": "239.10.10.21",
                    "interface_ip": "192.168.10.132",
                    "source_ip": "0.0.0.0",
                    "multicast_port": 1000
                },
                {
                    "multicast_ip": "225.0.1.1",
                    "interface_ip": null,
                    "source_ip": "0.0.0.0",
                    "multicast_port": 2000
                }
            ]
        }
    }
Expand
titleRESPONSE
Code Block
languagejson
{
    "Receiver": {
        "receiver_uuid": "A9ED621C-B9D2-4627-B29E-6B59D8E8F09C",
        "receiver_label": "News-HD-501",
        "channel_uuid": "39CC542B-A530-4237-8627-832AD883E391",
        "channel_label": "News-HD",
        "enabled": true,
        "sdp_file": null,
        "stream_type": "MPEG-TS/Video",
        "program_number": 5,
        "network": [
            {
                "multicast_ip": "239.10.10.21",
                "interface_ip": "192.168.10.132",
                "source_ip": "0.0.0.0",
                "multicast_port": 1000
            },
            {
                "multicast_ip": "225.0.1.1",
                "interface_ip": null,
                "source_ip": "0.0.0.0",
                "multicast_port": 2000
            }
        ]
    }
}

 

 

GET senders

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of senders configuration data.

Resource URL

http://{host}/api/4.1/senders/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/senders/.json

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        "Sender": {
            "sender_uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
            "sender_label": "Enc1_ts",
            "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
            "output_label": "Enc1",
            "stream_type": "MPEG-TS",
            "enabled": true,
            "sdp_file": "v=0\r\no=- 1669543738 1669543738 IN IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\nm=video 2000 UDP 33\r\nc=IN IP4 225.0.3.3/32\r\na=source-filter:incl IN IP4 225.0.3.3 192.168.10.132\r\na=program:1",
            "network": [
                {
                    "ttl": "16",
                    "interface_ip": "192.168.10.132",
                    "destination_ip": "225.0.3.3",
                    "destination_port": "2000"
                },
                {
                    "ttl": "16",
                    "interface_ip": null,
                    "destination_ip": "226.0.4.4",
                    "destination_port": "2000"
                }
            ]
        }
    },
    {
        "Sender": {
            "sender_uuid": "2F309F30-B3AE-46CC-B04C-745BC3000F0F",
            "sender_label": "Enc1_uncom_video",
            "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
            "output_label": "Enc1",
            "stream_type": "2110-20",
            "enabled": false,
            "sdp_file": "",
            "network": [
                {
                    "ttl": "16",
                    "interface_ip": "192.168.10.132",
                    "destination_ip": "227.0.5.5",
                    "destination_port": "2000"
                },
                {
                    "ttl": "16",
                    "interface_ip": null,
                    "destination_ip": "228.0.6.6",
                    "destination_port": "2000"
                }
            ]
        }
    },
    {
        "Sender": {
            "sender_uuid": "69B830B0-5990-4D27-A482-9650EBC54447",
            "sender_label": "Enc1_uncom_audio",
            "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
            "output_label": "Enc1",
            "stream_type": "2110-30",
            "enabled": false,
            "sdp_file": "",
            "network": [
                {
                    "ttl": "16",
                    "interface_ip": "192.168.10.132",
                    "destination_ip": "229.0.7.7",
                    "destination_port": "2001"
                },
                {
                    "ttl": "16",
                    "interface_ip": null,
                    "destination_ip": "230.0.8.8",
                    "destination_port": "2001"
                }
            ]
        }
    }
]

 

   

GET senders/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific senders configuration data.

Resource URL

http://{host}/api/4.1/senders/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired senders.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Sender": {
        "sender_uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
        "sender_label": "Enc1_ts",
        "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
        "output_label": "Enc1",
        "stream_type": "MPEG-TS",
        "enabled": true,
        "sdp_file": "v=0\r\no=- 1669543738 1669543738 IN IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\nm=video 2000 UDP 33\r\nc=IN IP4 225.0.3.3/32\r\na=source-filter:incl IN IP4 225.0.3.3 192.168.10.132\r\na=program:1",
        "network": [
            {
                "ttl": "16",
                "interface_ip": "192.168.10.132",
                "destination_ip": "225.0.3.3",
                "destination_port": "2000"
            },
            {
                "ttl": "16",
                "interface_ip": null,
                "destination_ip": "226.0.4.4",
                "destination_port": "2000"
            }
        ]
    }
}

 

 

PUT senders/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates the network configuration in the senders.

Resource URL

http://{host}/api/4.1/senders/{uuid}/.format

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired sender to be updated.

Example Request

PUT 

  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json

Expand
titleBODY
Code Block
languagejson
{
    "Sender": {
        "sender_uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
        "sender_label": "Enc1_ts",
        "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
        "output_label": "Enc1",
        "stream_type": "MPEG-TS",
        "enabled": true,
        "sdp_file": "v=0\r\no=- 1669543738 1669543738 IN IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\nm=video 2000 UDP 33\r\nc=IN IP4 225.0.3.3/32\r\na=source-filter:incl IN IP4 225.0.3.3 192.168.10.132\r\na=program:1",
        "network": [
            {
                "ttl": "16",
                "interface_ip": "192.168.10.132",
                "destination_ip": "225.0.3.2",
                "destination_port": "1000"
            },
            {
                "ttl": "16",
                "interface_ip": null,
                "destination_ip": "226.0.4.4",
                "destination_port": "2000"
            }
        ]
    }
}
Expand
titleRESPONSE
Code Block
languagejson
{
    "Sender": {
        "sender_uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
        "sender_label": "Enc1_ts",
        "output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
        "output_label": "Enc1",
        "stream_type": "MPEG-TS",
        "enabled": true,
        "sdp_file": "v=0\r\no=- 1669543738 1669543738 IN IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\na=group:DUP primary secondary\r\nm=video 1000 UDP 33\r\nc=IN IP4 225.0.3.2/32\r\na=source-filter:incl IN IP4 225.0.3.2 192.168.10.132\r\na=mid:primary\r\na=program:1\r\nm=video 2000 UDP 33\r\nc=IN IP4 226.0.4.4/32\r\na=source-filter:incl IN IP4 226.0.4.4 \r\na=mid:secondary\r\na=program:1",
        "network": [
            {
                "ttl": "16",
                "interface_ip": "192.168.10.132",
                "destination_ip": "225.0.3.2",
                "destination_port": "1000"
            },
            {
                "ttl": "16",
                "interface_ip": null,
                "destination_ip": "226.0.4.4",
                "destination_port": "2000"
            }
        ]
    }
}

 

 

GET Layouts

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of layouts configuration data.

Resource URL

http://{host}/api/4.1/layouts/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/layouts/.json

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        "Layout": {
            "uuid": "65141E16-70A2-4DC7-B037-81FAC3B5EB79",
            "label": "layout_test",
            "modified": "1673274371914",
            "created": "1673274354882",
            "text_mode": "Scroll",
            "background": null,
            "layout_type_uuid": "18DEB7D5-2354-405F-A179-B483DC87125F",
            "layout_type_label": "20 Channels",
            "Tiles": [
                {
                    "index": 1,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 2,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 3,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 4,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 5,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 6,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 7,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 8,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 9,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 10,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 11,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 12,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 13,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 14,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 15,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 16,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 17,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 18,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 19,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                },
                {
                    "index": 20,
                    "channel_uuid": null,
                    "channel_label": null,
                    "content_type": "Channel",
                    "umd_1": "",
                    "umd_2": "",
                    "tally_settings": null,
                    "activation_mode": "Persistent"
                }
            ]
        }
    }
]

 

   

GET layouts/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific layouts configuration data.

Resource URL

http://{host}/api/4.1/layouts/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired layouts.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/layouts/F45D9708-B192-4A30-964A-38113ED9B633/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Layout": {
        "uuid": "F45D9708-B192-4A30-964A-38113ED9B633",
        "label": "my_channel_Layout",
        "modified": "1669543739062",
        "created": "1669543737616",
        "text_mode": "Scroll",
        "background": null,
        "layout_type_uuid": "F63D13F3-4861-4B5B-AA9A-B4CE075DEF49",
        "layout_type_label": "my_Layout",
        "Tiles": [
            {
                "index": 1,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            },
            {
                "index": 2,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "#RESOLUTION#",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            },
            {
                "index": 3,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            }
        ]
    }
}

 

 

PUT layouts/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates the network configuration in the layouts.

Resource URL

http://{host}/api/4.1/layouts/{uuid}/.format

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired layouts to be updated.

Example Request

PUT 

  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json

Expand
titleBODY
Code Block
languagejson
{
    "Layout": {
        "label": "my_channel_Layout",
        "text_mode": "Scroll",
        "background": null,
        "layout_type_label": "my_Layout",
        "Tiles": [
            {
                "index": 1,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            },
            {
                "index": 2,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "#RESOLUTION#",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            },
            {
                "index": 3,
                "channel_uuid": null,
                "channel_label": null,
                "content_type": "Channel",
                "umd_1": "",
                "umd_2": "",
                "tally_settings": null,
                "activation_mode": "Persistent"
            }
        ]
    }
}
Expand
titleRESPONSE
Code Block
languagejson
{
    "Layout": {
        "uuid": "F45D9708-B192-4A30-964A-38113ED9B633",
        "label": "my_channel_Layout",
        "modified": "1670834516415",
        "created": "1669543737616",
        "
Receiver
text_mode":
{
"Scroll",
        "background": null,
        "
receiver
layout_type_uuid": "
007FA955
F63D13F3-
7AEB
4861-
41EE
4B5B-
AFE9
AA9A-
424B6BD5574D
B4CE075DEF49",

        
"
receiver
layout_type_label": "
6945
my_
1-2318
Layout",
        "Tiles": [
"channel_uuid": "A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9",
   {
                "
channel_label
index":
"6945_
1
"
,
"enabled
   "channel_uuid":
true
null,
                "
sdp
channel_
file
label": null,
                "
stream
content_type": "
MPEG-TS/Video
Channel",
                "
program
umd_
number
1":
6945
"",
"network
    "umd_2":
[
"",
{ 
"tally_settings": null,
                
"
multicast
activation_
ip
mode": "
238.20.20.20",
Persistent"
            },
"interface_ip":
"192.168.10.132",
    {
                "
source_ip
index":
"0.0.0.0", 
2,
                "
multicast
channel_
port
uuid":
2000
null,
}
"channel_label": null,
{ 
"content_type": "Channel",
                
"
multicast
umd_
ip
1": "
0.0.0.0
#RESOLUTION#",

                
"
interface
umd_
ip
2":
null
"",
                
"
source
tally_
ip
settings":
"0.0.0.0"
null,
                
"
multicast
activation_
port
mode":
0
"Persistent"
            },
}
         {
]
}
    "index":
}
3,
{
          "
Receiver
channel_uuid":
{
null,
                "
receiver
channel_
uuid
label":
"1225DEC3-0B91-4B9F-A42C-047CD48C7A7A",
null,
                "
receiver
content_
label
type": "
mdash_1-7001
Channel",
                "
channel
umd_
uuid
1": "
89E451E5-42D7-4978-9514-C5A562ACB6E3
",
                "
channel
umd_
label
2": "
mdash_1
",
                "
enabled
tally_settings":
true
null,
                "
sdp
activation_
file
mode":
null,
"Persistent"
            }
"stream_type":
"MPEG-DASH/Video",
       ]
"url": "https://tv2-play-ew-live-aws-arn-dash.secure.footprint.net/__cl/cg:live/__c/tv2_fyn/__op/nd/__f/dash.mpd", "index": "video_1_720p5400", "attributes": { "bandwidth": 5400000, "codecs": "avc1.640020", 
}
}

 

  

GET layout_types

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific layout_types configuration data.

Resource URL

http://{host}/api/4.1/layout_types/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/layout_types/.json

View file
nameLayout_types.json

 

 

GET channels/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of channels configuration data.

Resource URL

http://{host}/api/4.1/channels/config/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/channels/config/.json

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        
"
audio
Channel":
null,
{
            
"
resolution
uuid": "
1280x720" }
965FFA9A-0C0C-43F1-A448-AD224AE45E30",
            "
network": [ { "interface_ip": "192.168.10.132"
title": "test_channel1",
            "modified": "1673274481541",
}
          "created": "1673274481535",
]
}
}
"access_type": "MPTS",
{
"Receiver
"snooze_on_profile_change":
{
10,
            "
receiver
service_
uuid
type": "
A9ED621C-B9D2-4627-B29E-6B59D8E8F09C
SD Video",
            "
receiver_label
enabled":
"News-HD-501"
false,
            "
channel
device_
uuid
id":
"39CC542B-A530-4237-8627-832AD883E391"
null,
            "
channel_label
note": "
News-HD
",
            "
enabled
tally_settings":
true
"",
            "
sdp_file
Profiles":
null,
 [
                {
"stream_type":
"MPEG-TS/Video",
             "
program_number
uuid":
5
"E7206FE6-1A24-40A6-BB9A-F68383EAA0B8",
"network":
[
       
"label": "Default",
{
"multicast_ip
"notification_set_uuid": "
239.10.10.20
F3A31BC3-E53F-4B63-9605-CD0B6121E602",
                    "
interface
notification_set_
ip
label": "
192.168.10.132
Default",
                    "
source
threshold_set_
ip
uuid": "
0.0.0.0
B026DD10-9B84-42DB-805A-16F1E97B10DA",
                    "
multicast
threshold_set_
port
label":
2000
 "Default",
}
"is_default": true,
{
     "title_color": "Default",
                    "
multicast
border_
ip
color": "
225.0.1.1
Default",
                    "
interface
pixelate_
ip
level":
null
"None",
"source_ip": "0.0.0.0"
"Components": [],
                    "
multicast_port
Receivers":
2000
[
}
        {
]
}
},
{
         "
Receiver
uuid":
{
null,
"receiver_uuid":
"BD4AF8BE-0669-4D0A-A59B-D9363BDDFD4F",
             "
receiver
stream_
label
type": "
kan_3-7001
MPEG-TS/Video",
"channel_uuid": "A9501290-24B6-471B-A593-7FC52732A859",
               "
channel
program_
label
number":
"kan_3",
200,
"enabled":
true,
             "
sdp_file
enabled":
null
false,
"stream_type": "HLS/Video",
                "
url
network":
"https://kanlivep2event-i.akamaihd.net/hls/live/765937/765937/master.m3u8",
[
"variant_url":
"https://kanlivep2event-i.akamaihd.net/hls/live/765937/765937/source1_350/chunklist.m3u8",
"attributes":
 {
"bandwidth":
600000,
                 "
codecs
multicast_ip": "
avc1
224.
77
0.
21,mp4a.40.2
1.1",
"audio": null,
                    "
resolution
interface_ip":
"426x240"
 null,
},
             "
network
source_ip":
[
null,
{
                    
"
interface
multicast_
ip
port":
"192.168.10.132"
 1000
                                },
]
                {
}
},
{
"Receiver":
{
             "
receiver
multicast_
uuid
ip":
"C89EAC11-8CA3-4C27-BD17-DBF225595CA8",
null,
"receiver_label": "BBC 1 CI-2315",
"channel_uuid":
"4AD1E355-1895-444C-A1DA-DA808D406853",
     "interface_ip": null,
"channel_label":
"BBC
1
CI",
"enabled":
true,
             "
sdp
source_
file
ip": null,
"stream_type":
"MPEG-TS/Video",
"program_number":
6904,
             "
network
multicast_port": null
[
{
               }
"multicast_ip":
"239.10.10.20",
"interface_ip": "192.168.10.132",
 ]
"source_ip":
"0.0.0.0", 
 }
"multicast_port": 2000
 ]
                }
,

            ]
{
     }
    },
    {
        "
multicast_ip
Channel":
"225.0.1.1",
{
            "uuid": "96B18BA8-8342-42A4-986A-555EAA80FCCC",
            "
interface_ip
title":
null
"uncompressed",
            "modified": "1673274492923",
            "
source_ip
created": "
0.0.0.0
1673274492918",
            "access_type": "Uncompressed",
"multicast_port
   "snooze_on_profile_change":
2000
10,
            "service_type":
}
"HD Video",
] 
"enabled": false,
}
} ]

 

  

GET receivers/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific receiver configuration data.

Resource URL

http://{host}/api/4.1/receivers/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired receiver.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/receivers/007FA955-7AEB-41EE-AFE9-424B6BD5574D/.json

Code Block
languagejson
{ "Receiver": {
"device_id": null,
            "
receiver_uuid
note": "
007FA955-7AEB-41EE-AFE9-424B6BD5574D
",
            "
receiver
tally_
label
settings": "
6945_1-2318
",
"channel_uuid": "A498AEB9-5F00-4CA9-B68F-7DA97E7E6DA9",
    "Profiles": [
                {
                    "
channel_label
uuid": "
6945_1
D135CA65-EAAD-4F77-BF71-D746BB2927FA",
"enabled": true,
            "
sdp_file
label":
null
"Default",
"stream_type":
"MPEG-TS/Video",
         "
program
notification_set_
number
uuid":
6945
"F3A31BC3-E53F-4B63-9605-CD0B6121E602",
"network": [
            "notification_set_label": "Default",
{
                 "
multicast
threshold_set_
ip
uuid": "
238.20.20.20
B026DD10-9B84-42DB-805A-16F1E97B10DA",
"interface_ip
    "threshold_set_label": "
192.168.10.132
Default",
                    "
source
is_
ip
default":
"0.0.0.0",
true,
                    "
multicast
title_
port
color":
2000
"Default",
},
        "border_color": "Default",
{
                 "
multicast
pixelate_
ip
level": "
0.0.0.0
None",
                    "
interface_ip
Receivers":
null
[],
"source_ip
    "Components":
"0.0.0.0",
[]
"multicast_port": 0
}
}
]
]
}
    }
}
]

 

 

PUT receivers

   

GET channels/config/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates the network configuration in the receivers

GET

Returns a single specific channels configuration data.

Resource URL

http://{host}/api/4.1/receiverschannels/config/{uuidid}/.format

Parameters

Parameter

Data Type

Description

Descriptionuu

uuid
(required)

string

The UUID of the desired

receiver to be updated

channel configuration.

Example Request

PUTGET 

  1. http://192.168.10.132/api/4.1/receivers/A9ED621C-B9D2-4627-B29E-6B59D8E8F09C/.json

Body:

Code Block
languagejson
{

  1. /channels/config/F45D9708-B192-4A30-964A-38113ED9B633/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "Channel": {
        "uuid": "965FFA9A-0C0C-43F1-A448-AD224AE45E30",
        "title": "test_channel1",
        "modified": "1673274481541",
        "created": "1673274481535",
        "
Receiver
access_type":
{
"MPTS",
        "snooze_on_profile_change": 10,
        "
receiver
service_
uuid
type": "
A9ED621C-B9D2-4627-B29E-6B59D8E8F09C
SD Video",
        "enabled": false,
        "
receiver_label
device_id": null,
        "note": "
News-HD-501
",
        "tally_settings": "",
        "
channel_uuid
Profiles":
"39CC542B-A530-4237-8627-832AD883E391",
 [
            {
                "
channel_label
uuid": "
News-HD",
E7206FE6-1A24-40A6-BB9A-F68383EAA0B8",
                "
enabled
label":
true
"Default",
"sdp_file
    "notification_set_uuid":
null
"F3A31BC3-E53F-4B63-9605-CD0B6121E602",
"stream_type
    "notification_set_label": "
MPEG-TS/Video
Default",
"program_number
    "threshold_set_uuid":
5
"B026DD10-9B84-42DB-805A-16F1E97B10DA",
"network
    "threshold_set_label":
[
"Default",
{ 
"is_default": true,
                
"
multicast
title_
ip
color": "
239.10.10.21
Default",
"interface_ip":
"192.168.10.132",
   "border_color": "Default",
                "
source
pixelate_
ip
level": "
0.0.0.0
None",
                "Components": [],
"multicast_port":
1000
             "Receivers": [
},
                  {
"multicast_ip
    "uuid":
"225.0.1.1",
null,
                        "
interface
stream_
ip
type":
null,
"MPEG-TS/Video",
                        "
source
program_
ip
number":
"0.0.0.0",
200,
                        "
multicast_port
enabled":
2000
false,
}
        "network": 
[
]
}
}

Response:

Code Block
languagejson
{
"Receiver":
{
       {
"receiver_uuid": "A9ED621C-B9D2-4627-B29E-6B59D8E8F09C",
"receiver_label":
"News-HD-501",
"channel_uuid":
"39CC542B-A530-4237-8627-832AD883E391",
         "
channel
multicast_
label
ip": "
News-HD
224.0.1.1",
"enabled": true,
"sdp_file":
null,
         "
stream
interface_
type
ip":
"MPEG-TS/Video"
null,
"program_number":
5,
"network":
[
{ 
"source_ip": null,
"multicast_ip": "239.10.10.21",
                 "
interface
multicast_
ip
port":
"192.168.10.132", 
1000
"source_ip":
"0.0.0.0",
"multicast_port": 1000
},
},
{
  {
"multicast_ip":
"225.0.1.1",
                 "
interface
multicast_ip": null,
"source_ip":
"0.0.0.0",
               
"
multicast
interface_
port
ip":
2000
 null,
}
]
} }

 

 

GET senders

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of senders configuration data.

Resource URL

http://{host}/api/4.1/senders/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/senders/.json

Code Block
languagejson
[
 "source_ip": null,
{
"Sender":
{
             "
sender
multicast_
uuid
port":
"5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
null
"sender_label": "Enc1_ts",
}
"output_uuid":
"880D1D99-0066-422E-BA42-2541E515D662",
          ]
"output_label":
"Enc1",
"stream_type":
"MPEG-TS",
   }
"enabled":
true,
      ]
"sdp_file":
"v=0\r\no=-
1669543738
1669543738
IN
IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\nm=video 2000 UDP 33\r\nc=IN IP4 225.0.3.3/32\r\na=source-filter:incl IN IP4 225.0.3.3 192.168.10.132\r\na=program:1", 
 }
        ]
    }
}

 

GET outputs/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of outputs configuration data.

Resource URL

http://{host}/api/4.1/outputs/config/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/outputs/config/.json

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        "
network
Output":
[ 
{
"ttl
"uuid": "
16", 
880D1D99-0066-422E-BA42-2541E515D662",
            "
interface_ip
label": "
192.168.10.132
Enc1",
"destination_ip
"modified": "
225.0.3.3
1670833362762",

            
"
destination_port
created": "
2000
1669543737686",
            "enabled": true,
},
          "device_id": 9232,
{
       "resolution": "1920x1080",
            "
ttl": "16", 
enable_alarms_display": true,
            
"
interface
input_loss_
ip
mode":
null
"Icon",
"destination_ip
"frame_rate": "
226.0.4.4
25 fps",
"destination_port
"layout_change_interval":
"2000"
null,
            "Senders": [
}
]
 {
}
},
{
   "uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
"Sender": {
                "
sender
stream_
uuid
type": "
2F309F30-B3AE-46CC-B04C-745BC3000F0F",
MPEG-TS",
                    "
sender_label
enabled":
"Enc1_uncom_video",
true,
                    "
output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
transport_stream_id": 1,
                    "
output
transport_
label
mode": "
Enc1
SPTS/UDP",
"stream_type
        "vbv_limit":
"2110-20"
null,
"enabled
        "enable_interlaced":
false
true,
"sdp_file":
"",
       "enable_deblocking": true,
"network":
[
{
"program_number": 1,
                    "
ttl
ts_per_ip":
"16"
7,
                    "
interface
enable_null_
ip
padding":
"192.168.10.132"
true,
                    "
destination
pmt_
ip
pid":
"227.0.5.5"
200,
                    "
destination
video_
port
pid":
"2000"
 201,
                    "transcoded_audio_pid": 0,
},
{
"passthrough_audio_pid": 0,
                    "
ttl
min_chunk_length":
"16"
2,
                    "
interface
number_of_
ip
chunks":
null
3,
                    "
destination
hls_index_
ip
interval":
"228.0.6.6"
null,
                    "
destination
enable_
port
downscale":
"2000"
false,
}
    "enable_ratescale": false,
]
}
}
"codec_type": "H.264",
{
"Sender":
{
      "video_bitrate": 14000000,
"sender_uuid":
"69B830B0-5990-4D27-A482-9650EBC54447",
             "
sender
jxs_
label
bitrate":
"Enc1_uncom_audio"
0,
"output_uuid": "880D1D99-0066-422E-BA42-2541E515D662",
        "gop_size_mode": "Static, IPB Frames",
"output_label":
"Enc1",
             "
stream
gop_
type
size": "
2110-30
24",
"enabled":
false,
"sdp_file
"network": [
"",
"network":
[
         {
{
                     "ttl": "16",
                            "interface_ip": "192.168.10.132",
                            "destination_ip": "
229
225.0.
7
3.
7
2",
"destination_port":
"2001"
       "destination_port": 1000
},
                },
{
"ttl":
"16",
  
{
"interface_ip":
null,
                   
"
destination_ip
ttl": "
230.0.8.8
16",
"destination_port": "2001"
                 "interface_ip": false,
}
]
}
} ]

 

   

GET senders/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific senders configuration data.

Resource URL

http://{host}/api/4.1/senders/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired senders.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json

Code Block
languagejson
{ "Sender": {
 "destination_ip": "226.0.4.4",
                            "
sender
destination_
uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
port": 2000
                        }
                    ]
                },
                {
"sender_label": "Enc1_ts",
                  "
output_
uuid": "
880D1D99
2F309F30-
0066
B3AE-
422E
46CC-
BA42
B04C-
2541E515D662
745BC3000F0F",
"output_label": "Enc1",
            "stream_type": "
MPEG-TS
2110/Video",
                    "enabled":
true
false,
"sdp_file
            "uhd_mode": "
v=0\r\no=- 1669543738 1669543738 IN IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\nm=video 2000 UDP 33\r\nc=IN IP4 225.0.3.3/32\r\na=source-filter:incl IN IP4 225.0.3.3 192.168.10.132\r\na=program:1
HD-SDI (Interlaced)",
                    "latency_mode": "5 Frames",
"network":
[
           "payload_type": 0,
{
                   "
ttl
avoid_c_bit":
"16"
false,
"interface_ip": "192.168.10.132",
    "network": [
                        {
                            "
destination_ip
ttl": "
225.0.3.3
16",
"destination_port":
"2000"
}, 
"interface_ip": "192.168.10.132",
{
                 "
ttl
destination_ip": "
16", 
227.0.5.5",
"interface_ip":
null,
                 "destination_
ip
port":
"226.0.4.4",
 2000
"destination_port":
"2000"
     },
}
]
} }

 

 

PUT senders/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates the network configuration in the senders.

Resource URL

http://{host}/api/4.1/senders/{uuid}/.format

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired sender to be updated.

Example Request

PUT 

  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json

Body:

Code Block
languagejson
{
 {
                            "ttl": "16",
                            "
Sender": {
interface_ip": false,
                            "
sender
destination_
uuid
ip": "
5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
228.0.6.6",
"sender_label":
"Enc1_ts",
         "
output
destination_
uuid
port":
"880D1D99-0066-422E-BA42-2541E515D662",
2000
"output_label":
"Enc1",
"stream_type":
"MPEG-TS",
     }
"enabled":
true,
"sdp_file":
"v=0\r\no=-
1669543738
1669543738
IN
IP4
192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\nm=video 2000 UDP 33\r\nc=IN IP4 225.0.3.3/32\r\na=source-filter:incl IN IP4 225.0.3.3 192.168.10.132\r\na=program:1",
 ]
                },
"network":
[
             {
                    "
ttl
uuid": "
16
69B830B0-5990-4D27-A482-9650EBC54447",
                    "
interface
stream_
ip
type": "
192.168.10.132
2110/Audio",
"destination_ip
   "enabled":
"225.0.3.2"
false,
                    "
destination
payload_
port
type":
"1000"
0,
},
        "network": [
{
"ttl":
"16",
   {
"interface_ip":
null,
                 "
destination_ip
ttl": "
226.0.4.4",
16",
                            "
destination
interface_
port
ip": "
2000"
192.168.10.132",
}
]
} }

Response:

Code Block
languagejson
{
 "destination_ip": "229.0.7.7",
"Sender":
{
"sender_uuid":
"5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
         "
sender
destination_
label
port":
"Enc1_ts",
2001
"output_uuid":
"880D1D99-0066-422E-BA42-2541E515D662",
"output_label": "Enc1",
      },
"stream_type":
"MPEG-TS",
"enabled":
true,
"sdp_file":
"v=0\r\no=- 1669543738 1669543738 IN IP4 192.168.10.132\r\ns=Video flow generated by MCM-9000\r\nt=0 0\r\na=group:DUP primary secondary\r\nm=video 1000 UDP 33\r\nc=IN IP4 225.0.3.2/32\r\na=source-filter:incl IN IP4 225.0.3.2 192.168.10.132\r\na=mid:primary\r\na=program:1\r\nm=video 2000 UDP 33\r\nc=IN IP4 226.0.4.4/32\r\na=source-filter:incl IN IP4 226.0.4.4 \r\na=mid:secondary\r\na=program:1
 {
                            "ttl": "16",
"network":
[
{
     "interface_ip": false,
"ttl":
"16",
                 "
interface
destination_ip": "
192
230.
168
0.
10
8.
132
8",
                            "destination_
ip
port":
"225.0.3.2",
 2001
                        }
"destination_port": "1000"
 ]
},
    }
{
    ],
            "
ttl
Layouts":
"16",
 [
                {
"interface_ip": null,
"uuid": "928F2E96-EF11-4F25-9574-543E6D7CCBBF",
                    "
destination_ip
label": "
226.0.4.4",
test 789"
"destination_port": "2000"
}
            ]
}
        }
]
    
}
}
]

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of layouts configuration data.

Resource URL

http://{host}/api/4.1/layouts/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/layouts/.json

Code Block
languagejson

 

   

GET layouts/{

 

 

GET Layouts

Resource Information

   

GET outputs/config/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific layouts outputs configuration data.

Resource URL

http://{host}/api/4.1/layoutsoutputs/config/{id}/.format

Parameters

Parameter

Data Type

Descriptionuu

uuid
(required)

string

The UUID of the desired

layouts

output configuration.

Example Request

GET 

  1. http://192.168.10.132/api/4.1/layoutsoutputs/config/F45D9708880D1D99-B1920066-4A30422E-964ABA42-38113ED9B6332541E515D662/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "
Layout
Output": {
        "uuid": "
F45D9708
880D1D99-
B192
0066-
4A30
422E-
964A
BA42-
38113ED9B633
2541E515D662",
        "label": "
my_channel_Layout", "modified": "1669543739062", "created": "1669543737616", "text_mode": "Scroll", "background": null, "layout_type_uuid": "F63D13F3-4861-4B5B-AA9A-B4CE075DEF49", "layout_type_label": "my_Layout
Enc1",
        "
Tiles
modified":
[
"1670833362762",
        "created": "1669543737686",
{
      "enabled": true,
        
"
index
device_id":
1
9232,
        "resolution": "1920x1080",
        "
channel
enable_alarms_
uuid
display":
null
true,
        "input_loss_mode": "Icon",
        "
channel
frame_
label
rate":
null
"25 fps",
        "layout_change_interval": null,
        "
content_type
Senders":
"Channel",
[
"umd_1": "",
{
                
"
umd_2
uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
                "
tally
stream_
settings
type":
null
"MPEG-TS",
                "
activation_mode
enabled":
"Persistent"
true,
},
{
"transport_stream_id": 1,
                "
index
transport_mode":
2
"SPTS/UDP",
                "
channel
vbv_
uuid
limit": null,
                "
channel
enable_
label
interlaced":
null
true,
                "
content
enable_
type
deblocking":
"Channel"
true,
                "
umd
program_
1
number":
"#RESOLUTION#"
1,
                "
umd
ts_per_
2
ip":
""
7,
                "
tally
enable_null_
settings
padding":
null
true,
                "
activation
pmt_
mode
pid":
"Persistent"
200,
},
    
"video_pid": 201,
{
"index
"transcoded_audio_pid":
3
0,
                "
channel
passthrough_audio_
uuid
pid":
null
0,
                "
channel
min_chunk_
label
length":
null
2,
                "
content
number_of_
type
chunks":
"Channel"
3,
                "
umd
hls_index_
1
interval":
""
null,
                "
umd
enable_
2
downscale":
""
false,
                "
tally
enable_
settings
ratescale":
null
false,
                "
activation
codec_
mode
type": "
Persistent
H.264",
}
    "video_bitrate": 14000000,
]
} }

 

 

 

 

PUT layouts/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates the network configuration in the layouts.

Resource URL

http://{host}/api/4.1/layouts/{uuid}/.format

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired layouts to be updated.

Example Request

PUT 

  1. http://192.168.10.132/api/4.1/senders/5B21DD2C-0EAB-4DDE-8759-8D7617A01955/.json

Body:

Code Block
languagejson
{
        "
Layout
jxs_bitrate":
{
 0,
                "
uuid
gop_size_mode": "
f45d9708-b192-4a30-964a-38113ed9b633",
Static, IPB Frames",
"label
   "gop_size": "
my_channel_Layout
24",
                "
modified
network":
"1669543739062",
[
                    {
                        "
created
ttl": "
1669543737616
16",
                        "interface_ip": "192.168.10.132",
"text_mode":
"Scroll",
"background":
null,
         "
layout
destination_
type_uuid
ip": "
F63D13F3-4861-4B5B-AA9A-B4CE075DEF49
225.0.3.2",
"layout_type_label": "my_Layout",
                "
Tiles
destination_port": 1000
[
{
       },
"index":
1,
          {
"channel_uuid":
null,
                 "
channel_label
ttl":
null,
"16",
                        "
content
interface_
type
ip":
"Channel",
false,
                        "
umd
destination_
1
ip": "226.0.4.4",
                        "
umd
destination_
2
port": 2000
"",
"tally_settings":
null,
 }
"activation_mode": "Persistent"
 ]
            },
            {
                "
index
uuid":
2
"2F309F30-B3AE-46CC-B04C-745BC3000F0F",
                "
channel
stream_
uuid
type":
null
"2110/Video",
                "
channel_label
enabled":
null
false,
                "
content
uhd_
type
mode": "
Channel
HD-SDI (Interlaced)",
                "
umd
latency_
1
mode": "
#RESOLUTION#
5 Frames",
                "
umd
payload_
2
type":
""
0,
                "
tally
avoid_c_
settings
bit":
null
false,
                "
activation_mode
network":
"Persistent"
 [
},
     {
{
                 "
index
ttl":
3,
"16",
                        "
channel
interface_
uuid
ip":
null,
"192.168.10.132",
                        "
channel
destination_
label
ip":
null
"227.0.5.5",
"content_type": "Channel",
        "destination_port": 2000
"umd_1":
"",
       },
"umd_2":
"",
          {
"tally_settings":
null,
                 "
activation_mode
ttl": "
Persistent
16",
}
]
   "interface_ip": false,
}
}

Response:

Code Block
languagejson
{
"Layout":
{
"uuid":
"F45D9708-B192-4A30-964A-38113ED9B633",
       
"
label
destination_ip": "
my_channel_Layout
228.0.6.6",
"modified": "1670834516415",
                "
created
destination_port":
"1669543737616",
2000
"text_mode":
"Scroll",
"background":
null,
  }
"layout_type_uuid": "F63D13F3-4861-4B5B-AA9A-B4CE075DEF49",
          ]
"layout_type_label":
"my_Layout",
"Tiles": [
 },
            {
                "
index
uuid":
1
"69B830B0-5990-4D27-A482-9650EBC54447",
                "
channel
stream_
uuid
type":
null
"2110/Audio",
                "
channel_label
enabled":
null
false,
                "
content
payload_type":
"Channel"
0,
                "
umd_1
network":
"",
 [
                    {
"umd_2":
"",
                 "
tally_settings
ttl":
null
"16",
"activation_mode":
"Persistent"
       "interface_ip": "192.168.10.132",
},
{
       "destination_ip": "229.0.7.7",
"index":
2,
                 "
channel
destination_
uuid
port":
null,
2001
"channel_label":
null,
   },
"content_type":
"Channel",
      {
"umd_1":
"#RESOLUTION#",
"umd_2
"ttl": "16",
"tally_settings":
null,
       "interface_ip": false,
"activation_mode":
"Persistent"
},
  
"destination_ip": "230.0.8.8",
{
                 "
index
destination_port":
3, 
2001
"channel_uuid":
null,
        }
"channel_label":
null,
       
]
"content_type":
"Channel",
   }
        ],
"umd_1":
"",
    "Layouts": [
"umd_2": "",
 {
                "
tally_settings
uuid":
null
"928F2E96-EF11-4F25-9574-543E6D7CCBBF",
                "
activation_mode
label": "
Persistent
test 789"
            }
        ]
    }
}

 

  

GET layout_types

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific layout_types configuration data.

Resource URL

http://{host}/api/4.1/layout_types/.format

Example Request

GET 

  1. http://192.168.10.132/api/4.1/layout_types/.json

View file
nameLayout_types.json