/
Mosiac Output Stream Configuration

Mosiac Output Stream Configuration

Owned by Ramya Raman (Unlicensed)
Last updated: Jun 29, 2024
6 min read

GET outputs/config/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns meta data ( data types list available values).

Resource URL

http://{host}/api/2.0/outputs/config/meta/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/outputs/config/meta/.json

{ "Encoder": { "SdiOutId": [ "0", "1", "2", "3", "4" ], "EncoderCodecTypes": [ "None", "Mpeg2", "H.264", "H.265 LQ", "H.265 HQ", "H.264 HQ" ], "EncoderLinearCodecTypes": [ "None", "2022-6", "2110-20" ], "EncoderLinearUHDTechTypes": { "1": "HD-SDI (interlaced)", "2": "HD/3G-SDI (progressive)", "4": "Quad Split (progressive)", "5": "Quad Split (interlaced)", "6": "2SI (progressive)", "7": "2SI (interlaced)", "8": "6G/12G-SDI" }, "EncoderLinearLatencyTypes": { "1": "Regular (5)", "2": "1.5 Frames", "3": "Two Frames" }, "EncoderGopSizes": { "1": "24", "2": "50", "3": "12", "4": "1" }, "EncoderFrameRates": { "1": "25 fps", "2": "12.5/25 fps", "3": "5/25 fps", "4": "2.5/25 fps", "5": "2/25 fps", "6": "1/25 fps", "7": "23.976 fps", "8": "24 fps", "9": "29.97 fps", "10": "30 fps", "11": "50 fps", "12": "59.94 fps", "13": "60 fps" }, "EncoderGopSizeModes": { "1": "Static, IPB", "2": "Dynamic, IPB", "3": "Static, IP", "4": "Dynamic, IP" }, "AudioDisplayModes": { "1": "EBU", "2": "PPM" }, "OutputResolutions": { "1": { "id": "1", "title": "1920x1080", "width": "1920", "height": "1080" }, "2": { "id": "2", "title": "1080x1920 (90deg)", "width": "1080", "height": "1920" }, "3": { "id": "3", "title": "1280x720", "width": "1280", "height": "720" }, "4": { "id": "4", "title": "800x448", "width": "800", "height": "448" }, "5": { "id": "5", "title": "640x480", "width": "640", "height": "480" }, "6": { "id": "6", "title": "640x360", "width": "640", "height": "360" }, "7": { "id": "7", "title": "3840x2160", "width": "3840", "height": "2160" }, "8": { "id": "8", "title": "2160x3840 (90deg)", "width": "2160", "height": "3840" } }, "InputLossModes": { "1": "Icon", "2": "Dark Freeze + Icon", "3": "Freeze + Icon", "4": "Freeze" } }, "OutputStream": { "OutputStreamTypes": { "1": "MPEGTS", "2": "MPEGTS Backup", "3": "Uncompressed Main", "4": "Uncompressed Backup", "5": "Uncompressed Main Audio", "6": "Uncompressed Backup Audio", "7": "HLS (TS)", "8": "HLS (CMAF)", "9": "Mpeg Dash", "10": "MSS", "11": "Zixi" } }, "TransportStream": { "TransportModes": { "1": "SPTS/UDP", "2": "SPTS/RTP" } } }

 

 

GET outputs/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of encoders configuration data, including Layouts selection data, Transport Stream configuration and Output Stream configuration.

Resource URL

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

Example Request

GET 

  1. http://44.235.52.211/api/2.0/outputs/config/.json

