AWS API Changes

2024/08/12 - AWS Elemental MediaLive - 5 updated api methods

Changes AWS Elemental MediaLive now supports now supports editing the PID values for a Multiplex.

CreateMultiplexProgram (updated)

Link ¶
Changes (response)

{'MultiplexProgram': {'PacketIdentifiersMap': {'AribCaptionsPid': 'integer',
                                               'DvbTeletextPids': ['integer'],
                                               'EcmPid': 'integer',
                                               'Smpte2038Pid': 'integer'}}}

Create a new program in the multiplex.

See also: AWS API Documentation

Request Syntax

client.create_multiplex_program(
    MultiplexId='string',
    MultiplexProgramSettings={
        'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
        'ProgramNumber': 123,
        'ServiceDescriptor': {
            'ProviderName': 'string',
            'ServiceName': 'string'
        },
        'VideoSettings': {
            'ConstantBitrate': 123,
            'StatmuxSettings': {
                'MaximumBitrate': 123,
                'MinimumBitrate': 123,
                'Priority': 123
            }
        }
    },
    ProgramName='string',
    RequestId='string'
)

type MultiplexId

string

param MultiplexId

[REQUIRED] ID of the multiplex where the program is to be created.

type MultiplexProgramSettings

dict

param MultiplexProgramSettings

[REQUIRED] The settings for this multiplex program.

PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
ProgramNumber (integer) -- [REQUIRED] Unique program number.
ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
- ProviderName (string) -- [REQUIRED] Name of the provider.
- ServiceName (string) -- [REQUIRED] Name of the service.
VideoSettings (dict) -- Program video settings configuration.
- ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
- StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
  - MaximumBitrate (integer) -- Maximum statmux bitrate.
  - MinimumBitrate (integer) -- Minimum statmux bitrate.
  - Priority (integer) -- The purpose of the priority is to use a combination of thenmultiplex rate control algorithm and the QVBR capability of thenencoder to prioritize the video quality of some channels in anmultiplex over others. Channels that have a higher priority willnget higher video quality at the expense of the video quality ofnother channels in the multiplex with lower priority.

type ProgramName

string

param ProgramName

[REQUIRED] Name of multiplex program.

type RequestId

string

param RequestId

[REQUIRED] Unique request ID. This prevents retries from creating multiple resources.This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'MultiplexProgram': {
        'ChannelId': 'string',
        'MultiplexProgramSettings': {
            'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
            'ProgramNumber': 123,
            'ServiceDescriptor': {
                'ProviderName': 'string',
                'ServiceName': 'string'
            },
            'VideoSettings': {
                'ConstantBitrate': 123,
                'StatmuxSettings': {
                    'MaximumBitrate': 123,
                    'MinimumBitrate': 123,
                    'Priority': 123
                }
            }
        },
        'PacketIdentifiersMap': {
            'AudioPids': [
                123,
            ],
            'DvbSubPids': [
                123,
            ],
            'DvbTeletextPid': 123,
            'EtvPlatformPid': 123,
            'EtvSignalPid': 123,
            'KlvDataPids': [
                123,
            ],
            'PcrPid': 123,
            'PmtPid': 123,
            'PrivateMetadataPid': 123,
            'Scte27Pids': [
                123,
            ],
            'Scte35Pid': 123,
            'TimedMetadataPid': 123,
            'VideoPid': 123,
            'AribCaptionsPid': 123,
            'DvbTeletextPids': [
                123,
            ],
            'EcmPid': 123,
            'Smpte2038Pid': 123
        },
        'PipelineDetails': [
            {
                'ActiveChannelPipeline': 'string',
                'PipelineId': 'string'
            },
        ],
        'ProgramName': 'string'
    }
}

Response Structure

