POST: Create an MPTS - AWS Elemental Conductor Live 3

This is version 3.17 of the AWS Elemental Conductor Live 3 documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor Live 3 Documentation.

POST: Create an MPTS

Create an MPTS output. Note that its SPTS programs (members) must be added after the MPTS is created. Use instruction for POST MPTS member.

HTTP Request and Response

Request URL

POST http://<Conductor IP address>/mpts

Call Header

  • Accept: Set to application/xml

  • Content-Type: Set to application/xml

If you are implementing user authentication, you must also include three authorization headers; see Header Content for User Authentication.

Request Body

The request contains XML content consisting of one mpts element, with the following elements.

Element Value Description
name String A name for the MPTS
node_id String

The node where the MPTS will be created: where the muxing of the individual programs occurs.

Specify a node that is not set up as backup nodes in a redundancy group. To obtain the ID of a specific node, see GET List: Get a List of Nodes in the Cluster.

Select the correct node. Be aware of the type and choose:

  • Any AWS Elemental Live node, if you are creating an MPTS consisting only of Constant Bitrate (CBR) programs.

  • An AWS Elemental Live node with the AWS Elemental Statmux option if you are creating an MPTS that includes at least one AWS Elemental Statmux program.

  • An AWS Elemental Statmux stand-alone node if you are creating an MPTS that includes at least one AWS Elemental Statmux program.

permalink_name String

A name for the permalink. A permalink provides a mechanism for referencing an MPTS in a PUT, GET, or DELETE. With a permalink, you can reference an MPTS immediately after creating it because you already know its value; you don’t have to first do a GET in order to get the automatically assigned ID.

If you specify a value in this element, the permalink takes that name.

If you leave this element empty, the value is set to be identical to the name element (converted to lower case and with spaces converted to underscores).

bitrate Integer The total bitrate for the MPTS in bits/second.
video_allocation Integer The bitrate to allocate for video traffic in bits/second.
transport_stream_id Integer The value for the transport stream ID field in the Program Map Table. Range 0 to 65535.
udp_buffer_size String Size of network output buffer. This buffer is used to limit PCR jitter on the network.
  • Auto: Selects optimal size based on the video elementary stream properties.

  • Custom: Establishes a non-negative integer for the number of bits to use for the buffer.

  • Off: Smooths bursts in the network output but does not attempt to limit PCR jitter; this can be used to achieve low-latency streams where output devices do not require buffer-compliant outputs.

output_listening String

This field is used to set up for output redundancy with output listening and applies only if your Statmux statmux deployment involves AWS Elemental Live nodes as the encoders and an AWS Elemental Statmux node as the muxer; see Setting Up MPTS Outputs in the AWS Elemental Conductor Live 3 User Guide.

If you are not setting up for this type of redundancy or if the AWS Elemental Live node is both the encoder and muxer, omit this field.

output_listening_interval Boolean The specified detection interval for the output listening feature, in milliseconds. See above for details.
allocation_message_priority String

This field is used to set up for multiplexer redundancy and applies only if your Statmux deployment involves AWS Elemental Live nodes as the encoders and an AWS Elemental Statmux node as the muxer; see Setting Up MPTS Outputs in the AWS Elemental Conductor Live 3 User Guide.

If you are not setting up for this type of redundancy or if the AWS Elemental Live node is both the encoder and muxer, omit this field.

pat_interval Integer

The PAT interval in ms for the entire MPTS.

Range: 10 – 1000 (Default is 100).

destination/uri String

The primary destination for the MPTS output. This can be a UDP or RTP location. Format:

<protocol>://<IP address>:<port>

destination/username String The username for the destination, if required.
destination/password String The password for the destination, if required.

secondary_destination/

uri

String

Optional. The secondary destination, interface, and virtual source address.

Completing a secondary destination provides “network failure redundancy” for the MPTS. The muxer sends the output to both destination 1 and destination 2; if one destination fails, downstream systems can obtain it from the other. See Setting Up MPTS Outputs in the AWS Elemental Conductor Live 3 User Guide.

If you are not setting up for network failure redundancy, omit these fields.

secondary_destination/

username

String

secondary_destination/

password

String
fec_output_settings String See below for details.
additional_system_latency String

Specify additional time (in milliseconds) to add to the “maximum encoding latency” – the time between when the SPTS channels send their complexity data to the muxer and when the muxer expects the related encoded content for all channels.

Typically, specify additional time only if the Buffer Size (set in the video stream) for one of the SPTS channels is longer than typical,or if an SPTS channel is set up for 4 Quadrant-4k HEVC encoding via bonded Live 401 or 402 encoders.

Note that you will not be able to change this value while the MPTS is running; you will have to stop the MPTS output and then restart it. This is the only field on the MPTS that you cannot change after creation.

dvb_sdt_settings/rep_interval Integer

The SDT interval in ms, for the entire MPTS.

Range: 25 – 2000 (Default is 500)

dvb_tdt_settings/rep_interval Integer

The TDT interval in ms, for the entire MPTS.

Range: 1000 – 30000 (Default is 1000)

dvb_nit_settings/rep_interval Integer

The NIT interval in ms, for the entire MPTS.

Range: 25 – 10000 (Default is 500)

dvb_nit_settings/network_id Integer The numeric identifier of the network to which the MPTS belongs.
dvb_nit_settings/network_name String The network name.

fec_output_settings

Element Value Description
include_column_fec Boolean True means enable column-based FEC; must be true.
include_row_fec Boolean True means enables row-based FEC; enabled by default.
column_depth Integer Parameter D from SMPTE 2022-1. Range 4-20. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet.
row_length Integer

Parameter L from SMPTE 2022-1. Range 1-20. The width of the FEC protection matrix. This must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness.

If Row FEC is used, then this is the number of transport stream packets per row error correction packet.

Response

The response repeats back the data that you posted, with the addition of:

  • id: The newly assigned ID for the MPTS .

The response is identical to the response to a GET MPTS. For a complete example, see GET: Get the Attributes of an MPTS Output.