[ { "Encoder": { "id": 1, "is_enabled": 1, "output_resolution_id": 1, "device_id": 9011, "title": "enc1", "uuid": "A0630606-9B5C-46C9-A129-5B844BF6F454", "is_interlaced": 1, "is_downscale": 1, "is_ratescale": 0, "encoder_codec_type_id": 2, "encoder_linear_codec_type_id": 0, "encoder_uhd_tech_type_id": 1, "encoder_latency_type_id": 1, "vbv_limit": 0, "video_bitrate": 15000000, "is_deblocking": 1, "sdi_out_id": 0, "encoder_gop_size_id": 1, "audio_display_mode_id": 1, "encoder_gop_size_mode_id": 1, "enable_alarms_display": 1, "error_display_agent_id": 0, "audio_alarm_agent_id": 0, "encoder_frame_rate_id": 1, "layout_change_interval": 0, "input_loss_mode_id": 1, "modified": "1611142282208", "created": "1611142282208", "TransportStream": [ { "id": 1, "transport_mode_id": 1, "transport_stream_id": 1, "program_number": 1, "is_null_padding": 1, "pmt_pid": 200, "video_pid": 201, "transcoded_audio_pid": 202, "passthrough_audio_pid": 203, "min_chunk_length": 5, "number_of_chunks": 3, "hls_index_interval": 0, "video_payload_type_id": 0, "audio_payload_type_id": 0, "OutputAudioPids": [] } ], "OutputStreams": [ { "ip_address": "225.0.3.3", "output_stream_type_id": 1, "port": 2000, "ttl": 16, "network_id": 1, "enabled": 0 } ], "Layouts": [ { "id": 5, "title": "temp", "layout_type_id": 14 } ] } }, { "Encoder": { "id": 2, "is_enabled": 1, "output_resolution_id": 1, "device_id": 9011, "title": "enc2", "uuid": "F16C71D5-27C1-4DC2-854E-E9AF99A28DFC", "is_interlaced": 1, "is_downscale": 0, "is_ratescale": 0, "encoder_codec_type_id": 2, "encoder_linear_codec_type_id": 0, "encoder_uhd_tech_type_id": 1, "encoder_latency_type_id": 1, "vbv_limit": 0, "video_bitrate": 3000000, "is_deblocking": 1, "sdi_out_id": 0, "encoder_gop_size_id": 1, "audio_display_mode_id": 1, "encoder_gop_size_mode_id": 1, "enable_alarms_display": 1, "error_display_agent_id": 0, "audio_alarm_agent_id": 0, "encoder_frame_rate_id": 9, "layout_change_interval": 0, "input_loss_mode_id": 1, "modified": "1611142282208", "created": "1611142282208", "TransportStream": [ { "id": 2, "transport_mode_id": 1, "transport_stream_id": 1, "program_number": 1, "is_null_padding": 1, "pmt_pid": 200, "video_pid": 201, "transcoded_audio_pid": 202, "passthrough_audio_pid": 203, "min_chunk_length": 1, "number_of_chunks": 3, "hls_index_interval": 0, "video_payload_type_id": 0, "audio_payload_type_id": 0, "OutputAudioPids": [] } ], "OutputStreams": [ { "ip_address": "225.0.3.3", "output_stream_type_id": 1, "port": 2000, "ttl": 16, "network_id": 1, "enabled": 0 } ], "Layouts": [ { "id": 5, "title": "temp", "layout_type_id": 14 } ] } } ]

 

 

GET outputs/config/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single encoder full configuration data.

Resource URL

http://{host}/api/2.0/outputs/config/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired encoder.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/outputs/config/1/.json

{ "Encoder": { "id": 1, "is_enabled": 1, "output_resolution_id": 1, "device_id": 9011, "title": "enc1", "uuid": "A0630606-9B5C-46C9-A129-5B844BF6F454", "is_interlaced": 1, "is_downscale": 1, "is_ratescale": 0, "encoder_codec_type_id": 2, "encoder_linear_codec_type_id": 0, "encoder_uhd_tech_type_id": 1, "encoder_latency_type_id": 1, "vbv_limit": 0, "video_bitrate": 15000000, "is_deblocking": 1, "sdi_out_id": 0, "encoder_gop_size_id": 1, "audio_display_mode_id": 1, "encoder_gop_size_mode_id": 1, "enable_alarms_display": 1, "error_display_agent_id": 0, "audio_alarm_agent_id": 0, "encoder_frame_rate_id": 1, "layout_change_interval": 0, "input_loss_mode_id": 1, "modified": "1611142282208", "created": "1611142282208", "TransportStream": [ { "id": 1, "transport_mode_id": 1, "transport_stream_id": 1, "program_number": 1, "is_null_padding": 1, "pmt_pid": 200, "video_pid": 201, "transcoded_audio_pid": 202, "passthrough_audio_pid": 203, "min_chunk_length": 5, "number_of_chunks": 3, "hls_index_interval": 0, "video_payload_type_id": 0, "audio_payload_type_id": 0, "OutputAudioPids": [] } ], "OutputStreams": [ { "ip_address": "225.0.3.3", "output_stream_type_id": 1, "port": 2000, "ttl": 16, "network_id": 1, "enabled": 0 }, { "ip_address": "239.1.1.1", "output_stream_type_id": 2, "port": 2000, "ttl": 16, "network_id": 1, "enabled": 0 } ], "Layouts": [ { "id": 5, "title": "temp", "layout_type_id": 14 } ] } }

 

 

POST outputs/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add a new encoder for mosaic output stream.

Resource URL

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

Example Request

POST 

  1. http://44.235.52.211/api/2.0/outputs/config/.json

 

 

PUT outputs/config/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit an existing encoder.

Resource URL

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

Example Request

PUT 

  1. http://44.235.52.211/api/2.0/outputs/config/4/.json

 

 

DELETE outputs/config/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes an existing encoder.

Resource URL

http://{host}/api/2.0/outputs/config/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired encoder.

Example Request

DELETE 

  1. http://44.235.52.211/api/2.0/outputs/config/1/.json

 

Related content

v5.0_Output Config
v5.0_Output Config
TAG Video System
More like this
Channel Statistics
Channel Statistics
TAG Video System
More like this
Proposed API
Proposed API
TAG Video System
Read with this
Mosaic Output Stream Status
Mosaic Output Stream Status
TAG Video System
More like this
MCM Documentation
MCM Documentation
TAG Video System
Read with this
v5.1_Output Config
v5.1_Output Config
TAG Video System
More like this