(dict) -- Creation of the program is in progress.
- MultiplexProgram (dict) -- The newly created multiplex program.
  - ChannelId (string) -- The MediaLive channel associated with the program.
  - MultiplexProgramSettings (dict) -- The settings for this multiplex program.
    - PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
    - ProgramNumber (integer) -- Unique program number.
    - ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
      - ProviderName (string) -- Name of the provider.
      - ServiceName (string) -- Name of the service.
    - VideoSettings (dict) -- Program video settings configuration.
      - ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
      - StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
        
        MaximumBitrate (integer) -- Maximum statmux bitrate.
        
        MinimumBitrate (integer) -- Minimum statmux bitrate.
        
        Priority (integer) -- The purpose of the priority is to use a combination of thenmultiplex rate control algorithm and the QVBR capability of thenencoder to prioritize the video quality of some channels in anmultiplex over others. Channels that have a higher priority willnget higher video quality at the expense of the video quality ofnother channels in the multiplex with lower priority.
  - PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
    - AudioPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - DvbSubPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - DvbTeletextPid (integer) -- Placeholder documentation for __integer
    - EtvPlatformPid (integer) -- Placeholder documentation for __integer
    - EtvSignalPid (integer) -- Placeholder documentation for __integer
    - KlvDataPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - PcrPid (integer) -- Placeholder documentation for __integer
    - PmtPid (integer) -- Placeholder documentation for __integer
    - PrivateMetadataPid (integer) -- Placeholder documentation for __integer
    - Scte27Pids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - Scte35Pid (integer) -- Placeholder documentation for __integer
    - TimedMetadataPid (integer) -- Placeholder documentation for __integer
    - VideoPid (integer) -- Placeholder documentation for __integer
    - AribCaptionsPid (integer) -- Placeholder documentation for __integer
    - DvbTeletextPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - EcmPid (integer) -- Placeholder documentation for __integer
    - Smpte2038Pid (integer) -- Placeholder documentation for __integer
  - PipelineDetails (list) -- 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.
    - (dict) -- The current source for one of the pipelines in the multiplex.
      - ActiveChannelPipeline (string) -- Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.
      - PipelineId (string) -- Identifies a specific pipeline in the multiplex.
  - ProgramName (string) -- The name of the multiplex program.

DeleteMultiplexProgram (updated)

Link ¶
Changes (response)

{'PacketIdentifiersMap': {'AribCaptionsPid': 'integer',
                          'DvbTeletextPids': ['integer'],
                          'EcmPid': 'integer',
                          'Smpte2038Pid': 'integer'}}

Delete a program from a multiplex.

See also: AWS API Documentation

Request Syntax

client.delete_multiplex_program(
    MultiplexId='string',
    ProgramName='string'
)

type MultiplexId

string

param MultiplexId

[REQUIRED] The ID of the multiplex that the program belongs to.

type ProgramName

string

param ProgramName

[REQUIRED] The multiplex program name.

rtype

dict

returns

Response Syntax

{
    'ChannelId': 'string',
    'MultiplexProgramSettings': {
        'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
        'ProgramNumber': 123,
        'ServiceDescriptor': {
            'ProviderName': 'string',
            'ServiceName': 'string'
        },
        'VideoSettings': {
            'ConstantBitrate': 123,
            'StatmuxSettings': {
                'MaximumBitrate': 123,
                'MinimumBitrate': 123,
                'Priority': 123
            }
        }
    },
    'PacketIdentifiersMap': {
        'AudioPids': [
            123,
        ],
        'DvbSubPids': [
            123,
        ],
        'DvbTeletextPid': 123,
        'EtvPlatformPid': 123,
        'EtvSignalPid': 123,
        'KlvDataPids': [
            123,
        ],
        'PcrPid': 123,
        'PmtPid': 123,
        'PrivateMetadataPid': 123,
        'Scte27Pids': [
            123,
        ],
        'Scte35Pid': 123,
        'TimedMetadataPid': 123,
        'VideoPid': 123,
        'AribCaptionsPid': 123,
        'DvbTeletextPids': [
            123,
        ],
        'EcmPid': 123,
        'Smpte2038Pid': 123
    },
    'PipelineDetails': [
        {
            'ActiveChannelPipeline': 'string',
            'PipelineId': 'string'
        },
    ],
    'ProgramName': 'string'
}

Response Structure

(dict) -- Deletion of the program is in progress.
- ChannelId (string) -- The MediaLive channel associated with the program.
- MultiplexProgramSettings (dict) -- The settings for this multiplex program.
  - PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
  - ProgramNumber (integer) -- Unique program number.
  - ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
    - ProviderName (string) -- Name of the provider.
    - ServiceName (string) -- Name of the service.
  - VideoSettings (dict) -- Program video settings configuration.
    - ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
    - StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
      - MaximumBitrate (integer) -- Maximum statmux bitrate.
      - MinimumBitrate (integer) -- Minimum statmux bitrate.
      - Priority (integer) -- The purpose of the priority is to use a combination of thenmultiplex rate control algorithm and the QVBR capability of thenencoder to prioritize the video quality of some channels in anmultiplex over others. Channels that have a higher priority willnget higher video quality at the expense of the video quality ofnother channels in the multiplex with lower priority.
- PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
  - AudioPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - DvbSubPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - DvbTeletextPid (integer) -- Placeholder documentation for __integer
  - EtvPlatformPid (integer) -- Placeholder documentation for __integer
  - EtvSignalPid (integer) -- Placeholder documentation for __integer
  - KlvDataPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - PcrPid (integer) -- Placeholder documentation for __integer
  - PmtPid (integer) -- Placeholder documentation for __integer
  - PrivateMetadataPid (integer) -- Placeholder documentation for __integer
  - Scte27Pids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - Scte35Pid (integer) -- Placeholder documentation for __integer
  - TimedMetadataPid (integer) -- Placeholder documentation for __integer
  - VideoPid (integer) -- Placeholder documentation for __integer
  - AribCaptionsPid (integer) -- Placeholder documentation for __integer
  - DvbTeletextPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - EcmPid (integer) -- Placeholder documentation for __integer
  - Smpte2038Pid (integer) -- Placeholder documentation for __integer
- PipelineDetails (list) -- 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.
  - (dict) -- The current source for one of the pipelines in the multiplex.
    - ActiveChannelPipeline (string) -- Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.
    - PipelineId (string) -- Identifies a specific pipeline in the multiplex.
- ProgramName (string) -- The name of the multiplex program.

DescribeMultiplexProgram (updated)

Link ¶
Changes (response)

{'PacketIdentifiersMap': {'AribCaptionsPid': 'integer',
                          'DvbTeletextPids': ['integer'],
                          'EcmPid': 'integer',
                          'Smpte2038Pid': 'integer'}}

Get the details for a program in a multiplex.

See also: AWS API Documentation

Request Syntax

client.describe_multiplex_program(
    MultiplexId='string',
    ProgramName='string'
)

type MultiplexId

string

param MultiplexId

[REQUIRED] The ID of the multiplex that the program belongs to.

type ProgramName

string

param ProgramName

[REQUIRED] The name of the program.

rtype

dict

returns

Response Syntax

{
    'ChannelId': 'string',
    'MultiplexProgramSettings': {
        'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
        'ProgramNumber': 123,
        'ServiceDescriptor': {
            'ProviderName': 'string',
            'ServiceName': 'string'
        },
        'VideoSettings': {
            'ConstantBitrate': 123,
            'StatmuxSettings': {
                'MaximumBitrate': 123,
                'MinimumBitrate': 123,
                'Priority': 123
            }
        }
    },
    'PacketIdentifiersMap': {
        'AudioPids': [
            123,
        ],
        'DvbSubPids': [
            123,
        ],
        'DvbTeletextPid': 123,
        'EtvPlatformPid': 123,
        'EtvSignalPid': 123,
        'KlvDataPids': [
            123,
        ],
        'PcrPid': 123,
        'PmtPid': 123,
        'PrivateMetadataPid': 123,
        'Scte27Pids': [
            123,
        ],
        'Scte35Pid': 123,
        'TimedMetadataPid': 123,
        'VideoPid': 123,
        'AribCaptionsPid': 123,
        'DvbTeletextPids': [
            123,
        ],
        'EcmPid': 123,
        'Smpte2038Pid': 123
    },
    'PipelineDetails': [
        {
            'ActiveChannelPipeline': 'string',
            'PipelineId': 'string'
        },
    ],
    'ProgramName': 'string'
}

Response Structure

(dict) -- The details of one program.
- ChannelId (string) -- The MediaLive channel associated with the program.
- MultiplexProgramSettings (dict) -- The settings for this multiplex program.
  - PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
  - ProgramNumber (integer) -- Unique program number.
  - ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
    - ProviderName (string) -- Name of the provider.
    - ServiceName (string) -- Name of the service.
  - VideoSettings (dict) -- Program video settings configuration.
    - ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
    - StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
      - MaximumBitrate (integer) -- Maximum statmux bitrate.
      - MinimumBitrate (integer) -- Minimum statmux bitrate.
      - Priority (integer) -- The purpose of the priority is to use a combination of thenmultiplex rate control algorithm and the QVBR capability of thenencoder to prioritize the video quality of some channels in anmultiplex over others. Channels that have a higher priority willnget higher video quality at the expense of the video quality ofnother channels in the multiplex with lower priority.
- PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
  - AudioPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - DvbSubPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - DvbTeletextPid (integer) -- Placeholder documentation for __integer
  - EtvPlatformPid (integer) -- Placeholder documentation for __integer
  - EtvSignalPid (integer) -- Placeholder documentation for __integer
  - KlvDataPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - PcrPid (integer) -- Placeholder documentation for __integer
  - PmtPid (integer) -- Placeholder documentation for __integer
  - PrivateMetadataPid (integer) -- Placeholder documentation for __integer
  - Scte27Pids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - Scte35Pid (integer) -- Placeholder documentation for __integer
  - TimedMetadataPid (integer) -- Placeholder documentation for __integer
  - VideoPid (integer) -- Placeholder documentation for __integer
  - AribCaptionsPid (integer) -- Placeholder documentation for __integer
  - DvbTeletextPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - EcmPid (integer) -- Placeholder documentation for __integer
  - Smpte2038Pid (integer) -- Placeholder documentation for __integer
- PipelineDetails (list) -- 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.
  - (dict) -- The current source for one of the pipelines in the multiplex.
    - ActiveChannelPipeline (string) -- Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.
    - PipelineId (string) -- Identifies a specific pipeline in the multiplex.
- ProgramName (string) -- The name of the multiplex program.

UpdateMultiplex (updated)

Link ¶
Changes (request)

{'PacketIdentifiersMapping': {'string': {'AribCaptionsPid': 'integer',
                                         'AudioPids': ['integer'],
                                         'DvbSubPids': ['integer'],
                                         'DvbTeletextPid': 'integer',
                                         'DvbTeletextPids': ['integer'],
                                         'EcmPid': 'integer',
                                         'EtvPlatformPid': 'integer',
                                         'EtvSignalPid': 'integer',
                                         'KlvDataPids': ['integer'],
                                         'PcrPid': 'integer',
                                         'PmtPid': 'integer',
                                         'PrivateMetadataPid': 'integer',
                                         'Scte27Pids': ['integer'],
                                         'Scte35Pid': 'integer',
                                         'Smpte2038Pid': 'integer',
                                         'TimedMetadataPid': 'integer',
                                         'VideoPid': 'integer'}}}

Updates a multiplex.

See also: AWS API Documentation

Request Syntax

client.update_multiplex(
    MultiplexId='string',
    MultiplexSettings={
        'MaximumVideoBufferDelayMilliseconds': 123,
        'TransportStreamBitrate': 123,
        'TransportStreamId': 123,
        'TransportStreamReservedBitrate': 123
    },
    Name='string',
    PacketIdentifiersMapping={
        'string': {
            'AudioPids': [
                123,
            ],
            'DvbSubPids': [
                123,
            ],
            'DvbTeletextPid': 123,
            'EtvPlatformPid': 123,
            'EtvSignalPid': 123,
            'KlvDataPids': [
                123,
            ],
            'PcrPid': 123,
            'PmtPid': 123,
            'PrivateMetadataPid': 123,
            'Scte27Pids': [
                123,
            ],
            'Scte35Pid': 123,
            'TimedMetadataPid': 123,
            'VideoPid': 123,
            'AribCaptionsPid': 123,
            'DvbTeletextPids': [
                123,
            ],
            'EcmPid': 123,
            'Smpte2038Pid': 123
        }
    }
)

type MultiplexId

string

param MultiplexId

[REQUIRED] ID of the multiplex to update.

type MultiplexSettings

dict

param MultiplexSettings

The new settings for a multiplex.

MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
TransportStreamBitrate (integer) -- [REQUIRED] Transport stream bit rate.
TransportStreamId (integer) -- [REQUIRED] Transport stream ID.
TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.

type Name

string

param Name

Name of the multiplex.

type PacketIdentifiersMapping

dict

param PacketIdentifiersMapping

Placeholder documentation for MultiplexPacketIdentifiersMapping

