- Created by Ramya Raman, last modified on Feb 09, 2022
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 4 Current »
GET outputs/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a list of all encoders in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/outputs/config
Example Request
GET
{
"data": [
{
"uuid": "69c68901-d938-4904-95fc-f76b94fde750",
"label": "MT_encoder_test",
"device": null,
"created": "2022-02-06T16:25:54.108Z",
"modified": "2022-02-09T02:39:35.674Z",
"input": {
"audio": [
{
"index": 1,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 2,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 3,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 4,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 5,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 6,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 7,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 8,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 9,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 10,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 11,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 12,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 13,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 14,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 15,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 16,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 17,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 18,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 19,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 20,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 21,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 22,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 23,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 24,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 25,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 26,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 27,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 28,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 29,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 30,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 31,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 32,
"channel": null,
"audio_pid": null,
"audio_index": null
}
],
"layouts": []
},
"config": {
"audio_agent": null,
"show_alarms": true,
"input_loss_mode": "Icon",
"audio_display_mode": "EBU",
"layout_change_interval": null
},
"processing": {
"audio": [
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
}
],
"video": {
"frame_rate": "25 fps",
"resolution": "1920x1080",
"interlaced": true,
"compression": {
"gop_mode": "Static, IPB Frames",
"gop_size": "24",
"downscale": false,
"ratescale": false,
"vbv_limit": null,
"codec_type": "H.264",
"deblocking": true,
"video_bitrate": 14000000
}
},
"packaging": {
"min_chunk_length": 2,
"number_of_chunks": 3,
"manifest_interval": null
},
"muxing": {
"audio": [
{
"pid": 210
},
{
"pid": 211
},
{
"pid": 212
},
{
"pid": 213
},
{
"pid": 214
},
{
"pid": 215
},
{
"pid": 216
},
{
"pid": 217
},
{
"pid": 218
},
{
"pid": 219
},
{
"pid": 220
},
{
"pid": 221
},
{
"pid": 222
},
{
"pid": 223
},
{
"pid": 224
},
{
"pid": 225
},
{
"pid": 226
},
{
"pid": 227
},
{
"pid": 228
},
{
"pid": 229
},
{
"pid": 230
},
{
"pid": 231
},
{
"pid": 232
},
{
"pid": 233
},
{
"pid": 234
},
{
"pid": 235
},
{
"pid": 236
},
{
"pid": 237
},
{
"pid": 238
},
{
"pid": 239
},
{
"pid": 240
},
{
"pid": 241
}
],
"ts_id": 1,
"pmt_pid": 200,
"video_pid": 201,
"program_number": 1
}
},
"stream": {
"senders": [
{
"uuid": "a98ed9e6-7693-4428-a47f-96111b1d07bd",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": true,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "225.0.3.3"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "226.0.4.4"
}
],
"stream_type": "MPEG-TS",
"null_padding": true,
"transport_mode": "SPTS/UDP"
},
{
"uuid": "23ae6d31-9413-4566-827b-7d48e10625da",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "227.0.5.5"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "228.0.6.6"
}
],
"work_mode": "HD-SDI (Interlaced)",
"stream_type": "2110-20",
"latency_mode": "5 Frames",
"payload_type": null
},
{
"uuid": "ba312661-5585-438c-83ae-d1cacc8da36f",
"networks": [
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "229.0.7.7"
},
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "230.0.8.8"
}
],
"stream_type": "2110-30",
"payload_type": null
},
{
"uuid": "28483471-54c5-4fbc-8f5e-0bb5f64faba9",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "HLS-TS"
},
{
"uuid": "3380660f-9d90-47ac-b562-9ffa547e1e29",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "Zixi"
},
{
"uuid": "4aae75d6-1b6e-4cd7-aa6d-19416615bcab",
"networks": [
{
"enabled": false,
"network": null,
"publish_url": null
}
],
"stream_type": "NDI"
},
{
"uuid": "014188b8-613c-4259-8df5-82d1c95af06d",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "CDI"
}
]
}
},
{
"uuid": "a9fb41d0-7a22-449d-98f0-b44265153420",
"label": "new_Encoder",
"device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
"created": "2022-01-17T14:25:05.618Z",
"modified": "2022-02-09T03:42:14.055Z",
"input": {
"audio": [
{
"index": 1,
"channel": null,
"audio_pid": 34,
"audio_index": 1
},
{
"index": 2,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 3,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 4,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 5,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 6,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 7,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 8,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 9,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 10,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 11,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 12,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 13,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 14,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 15,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 16,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 17,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 18,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 19,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 20,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 21,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 22,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 23,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 24,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 25,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 26,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 27,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 28,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 29,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 30,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 31,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 32,
"channel": null,
"audio_pid": null,
"audio_index": null
}
],
"layouts": [
"bd034816-3246-48a2-84e3-62b356806208"
]
},
"config": {
"audio_agent": null,
"show_alarms": true,
"input_loss_mode": "Icon",
"audio_display_mode": "EBU",
"layout_change_interval": null
},
"processing": {
"audio": [
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
}
],
"video": {
"frame_rate": "25 fps",
"resolution": "1920x1080",
"interlaced": true,
"compression": {
"gop_mode": "Static, IPB Frames",
"gop_size": "24",
"downscale": false,
"ratescale": false,
"vbv_limit": null,
"codec_type": "H.264",
"deblocking": true,
"video_bitrate": 14000000
}
},
"packaging": {
"min_chunk_length": 2,
"number_of_chunks": 3,
"manifest_interval": null
},
"muxing": {
"audio": [
{
"pid": 210
},
{
"pid": 211
},
{
"pid": 212
},
{
"pid": 213
},
{
"pid": 214
},
{
"pid": 215
},
{
"pid": 216
},
{
"pid": 217
},
{
"pid": 218
},
{
"pid": 219
},
{
"pid": 220
},
{
"pid": 221
},
{
"pid": 222
},
{
"pid": 223
},
{
"pid": 224
},
{
"pid": 225
},
{
"pid": 226
},
{
"pid": 227
},
{
"pid": 228
},
{
"pid": 229
},
{
"pid": 230
},
{
"pid": 231
},
{
"pid": 232
},
{
"pid": 233
},
{
"pid": 234
},
{
"pid": 235
},
{
"pid": 236
},
{
"pid": 237
},
{
"pid": 238
},
{
"pid": 239
},
{
"pid": 240
},
{
"pid": 241
}
],
"ts_id": 1,
"pmt_pid": 200,
"video_pid": 201,
"program_number": 1
}
},
"stream": {
"senders": [
{
"uuid": "a799db8e-2d8a-43da-b271-ae60ae9e47bd",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": true,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "225.0.3.3"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "226.0.4.4"
}
],
"stream_type": "MPEG-TS",
"null_padding": true,
"transport_mode": "SPTS/UDP"
},
{
"uuid": "0a35384a-eb7d-4b26-92a1-2b1b3f5a40da",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "227.0.5.5"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "228.0.6.6"
}
],
"work_mode": "HD-SDI (Interlaced)",
"stream_type": "2110-20",
"latency_mode": "5 Frames",
"payload_type": null
},
{
"uuid": "cde6fcc3-1b7d-418c-a4a2-dc86274d0416",
"networks": [
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "229.0.7.7"
},
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "230.0.8.8"
}
],
"stream_type": "2110-30",
"payload_type": null
},
{
"uuid": "3d7f2593-bb17-44ef-9717-653e2ceca3ec",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "HLS-TS"
},
{
"uuid": "797120d9-f91d-47a4-bc1f-4154a37f601a",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "Zixi"
},
{
"uuid": "92234766-6c0a-4442-9507-9ce20dd293b8",
"networks": [
{
"enabled": false,
"network": null,
"publish_url": null
}
],
"stream_type": "NDI"
},
{
"uuid": "d1ab23fd-78de-475b-8096-75fb4df9d362",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "CDI"
}
]
}
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"current_page": 1,
"sort_by": [
{
"field": "label",
"direction": "ASC"
}
],
"links": {
"current": "http://192.168.10.53/api/5.0/outputs/config"
}
}
}
GET outputs/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns an extended single encoder configuration view, specified by the required {uuid} parameter.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/outputs/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired encoder. |
Example Request
GET
{
"data": {
"uuid": "a9fb41d0-7a22-449d-98f0-b44265153420",
"label": "new_Encoder",
"device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
"created": "2022-01-17T14:25:05.618Z",
"modified": "2022-02-09T03:42:14.055Z",
"input": {
"audio": [
{
"index": 1,
"channel": null,
"audio_pid": 34,
"audio_index": 1
},
{
"index": 2,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 3,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 4,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 5,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 6,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 7,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 8,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 9,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 10,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 11,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 12,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 13,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 14,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 15,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 16,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 17,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 18,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 19,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 20,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 21,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 22,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 23,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 24,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 25,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 26,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 27,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 28,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 29,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 30,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 31,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 32,
"channel": null,
"audio_pid": null,
"audio_index": null
}
],
"layouts": [
"bd034816-3246-48a2-84e3-62b356806208"
]
},
"config": {
"audio_agent": null,
"show_alarms": true,
"input_loss_mode": "Icon",
"audio_display_mode": "EBU",
"layout_change_interval": null
},
"processing": {
"audio": [
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
}
],
"video": {
"frame_rate": "25 fps",
"resolution": "1920x1080",
"interlaced": true,
"compression": {
"gop_mode": "Static, IPB Frames",
"gop_size": "24",
"downscale": false,
"ratescale": false,
"vbv_limit": null,
"codec_type": "H.264",
"deblocking": true,
"video_bitrate": 14000000
}
},
"packaging": {
"min_chunk_length": 2,
"number_of_chunks": 3,
"manifest_interval": null
},
"muxing": {
"audio": [
{
"pid": 210
},
{
"pid": 211
},
{
"pid": 212
},
{
"pid": 213
},
{
"pid": 214
},
{
"pid": 215
},
{
"pid": 216
},
{
"pid": 217
},
{
"pid": 218
},
{
"pid": 219
},
{
"pid": 220
},
{
"pid": 221
},
{
"pid": 222
},
{
"pid": 223
},
{
"pid": 224
},
{
"pid": 225
},
{
"pid": 226
},
{
"pid": 227
},
{
"pid": 228
},
{
"pid": 229
},
{
"pid": 230
},
{
"pid": 231
},
{
"pid": 232
},
{
"pid": 233
},
{
"pid": 234
},
{
"pid": 235
},
{
"pid": 236
},
{
"pid": 237
},
{
"pid": 238
},
{
"pid": 239
},
{
"pid": 240
},
{
"pid": 241
}
],
"ts_id": 1,
"pmt_pid": 200,
"video_pid": 201,
"program_number": 1
}
},
"stream": {
"senders": [
{
"uuid": "a799db8e-2d8a-43da-b271-ae60ae9e47bd",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": true,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "225.0.3.3"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "226.0.4.4"
}
],
"stream_type": "MPEG-TS",
"null_padding": true,
"transport_mode": "SPTS/UDP"
},
{
"uuid": "0a35384a-eb7d-4b26-92a1-2b1b3f5a40da",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "227.0.5.5"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "228.0.6.6"
}
],
"work_mode": "HD-SDI (Interlaced)",
"stream_type": "2110-20",
"latency_mode": "5 Frames",
"payload_type": null
},
{
"uuid": "cde6fcc3-1b7d-418c-a4a2-dc86274d0416",
"networks": [
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "229.0.7.7"
},
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "230.0.8.8"
}
],
"stream_type": "2110-30",
"payload_type": null
},
{
"uuid": "3d7f2593-bb17-44ef-9717-653e2ceca3ec",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "HLS-TS"
},
{
"uuid": "797120d9-f91d-47a4-bc1f-4154a37f601a",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "Zixi"
},
{
"uuid": "92234766-6c0a-4442-9507-9ce20dd293b8",
"networks": [
{
"enabled": false,
"network": null,
"publish_url": null
}
],
"stream_type": "NDI"
},
{
"uuid": "d1ab23fd-78de-475b-8096-75fb4df9d362",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "CDI"
}
]
}
},
"metadata": {}
}
GET outputs/config/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns all meta data used by output configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/outputs/config/meta
Example Request
GET
{
"processing": {
"video": {
"FrameRates": [
"25 fps",
"12.5/25 fps",
"5/25 fps",
"2.5/25 fps",
"2/25 fps",
"1/25 fps",
"23.976 fps",
"24 fps",
"29.97 fps",
"30 fps",
"50 fps",
"59.94 fps",
"60 fps"
],
"compression": {
"CodecTypes": [
"MPEG2",
"H.264",
"H.265 LQ",
"H.265 HQ",
"H.264 HQ"
],
"GopSizes": [
"1",
"12",
"24",
"50"
],
"GopModes": [
"Static, IPB Frames",
"Dynamic, IPB Frames",
"Static, IP Frames",
"Dynamic, IP Frames"
]
},
"Resolutions": [
"1920x1080",
"1080x1920 (90deg)",
"1280x720",
"800x448",
"640x480",
"640x360",
"3840x2160",
"2160x3840 (90deg)"
]
},
"audio": {
"Modes": [
"Transcoded",
"PassThrough"
]
}
},
"config": {
"InputLossModes": [
"Icon",
"Dark Freeze + Icon",
"Freeze + Icon",
"Freeze"
],
"AudioDisplayModes": [
"EBU",
"PPM"
]
},
"stream": {
"senders": {
"StreamTypes": [
"MPEG-TS",
"2022-6",
"2110-20",
"2110-30",
"HLS-TS",
"Zixi",
"CDI",
"NDI",
"SRT"
],
"compressed": {
"TransportModes": [
"SPTS/UDP",
"SPTS/RTP"
]
},
"uncompressed": {
"LatencyModes": [
"5 Frames",
"1.5 Frames",
"2 Frames"
],
"WorkModes": [
"HD-SDI (Interlaced)",
"HD/3G-SDI (Progressive)",
"Quad Split (Interlaced)",
"Quad Split (Progressive)",
"2SI (Interlaced)",
"2SI (Progressive)",
"6G/12G-SDI"
]
}
}
}
}
DELETE outputs/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific output configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/outputs/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the encoder to be deleted. |
Example Request
DELETE
{
"data": [
{
"success": true
}
],
"metadata": {}
}
PUT outputs/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit an output configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/outputs/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the encoder to be edited. |
Example Request
PUT
Body
{
"uuid": "a9fb41d0-7a22-449d-98f0-b44265153420",
"label": "enc_test_edited",
"input": {
"audio": [
{
"index": 1,
"channel": null,
"audio_pid": 34,
"audio_index": 1
},
{
"index": 2,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 3,
"channel": null,
"audio_pid": null,
"audio_index": null
}
],
"layouts": [
"bd034816-3246-48a2-84e3-62b356806208"
]
},
"config": {
"audio_agent": null,
"show_alarms": true,
"input_loss_mode": "Icon",
"audio_display_mode": "EBU",
"layout_change_interval": null
},
"processing": {
"audio": [
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
}
],
"video": {
"frame_rate": "25 fps",
"resolution": "1920x1080",
"interlaced": true,
"compression": {
"gop_mode": "Static, IPB Frames",
"gop_size": "24",
"downscale": false,
"ratescale": false,
"vbv_limit": null,
"codec_type": "H.264",
"deblocking": true,
"video_bitrate": 14000000
}
},
"packaging": {
"min_chunk_length": 2,
"number_of_chunks": 3,
"manifest_interval": null
},
"muxing": {
"audio": [
{
"pid": 210
},
{
"pid": 211
},
{
"pid": 212
}
],
"ts_id": 1,
"pmt_pid": 200,
"video_pid": 201,
"program_number": 1
}
},
"stream": {
"senders": [
{
"uuid": "a799db8e-2d8a-43da-b271-ae60ae9e47bd",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": true,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "225.0.3.3"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "226.0.4.4"
}
],
"stream_type": "MPEG-TS",
"null_padding": true,
"transport_mode": "SPTS/UDP"
},
{
"uuid": "0a35384a-eb7d-4b26-92a1-2b1b3f5a40da",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "227.0.5.5"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "228.0.6.6"
}
],
"work_mode": "HD-SDI (Interlaced)",
"stream_type": "2110-20",
"latency_mode": "5 Frames",
"payload_type": null
},
{
"uuid": "cde6fcc3-1b7d-418c-a4a2-dc86274d0416",
"networks": [
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "229.0.7.7"
},
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "230.0.8.8"
}
],
"stream_type": "2110-30",
"payload_type": null
},
{
"uuid": "3d7f2593-bb17-44ef-9717-653e2ceca3ec",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "HLS-TS"
},
{
"uuid": "797120d9-f91d-47a4-bc1f-4154a37f601a",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "Zixi"
},
{
"uuid": "92234766-6c0a-4442-9507-9ce20dd293b8",
"networks": [
{
"enabled": false,
"network": null,
"publish_url": null
}
],
"stream_type": "NDI"
},
{
"uuid": "d1ab23fd-78de-475b-8096-75fb4df9d362",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "CDI"
}
]
}
}
Response
{
"data": {
"uuid": "a9fb41d0-7a22-449d-98f0-b44265153420",
"label": "enc_test_edited",
"device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
"created": "2022-01-17T14:25:05.618Z",
"modified": "2022-02-09T05:31:57.314Z",
"input": {
"audio": [
{
"index": 1,
"channel": null,
"audio_pid": 34,
"audio_index": 1
},
{
"index": 2,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 3,
"channel": null,
"audio_pid": null,
"audio_index": null
}
],
"layouts": [
"bd034816-3246-48a2-84e3-62b356806208"
]
},
"config": {
"audio_agent": null,
"show_alarms": true,
"input_loss_mode": "Icon",
"audio_display_mode": "EBU",
"layout_change_interval": null
},
"processing": {
"audio": [
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
}
],
"video": {
"frame_rate": "25 fps",
"resolution": "1920x1080",
"interlaced": true,
"compression": {
"gop_mode": "Static, IPB Frames",
"gop_size": "24",
"downscale": false,
"ratescale": false,
"vbv_limit": null,
"codec_type": "H.264",
"deblocking": true,
"video_bitrate": 14000000
}
},
"packaging": {
"min_chunk_length": 2,
"number_of_chunks": 3,
"manifest_interval": null
},
"muxing": {
"audio": [
{
"pid": 210
},
{
"pid": 211
},
{
"pid": 212
}
],
"ts_id": 1,
"pmt_pid": 200,
"video_pid": 201,
"program_number": 1
}
},
"stream": {
"senders": [
{
"uuid": "a799db8e-2d8a-43da-b271-ae60ae9e47bd",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": true,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "225.0.3.3"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "226.0.4.4"
}
],
"stream_type": "MPEG-TS",
"null_padding": true,
"transport_mode": "SPTS/UDP"
},
{
"uuid": "0a35384a-eb7d-4b26-92a1-2b1b3f5a40da",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "227.0.5.5"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "228.0.6.6"
}
],
"work_mode": "HD-SDI (Interlaced)",
"stream_type": "2110-20",
"latency_mode": "5 Frames",
"payload_type": null
},
{
"uuid": "cde6fcc3-1b7d-418c-a4a2-dc86274d0416",
"networks": [
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "229.0.7.7"
},
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "230.0.8.8"
}
],
"stream_type": "2110-30",
"payload_type": null
},
{
"uuid": "3d7f2593-bb17-44ef-9717-653e2ceca3ec",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "HLS-TS"
},
{
"uuid": "797120d9-f91d-47a4-bc1f-4154a37f601a",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "Zixi"
},
{
"uuid": "92234766-6c0a-4442-9507-9ce20dd293b8",
"networks": [
{
"enabled": false,
"network": null,
"publish_url": null
}
],
"stream_type": "NDI"
},
{
"uuid": "d1ab23fd-78de-475b-8096-75fb4df9d362",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "CDI"
}
]
}
},
"metadata": {}
}
POST outputs/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add a new encoder, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/outputs/config
Example Request
POST
Body
{
"uuid": "a9fb41d0-7a22-449d-98f0-b44265153420",
"label": "enc_test",
"input": {
"audio": [
{
"index": 1,
"channel": null,
"audio_pid": 34,
"audio_index": 1
},
{
"index": 2,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 3,
"channel": null,
"audio_pid": null,
"audio_index": null
}
],
"layouts": [
"bd034816-3246-48a2-84e3-62b356806208"
]
},
"config": {
"audio_agent": null,
"show_alarms": true,
"input_loss_mode": "Icon",
"audio_display_mode": "EBU",
"layout_change_interval": null
},
"processing": {
"audio": [
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
}
],
"video": {
"frame_rate": "25 fps",
"resolution": "1920x1080",
"interlaced": true,
"compression": {
"gop_mode": "Static, IPB Frames",
"gop_size": "24",
"downscale": false,
"ratescale": false,
"vbv_limit": null,
"codec_type": "H.264",
"deblocking": true,
"video_bitrate": 14000000
}
},
"packaging": {
"min_chunk_length": 2,
"number_of_chunks": 3,
"manifest_interval": null
},
"muxing": {
"audio": [
{
"pid": 210
},
{
"pid": 211
},
{
"pid": 212
}
],
"ts_id": 1,
"pmt_pid": 200,
"video_pid": 201,
"program_number": 1
}
},
"stream": {
"senders": [
{
"uuid": "a799db8e-2d8a-43da-b271-ae60ae9e47bd",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": true,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "225.0.3.3"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "226.0.4.4"
}
],
"stream_type": "MPEG-TS",
"null_padding": true,
"transport_mode": "SPTS/UDP"
},
{
"uuid": "0a35384a-eb7d-4b26-92a1-2b1b3f5a40da",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "227.0.5.5"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "228.0.6.6"
}
],
"work_mode": "HD-SDI (Interlaced)",
"stream_type": "2110-20",
"latency_mode": "5 Frames",
"payload_type": null
},
{
"uuid": "cde6fcc3-1b7d-418c-a4a2-dc86274d0416",
"networks": [
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "229.0.7.7"
},
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "230.0.8.8"
}
],
"stream_type": "2110-30",
"payload_type": null
},
{
"uuid": "3d7f2593-bb17-44ef-9717-653e2ceca3ec",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "HLS-TS"
},
{
"uuid": "797120d9-f91d-47a4-bc1f-4154a37f601a",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "Zixi"
},
{
"uuid": "92234766-6c0a-4442-9507-9ce20dd293b8",
"networks": [
{
"enabled": false,
"network": null,
"publish_url": null
}
],
"stream_type": "NDI"
},
{
"uuid": "d1ab23fd-78de-475b-8096-75fb4df9d362",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "CDI"
}
]
}
}
Response
{
"data": {
"uuid": "abc99ad4-3a86-492d-bf88-4dce1345e04e",
"label": "enc_test",
"device": null,
"created": "2022-02-09T05:23:08.643Z",
"modified": "2022-02-09T05:23:08.643Z",
"input": {
"audio": [
{
"index": 1,
"channel": null,
"audio_pid": 34,
"audio_index": 1
},
{
"index": 2,
"channel": null,
"audio_pid": null,
"audio_index": null
},
{
"index": 3,
"channel": null,
"audio_pid": null,
"audio_index": null
}
],
"layouts": [
"bd034816-3246-48a2-84e3-62b356806208"
]
},
"config": {
"audio_agent": null,
"show_alarms": true,
"input_loss_mode": "Icon",
"audio_display_mode": "EBU",
"layout_change_interval": null
},
"processing": {
"audio": [
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
},
{
"mode": "Transcoded"
}
],
"video": {
"frame_rate": "25 fps",
"resolution": "1920x1080",
"interlaced": true,
"compression": {
"gop_mode": "Static, IPB Frames",
"gop_size": "24",
"downscale": false,
"ratescale": false,
"vbv_limit": null,
"codec_type": "H.264",
"deblocking": true,
"video_bitrate": 14000000
}
},
"packaging": {
"min_chunk_length": 2,
"number_of_chunks": 3,
"manifest_interval": null
},
"muxing": {
"audio": [
{
"pid": 210
},
{
"pid": 211
},
{
"pid": 212
}
],
"ts_id": 1,
"pmt_pid": 200,
"video_pid": 201,
"program_number": 1
}
},
"stream": {
"senders": [
{
"uuid": "b6f9740a-ce2e-45e5-b52c-71b299a6d2bc",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": true,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "225.0.3.3"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "226.0.4.4"
}
],
"stream_type": "MPEG-TS",
"null_padding": true,
"transport_mode": "SPTS/UDP"
},
{
"uuid": "a12f8432-43d6-4586-ad4a-2567e04546ad",
"networks": [
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "227.0.5.5"
},
{
"ttl": 16,
"port": 2000,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "228.0.6.6"
}
],
"work_mode": "HD-SDI (Interlaced)",
"stream_type": "2110-20",
"latency_mode": "5 Frames",
"payload_type": null
},
{
"uuid": "6d04363a-53f6-4d24-bf1a-49c62e2c24af",
"networks": [
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "229.0.7.7"
},
{
"ttl": 16,
"port": 2001,
"enabled": false,
"network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
"ip_address": "230.0.8.8"
}
],
"stream_type": "2110-30",
"payload_type": null
},
{
"uuid": "b5b28cb0-f45f-48b4-a581-526fab27361b",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "HLS-TS"
},
{
"uuid": "0320dd88-9760-429e-8705-1cdf735c3e6e",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "Zixi"
},
{
"uuid": "736b5770-711d-4a7c-8f36-f1544b9592c8",
"networks": [
{
"enabled": false,
"network": null,
"publish_url": null
}
],
"stream_type": "NDI"
},
{
"uuid": "59fe22a3-b844-4511-a357-0ba8bb9703d9",
"networks": [
{
"enabled": false,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"publish_url": null
}
],
"stream_type": "CDI"
}
]
}
},
"metadata": {}
}
- No labels