Multiplex: describe program - AWS Elemental MediaLive API Reference

Multiplex: describe program

URI

/prod/multiplexes/multiplexId/programs/programName

HTTP methods

DELETE

Operation ID: DeleteMultiplexProgram

Path parameters
NameTypeRequiredDescription
multiplexIdStringTrue
programNameStringTrue
Responses
Status codeResponse modelDescription
200MultiplexProgram

200 response

400InvalidRequest

400 response

403AccessDenied

403 response

404ResourceNotFound

404 response

409ResourceConflict

409 response

429LimitExceeded

429 response

500InternalServiceError

500 response

502BadGatewayException

502 response

504GatewayTimeoutException

504 response

GET

Operation ID: DescribeMultiplexProgram

Path parameters
NameTypeRequiredDescription
multiplexIdStringTrue
programNameStringTrue
Responses
Status codeResponse modelDescription
200MultiplexProgram

200 response

400InvalidRequest

400 response

403AccessDenied

403 response

404ResourceNotFound

404 response

429LimitExceeded

429 response

500InternalServiceError

500 response

502BadGatewayException

502 response

504GatewayTimeoutException

504 response

PUT

Operation ID: UpdateMultiplexProgram

Path parameters
NameTypeRequiredDescription
multiplexIdStringTrue
programNameStringTrue
Responses
Status codeResponse modelDescription
200UpdateMultiplexProgramResultModel

200 response

400InvalidRequest

400 response

403AccessDenied

403 response

404ResourceNotFound

404 response

409ResourceConflict

409 response

422MultiplexConfigurationValidationError

422 response

500InternalServiceError

500 response

502BadGatewayException

502 response

504GatewayTimeoutException

504 response

Schemas

Request bodies

{ "multiplexProgramSettings": { "preferredChannelPipeline": enum, "programNumber": integer, "serviceDescriptor": { "providerName": "string", "serviceName": "string" }, "videoSettings": { "constantBitrate": integer, "statmuxSettings": { "maximumBitrate": integer, "minimumBitrate": integer, "priority": integer } } } }

Response bodies

{ "channelId": "string", "multiplexProgramSettings": { "preferredChannelPipeline": enum, "programNumber": integer, "serviceDescriptor": { "providerName": "string", "serviceName": "string" }, "videoSettings": { "constantBitrate": integer, "statmuxSettings": { "maximumBitrate": integer, "minimumBitrate": integer, "priority": integer } } }, "packetIdentifiersMap": { "audioPids": [ integer ], "dvbSubPids": [ integer ], "dvbTeletextPid": integer, "etvPlatformPid": integer, "etvSignalPid": integer, "klvDataPids": [ integer ], "pcrPid": integer, "pmtPid": integer, "privateMetadataPid": integer, "scte27Pids": [ integer ], "scte35Pid": integer, "timedMetadataPid": integer, "videoPid": integer }, "pipelineDetails": [ { "activeChannelPipeline": "string", "pipelineId": "string" } ], "programName": "string" }
{ "multiplexProgram": { "channelId": "string", "multiplexProgramSettings": { "preferredChannelPipeline": enum, "programNumber": integer, "serviceDescriptor": { "providerName": "string", "serviceName": "string" }, "videoSettings": { "constantBitrate": integer, "statmuxSettings": { "maximumBitrate": integer, "minimumBitrate": integer, "priority": integer } } }, "packetIdentifiersMap": { "audioPids": [ integer ], "dvbSubPids": [ integer ], "dvbTeletextPid": integer, "etvPlatformPid": integer, "etvSignalPid": integer, "klvDataPids": [ integer ], "pcrPid": integer, "pmtPid": integer, "privateMetadataPid": integer, "scte27Pids": [ integer ], "scte35Pid": integer, "timedMetadataPid": integer, "videoPid": integer }, "pipelineDetails": [ { "activeChannelPipeline": "string", "pipelineId": "string" } ], "programName": "string" } }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string", "validationErrors": [ { "elementPath": "string", "errorMessage": "string" } ] }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }

Properties

AccessDenied

PropertyTypeRequiredDescription
message

string

False

BadGatewayException

PropertyTypeRequiredDescription
message

string

False

GatewayTimeoutException

PropertyTypeRequiredDescription
message

string

False

InternalServiceError

PropertyTypeRequiredDescription
message

string

False

InvalidRequest

PropertyTypeRequiredDescription
message

string

False

LimitExceeded

PropertyTypeRequiredDescription
message

