- Created by Ramya Raman , last modified on Dec 13, 2022
You are viewing an old version of this content. View the current version.
Compare with Current View Version History
« Previous Version 4 Next »
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-7DA97E7E6DA9Allows single quotes. For example, don't care and dont care will be considered same.
Returns a list of receiver configuration data.
Resource URL
http://{host}/api/4.1/receivers/.format
Example Request
GET
[
{
"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? | |
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 | string | The UUID of the desired receiver. |
Example Request
GET
{
"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? | |
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 | string | The UUID of the desired receiver to be updated. |
Example Request
PUT
Body:
{
"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
}
]
}
}
Response:
{
"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
}
]
}
}
Returns a list of senders configuration data.
Resource URL
http://{host}/api/4.1/senders/.format
Example Request
GET
[
{
"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"
}
]
}
}
]
Returns a single specific senders configuration data.
Resource URL
http://{host}/api/4.1/senders/{id}/.format
Parameters
Parameter | Data Type | Descriptionuu |
|---|---|---|
uuid | string | The UUID of the desired senders. |
Example Request
GET
{
"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"
}
]
}
}
Updates the network configuration in the senders.
Resource URL
http://{host}/api/4.1/senders/{uuid}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired sender to be updated. |
Example Request
PUT
Body:
{
"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"
}
]
}
}
Response:
{
"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"
}
]
}
}
Returns a list of layouts configuration data.
Resource URL
http://{host}/api/4.1/layouts/.format
Example Request
GET
Returns a single specific layouts configuration data.
Resource URL
http://{host}/api/4.1/layouts/{id}/.format
Parameters
Parameter | Data Type | Descriptionuu |
|---|---|---|
uuid | string | The UUID of the desired layouts. |
Example Request
GET
{
"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"
}
]
}
}
Updates the network configuration in the layouts.
Resource URL
http://{host}/api/4.1/layouts/{uuid}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired layouts to be updated. |
Example Request
PUT
Body:
{
"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"
}
]
}
}
Response:
{
"Layout": {
"uuid": "F45D9708-B192-4A30-964A-38113ED9B633",
"label": "my_channel_Layout",
"modified": "1670834516415",
"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"
}
]
}
}
Returns a single specific layout_types configuration data.
Resource URL
http://{host}/api/4.1/layout_types/.format
Example Request
GET
GET channels/config
Resource Information
Requires Authentication? | |
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
GET channels/config/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a single specific channels configuration data.
Resource URL
http://{host}/api/4.1/channels/config/{id}/.format
Parameters
Parameter | Data Type | Descriptionuu |
|---|---|---|
uuid | string | The UUID of the desired channel configuration. |
Example Request
GET
GET outputs/config
Resource Information
Requires Authentication? | |
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
[
{
"Output": {
"uuid": "880D1D99-0066-422E-BA42-2541E515D662",
"label": "Enc1",
"modified": "1670833362762",
"created": "1669543737686",
"enabled": true,
"device_id": 9232,
"resolution": "1920x1080",
"enable_alarms_display": true,
"input_loss_mode": "Icon",
"frame_rate": "25 fps",
"layout_change_interval": null,
"Senders": [
{
"uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
"stream_type": "MPEG-TS",
"enabled": true,
"transport_stream_id": 1,
"transport_mode": "SPTS/UDP",
"vbv_limit": null,
"enable_interlaced": true,
"enable_deblocking": true,
"program_number": 1,
"ts_per_ip": 7,
"enable_null_padding": true,
"pmt_pid": 200,
"video_pid": 201,
"transcoded_audio_pid": 0,
"passthrough_audio_pid": 0,
"min_chunk_length": 2,
"number_of_chunks": 3,
"hls_index_interval": null,
"enable_downscale": false,
"enable_ratescale": false,
"codec_type": "H.264",
"video_bitrate": 14000000,
"jxs_bitrate": 0,
"gop_size_mode": "Static, IPB Frames",
"gop_size": "24",
"network": [
{
"ttl": "16",
"interface_ip": "192.168.10.132",
"destination_ip": "225.0.3.2",
"destination_port": 1000
},
{
"ttl": "16",
"interface_ip": false,
"destination_ip": "226.0.4.4",
"destination_port": 2000
}
]
},
{
"uuid": "2F309F30-B3AE-46CC-B04C-745BC3000F0F",
"stream_type": "2110/Video",
"enabled": false,
"uhd_mode": "HD-SDI (Interlaced)",
"latency_mode": "5 Frames",
"payload_type": 0,
"avoid_c_bit": false,
"network": [
{
"ttl": "16",
"interface_ip": "192.168.10.132",
"destination_ip": "227.0.5.5",
"destination_port": 2000
},
{
"ttl": "16",
"interface_ip": false,
"destination_ip": "228.0.6.6",
"destination_port": 2000
}
]
},
{
"uuid": "69B830B0-5990-4D27-A482-9650EBC54447",
"stream_type": "2110/Audio",
"enabled": false,
"payload_type": 0,
"network": [
{
"ttl": "16",
"interface_ip": "192.168.10.132",
"destination_ip": "229.0.7.7",
"destination_port": 2001
},
{
"ttl": "16",
"interface_ip": false,
"destination_ip": "230.0.8.8",
"destination_port": 2001
}
]
}
],
"Layouts": [
{
"uuid": "928F2E96-EF11-4F25-9574-543E6D7CCBBF",
"label": "test 789"
}
]
}
}
]
GET outputs/config/{id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a single specific outputs configuration data.
Resource URL
http://{host}/api/4.1/outputs/config/{id}/.format
Parameters
Parameter | Data Type | Descriptionuu |
|---|---|---|
uuid | string | The UUID of the desired output configuration. |
Example Request
GET
{
"Output": {
"uuid": "880D1D99-0066-422E-BA42-2541E515D662",
"label": "Enc1",
"modified": "1670833362762",
"created": "1669543737686",
"enabled": true,
"device_id": 9232,
"resolution": "1920x1080",
"enable_alarms_display": true,
"input_loss_mode": "Icon",
"frame_rate": "25 fps",
"layout_change_interval": null,
"Senders": [
{
"uuid": "5B21DD2C-0EAB-4DDE-8759-8D7617A01955",
"stream_type": "MPEG-TS",
"enabled": true,
"transport_stream_id": 1,
"transport_mode": "SPTS/UDP",
"vbv_limit": null,
"enable_interlaced": true,
"enable_deblocking": true,
"program_number": 1,
"ts_per_ip": 7,
"enable_null_padding": true,
"pmt_pid": 200,
"video_pid": 201,
"transcoded_audio_pid": 0,
"passthrough_audio_pid": 0,
"min_chunk_length": 2,
"number_of_chunks": 3,
"hls_index_interval": null,
"enable_downscale": false,
"enable_ratescale": false,
"codec_type": "H.264",
"video_bitrate": 14000000,
"jxs_bitrate": 0,
"gop_size_mode": "Static, IPB Frames",
"gop_size": "24",
"network": [
{
"ttl": "16",
"interface_ip": "192.168.10.132",
"destination_ip": "225.0.3.2",
"destination_port": 1000
},
{
"ttl": "16",
"interface_ip": false,
"destination_ip": "226.0.4.4",
"destination_port": 2000
}
]
},
{
"uuid": "2F309F30-B3AE-46CC-B04C-745BC3000F0F",
"stream_type": "2110/Video",
"enabled": false,
"uhd_mode": "HD-SDI (Interlaced)",
"latency_mode": "5 Frames",
"payload_type": 0,
"avoid_c_bit": false,
"network": [
{
"ttl": "16",
"interface_ip": "192.168.10.132",
"destination_ip": "227.0.5.5",
"destination_port": 2000
},
{
"ttl": "16",
"interface_ip": false,
"destination_ip": "228.0.6.6",
"destination_port": 2000
}
]
},
{
"uuid": "69B830B0-5990-4D27-A482-9650EBC54447",
"stream_type": "2110/Audio",
"enabled": false,
"payload_type": 0,
"network": [
{
"ttl": "16",
"interface_ip": "192.168.10.132",
"destination_ip": "229.0.7.7",
"destination_port": 2001
},
{
"ttl": "16",
"interface_ip": false,
"destination_ip": "230.0.8.8",
"destination_port": 2001
}
]
}
],
"Layouts": [
{
"uuid": "928F2E96-EF11-4F25-9574-543E6D7CCBBF",
"label": "test 789"
}
]
}
}
- No labels