[ aws . medialive ]

create-multiplex-program

Description

Create a new program in the multiplex.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-multiplex-program
--multiplex-id <value>
--multiplex-program-settings <value>
--program-name <value>
[--request-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--multiplex-id (string) ID of the multiplex where the program is to be created.

--multiplex-program-settings (structure) 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 -> (structure)

Transport stream service descriptor configuration for the Multiplex program.

ProviderName -> (string)

Name of the provider.

ServiceName -> (string)

Name of the service.

VideoSettings -> (structure)

Program video settings configuration.

ConstantBitrate -> (integer)

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

StatmuxSettings -> (structure)

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

MaximumBitrate -> (integer)

Maximum statmux bitrate.

MinimumBitrate -> (integer)

Minimum statmux bitrate.

Shorthand Syntax:

PreferredChannelPipeline=string,ProgramNumber=integer,ServiceDescriptor={ProviderName=string,ServiceName=string},VideoSettings={ConstantBitrate=integer,StatmuxSettings={MaximumBitrate=integer,MinimumBitrate=integer}}

JSON Syntax:

{
  "PreferredChannelPipeline": "CURRENTLY_ACTIVE"|"PIPELINE_0"|"PIPELINE_1",
  "ProgramNumber": integer,
  "ServiceDescriptor": {
    "ProviderName": "string",
    "ServiceName": "string"
  },
  "VideoSettings": {
    "ConstantBitrate": integer,
    "StatmuxSettings": {
      "MaximumBitrate": integer,
      "MinimumBitrate": integer
    }
  }
}

--program-name (string) Name of multiplex program.

--request-id (string) Unique request ID. This prevents retries from creating multiple resources.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

MultiplexProgram -> (structure)

The newly created multiplex program.

ChannelId -> (string)

The MediaLive channel associated with the program.

MultiplexProgramSettings -> (structure)

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 -> (structure)

Transport stream service descriptor configuration for the Multiplex program.

ProviderName -> (string)

Name of the provider.

ServiceName -> (string)

Name of the service.

VideoSettings -> (structure)

Program video settings configuration.

ConstantBitrate -> (integer)

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

StatmuxSettings -> (structure)

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

MaximumBitrate -> (integer)

Maximum statmux bitrate.

MinimumBitrate -> (integer)

Minimum statmux bitrate.

PacketIdentifiersMap -> (structure)

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

ProgramName -> (string)

The name of the multiplex program.