string

False

MultiplexConfigurationValidationError

PropertyTypeRequiredDescription
message

string

False

The error message.

validationErrors

Array of type ValidationError

False

A collection of validation error responses.

MultiplexProgram

The multiplex program object.

PropertyTypeRequiredDescription
channelId

string

False

The MediaLive channel associated with the program.

multiplexProgramSettings

MultiplexProgramSettings

False

The settings for this multiplex program.

packetIdentifiersMap

MultiplexProgramPacketIdentifiersMap

False

The packet identifier map for this multiplex program.

pipelineDetails

Array of type MultiplexProgramPipelineDetail

False

Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.

programName

string

False

The name of the multiplex program.

MultiplexProgramPacketIdentifiersMap

Packet identifiers map for a given Multiplex program.

PropertyTypeRequiredDescription
audioPids

Array of type integer

False
dvbSubPids

Array of type integer

False
dvbTeletextPid

integer

False
etvPlatformPid

integer

False
etvSignalPid

integer

False
klvDataPids

Array of type integer

False
pcrPid

integer

False
pmtPid

integer

False
privateMetadataPid

integer

False
scte27Pids

Array of type integer

False
scte35Pid

integer

False
timedMetadataPid

integer

False
videoPid

integer

False

MultiplexProgramPipelineDetail

The current source for one of the pipelines in the multiplex.

PropertyTypeRequiredDescription
activeChannelPipeline

string

False

Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.

pipelineId

string

False

Identifies a specific pipeline in the multiplex.

MultiplexProgramServiceDescriptor

Transport stream service descriptor configuration for the Multiplex program.

PropertyTypeRequiredDescription
providerName

string

MaxLength: 256

True

Name of the provider.

serviceName

string

MaxLength: 256

True

Name of the service.

MultiplexProgramSettings

Multiplex Program settings configuration.

PropertyTypeRequiredDescription
preferredChannelPipeline

PreferredChannelPipeline

False

Indicates which pipeline is preferred by the multiplex for program ingest.

programNumber

integer

Minimum: 0

Maximum: 65535

True

Unique program number.

serviceDescriptor

MultiplexProgramServiceDescriptor

False

Transport stream service descriptor configuration for the Multiplex program.

videoSettings

MultiplexVideoSettings

False

Program video settings configuration.

MultiplexStatmuxVideoSettings

Statmux rate control settings

PropertyTypeRequiredDescription
maximumBitrate

integer

Minimum: 100000

Maximum: 100000000

False

Maximum statmux bitrate.

minimumBitrate

integer

Minimum: 100000

Maximum: 100000000

False

Minimum statmux bitrate.

priority

integer

Minimum: -5

Maximum: 5

False

The purpose of the priority is to use a combination of the\nmultiplex rate control algorithm and the QVBR capability of the\nencoder to prioritize the video quality of some channels in a\nmultiplex over others. Channels that have a higher priority will\nget higher video quality at the expense of the video quality of\nother channels in the multiplex with lower priority.

MultiplexVideoSettings

The video configuration for each program in a multiplex.

PropertyTypeRequiredDescription
constantBitrate

integer

Minimum: 100000

Maximum: 100000000

False

The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.

statmuxSettings

MultiplexStatmuxVideoSettings

False

Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.

PreferredChannelPipeline

Indicates which pipeline is preferred by the multiplex for program ingest. If set to \"PIPELINE_0\" or \"PIPELINE_1\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline, it will switch back once that ingest is healthy again. If set to \"CURRENTLY_ACTIVE\", it will not switch back to the other pipeline based on it recovering to a healthy state, it will only switch if the active pipeline becomes unhealthy.

  • CURRENTLY_ACTIVE

  • PIPELINE_0

  • PIPELINE_1

ResourceConflict

PropertyTypeRequiredDescription
message

string

False

ResourceNotFound

PropertyTypeRequiredDescription
message

string

False

UpdateMultiplexProgram

PropertyTypeRequiredDescription
multiplexProgramSettings

MultiplexProgramSettings

False

The new settings for a multiplex program.

UpdateMultiplexProgramResultModel

PropertyTypeRequiredDescription
multiplexProgram

MultiplexProgram

False

The updated multiplex program.

ValidationError

PropertyTypeRequiredDescription
elementPath

string

False

Path to the source of the error.

errorMessage

string

False

The error message.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DeleteMultiplexProgram

DescribeMultiplexProgram

UpdateMultiplexProgram