(string) -- Placeholder documentation for __string
- (dict) -- Packet identifiers map for a given Multiplex program.
  - AudioPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - DvbSubPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - DvbTeletextPid (integer) -- Placeholder documentation for __integer
  - EtvPlatformPid (integer) -- Placeholder documentation for __integer
  - EtvSignalPid (integer) -- Placeholder documentation for __integer
  - KlvDataPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - PcrPid (integer) -- Placeholder documentation for __integer
  - PmtPid (integer) -- Placeholder documentation for __integer
  - PrivateMetadataPid (integer) -- Placeholder documentation for __integer
  - Scte27Pids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - Scte35Pid (integer) -- Placeholder documentation for __integer
  - TimedMetadataPid (integer) -- Placeholder documentation for __integer
  - VideoPid (integer) -- Placeholder documentation for __integer
  - AribCaptionsPid (integer) -- Placeholder documentation for __integer
  - DvbTeletextPids (list) -- Placeholder documentation for __listOf__integer
    - (integer) -- Placeholder documentation for __integer
  - EcmPid (integer) -- Placeholder documentation for __integer
  - Smpte2038Pid (integer) -- Placeholder documentation for __integer

rtype

dict

returns

Response Syntax

{
    'Multiplex': {
        'Arn': 'string',
        'AvailabilityZones': [
            'string',
        ],
        'Destinations': [
            {
                'MediaConnectSettings': {
                    'EntitlementArn': 'string'
                }
            },
        ],
        'Id': 'string',
        'MultiplexSettings': {
            'MaximumVideoBufferDelayMilliseconds': 123,
            'TransportStreamBitrate': 123,
            'TransportStreamId': 123,
            'TransportStreamReservedBitrate': 123
        },
        'Name': 'string',
        'PipelinesRunningCount': 123,
        'ProgramCount': 123,
        'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) -- The update to the multiplex has succeeded.
- Multiplex (dict) -- The updated multiplex.
  - Arn (string) -- The unique arn of the multiplex.
  - AvailabilityZones (list) -- A list of availability zones for the multiplex.
    - (string) -- Placeholder documentation for __string
  - Destinations (list) -- A list of the multiplex output destinations.
    - (dict) -- Multiplex output destination settings
      - MediaConnectSettings (dict) -- Multiplex MediaConnect output destination settings.
        
        EntitlementArn (string) -- The MediaConnect entitlement ARN available as a Flow source.
  - Id (string) -- The unique id of the multiplex.
  - MultiplexSettings (dict) -- Configuration for a multiplex event.
    - MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
    - TransportStreamBitrate (integer) -- Transport stream bit rate.
    - TransportStreamId (integer) -- Transport stream ID.
    - TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.
  - Name (string) -- The name of the multiplex.
  - PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
  - ProgramCount (integer) -- The number of programs in the multiplex.
  - State (string) -- The current state of the multiplex.
  - Tags (dict) -- A collection of key-value pairs.
    - (string) -- Placeholder documentation for __string
      - (string) -- Placeholder documentation for __string

UpdateMultiplexProgram (updated)

Link ¶
Changes (response)

{'MultiplexProgram': {'PacketIdentifiersMap': {'AribCaptionsPid': 'integer',
                                               'DvbTeletextPids': ['integer'],
                                               'EcmPid': 'integer',
                                               'Smpte2038Pid': 'integer'}}}

Update a program in a multiplex.

See also: AWS API Documentation

Request Syntax

client.update_multiplex_program(
    MultiplexId='string',
    MultiplexProgramSettings={
        'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
        'ProgramNumber': 123,
        'ServiceDescriptor': {
            'ProviderName': 'string',
            'ServiceName': 'string'
        },
        'VideoSettings': {
            'ConstantBitrate': 123,
            'StatmuxSettings': {
                'MaximumBitrate': 123,
                'MinimumBitrate': 123,
                'Priority': 123
            }
        }
    },
    ProgramName='string'
)

type MultiplexId

string

param MultiplexId

[REQUIRED] The ID of the multiplex of the program to update.

type MultiplexProgramSettings

dict

param MultiplexProgramSettings

The new settings for a multiplex program.

PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
ProgramNumber (integer) -- [REQUIRED] Unique program number.
ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
- ProviderName (string) -- [REQUIRED] Name of the provider.
- ServiceName (string) -- [REQUIRED] Name of the service.
VideoSettings (dict) -- Program video settings configuration.
- ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
- StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
  - MaximumBitrate (integer) -- Maximum statmux bitrate.
  - MinimumBitrate (integer) -- Minimum statmux bitrate.
  - Priority (integer) -- The purpose of the priority is to use a combination of thenmultiplex rate control algorithm and the QVBR capability of thenencoder to prioritize the video quality of some channels in anmultiplex over others. Channels that have a higher priority willnget higher video quality at the expense of the video quality ofnother channels in the multiplex with lower priority.

type ProgramName

string

param ProgramName

[REQUIRED] The name of the program to update.

rtype

dict

returns

Response Syntax

{
    'MultiplexProgram': {
        'ChannelId': 'string',
        'MultiplexProgramSettings': {
            'PreferredChannelPipeline': 'CURRENTLY_ACTIVE'|'PIPELINE_0'|'PIPELINE_1',
            'ProgramNumber': 123,
            'ServiceDescriptor': {
                'ProviderName': 'string',
                'ServiceName': 'string'
            },
            'VideoSettings': {
                'ConstantBitrate': 123,
                'StatmuxSettings': {
                    'MaximumBitrate': 123,
                    'MinimumBitrate': 123,
                    'Priority': 123
                }
            }
        },
        'PacketIdentifiersMap': {
            'AudioPids': [
                123,
            ],
            'DvbSubPids': [
                123,
            ],
            'DvbTeletextPid': 123,
            'EtvPlatformPid': 123,
            'EtvSignalPid': 123,
            'KlvDataPids': [
                123,
            ],
            'PcrPid': 123,
            'PmtPid': 123,
            'PrivateMetadataPid': 123,
            'Scte27Pids': [
                123,
            ],
            'Scte35Pid': 123,
            'TimedMetadataPid': 123,
            'VideoPid': 123,
            'AribCaptionsPid': 123,
            'DvbTeletextPids': [
                123,
            ],
            'EcmPid': 123,
            'Smpte2038Pid': 123
        },
        'PipelineDetails': [
            {
                'ActiveChannelPipeline': 'string',
                'PipelineId': 'string'
            },
        ],
        'ProgramName': 'string'
    }
}

Response Structure

(dict) -- The update to the program has succeeded.
- MultiplexProgram (dict) -- The updated multiplex program.
  - ChannelId (string) -- The MediaLive channel associated with the program.
  - MultiplexProgramSettings (dict) -- The settings for this multiplex program.
    - PreferredChannelPipeline (string) -- Indicates which pipeline is preferred by the multiplex for program ingest.
    - ProgramNumber (integer) -- Unique program number.
    - ServiceDescriptor (dict) -- Transport stream service descriptor configuration for the Multiplex program.
      - ProviderName (string) -- Name of the provider.
      - ServiceName (string) -- Name of the service.
    - VideoSettings (dict) -- Program video settings configuration.
      - ConstantBitrate (integer) -- The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.
      - StatmuxSettings (dict) -- Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.
        
        MaximumBitrate (integer) -- Maximum statmux bitrate.
        
        MinimumBitrate (integer) -- Minimum statmux bitrate.
        
        Priority (integer) -- The purpose of the priority is to use a combination of thenmultiplex rate control algorithm and the QVBR capability of thenencoder to prioritize the video quality of some channels in anmultiplex over others. Channels that have a higher priority willnget higher video quality at the expense of the video quality ofnother channels in the multiplex with lower priority.
  - PacketIdentifiersMap (dict) -- The packet identifier map for this multiplex program.
    - AudioPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - DvbSubPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - DvbTeletextPid (integer) -- Placeholder documentation for __integer
    - EtvPlatformPid (integer) -- Placeholder documentation for __integer
    - EtvSignalPid (integer) -- Placeholder documentation for __integer
    - KlvDataPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - PcrPid (integer) -- Placeholder documentation for __integer
    - PmtPid (integer) -- Placeholder documentation for __integer
    - PrivateMetadataPid (integer) -- Placeholder documentation for __integer
    - Scte27Pids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - Scte35Pid (integer) -- Placeholder documentation for __integer
    - TimedMetadataPid (integer) -- Placeholder documentation for __integer
    - VideoPid (integer) -- Placeholder documentation for __integer
    - AribCaptionsPid (integer) -- Placeholder documentation for __integer
    - DvbTeletextPids (list) -- Placeholder documentation for __listOf__integer
      - (integer) -- Placeholder documentation for __integer
    - EcmPid (integer) -- Placeholder documentation for __integer
    - Smpte2038Pid (integer) -- Placeholder documentation for __integer
  - PipelineDetails (list) -- 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.
    - (dict) -- The current source for one of the pipelines in the multiplex.
      - ActiveChannelPipeline (string) -- Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex.
      - PipelineId (string) -- Identifies a specific pipeline in the multiplex.
  - ProgramName (string) -- The name of the multiplex program.