Channels

200 response

400 response

403 response

429 response

500 response

502 response

504 response

201 response

400 response

403 response

409 response

422 response

429 response

500 response

502 response

504 response

number

Average bitrate in bits/second. Valid values depend on rate control mode and profile.

AacCodingMode

Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.

AacInputType

Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD.

AacProfile

AAC Profile.

AacRateControlMode

Rate Control Mode.

AacRawFormat

Sets LATM / LOAS AAC output for raw containers.

number

Sample rate in Hz. Valid values depend on rate control mode and profile.

AacSpec

Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.

AacVbrQuality

VBR Quality Level - Only used if rateControlMode is VBR.

number

Average bitrate in bits/second. Valid bitrates depend on the coding mode.

Ac3BitstreamMode

Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.

Ac3CodingMode

Dolby Digital coding mode. Determines number of channels.

integer

Minimum: 1

Maximum: 31

Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.

Ac3DrcProfile

If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.

Ac3LfeFilter

When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.

Ac3MetadataControl

When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.

string

integer

Minimum: 1

Maximum: 4

Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field.

ArchiveS3Settings

M2tsSettings

RawSettings

ArchiveCdnSettings

Parameters that control interactions with the CDN.

OutputLocationRef

A directory and base filename where archive files should be written.

integer

Minimum: 1

Number of seconds to write to archive file before closing and starting a new one.

ArchiveContainerSettings

Settings specific to the container type of the file.

string

Output file extension. If excluded, this will be auto-selected from the container type.

string

String concatenated to the end of the destination filename. Required for multiple outputs of the same type.

S3CannedAcl

Specify the canned ACL to apply to each S3 request. Defaults to none.

ArchiveS3LogUploads

When set to enabled, each upload to CDN or server will be logged.

Array of type InputChannelLevel

Indices and gain values for each input channel that should be remixed into this output channel.

integer

Minimum: 0

Maximum: 7

The index of the output channel being produced.

AacSettings

Ac3Settings

Eac3Settings

Mp2Settings

PassThroughSettings

WavSettings

AudioNormalizationSettings

Advanced audio normalization settings.

string

The name of the AudioSelector used as the source for this AudioDescription.

AudioType

Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.

AudioDescriptionAudioTypeControl

Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.

AudioWatermarkSettings

Settings to configure one or more solutions that insert audio watermarks in the audio encode

AudioCodecSettings

Audio codec settings.

string

MinLength: 1

MaxLength: 35

RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.

AudioDescriptionLanguageCodeControl

Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.

string

The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.

RemixSettings

Settings that control how input audio channels are remixed into the output audio channels.

string

Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).

string

MinLength: 1

Specifies the GROUP-ID in the #EXT-X-MEDIA tag of the target HLS audio rendition.

string

MinLength: 1

Specifies the NAME in the #EXT-X-MEDIA tag of the target HLS audio rendition.

string

Selects a specific three-letter language code from within an audio source.

AudioLanguageSelectionPolicy

When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language.

AudioNormalizationAlgorithm

Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.

AudioNormalizationAlgorithmControl

When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted.

number

Minimum: -59

Maximum: 0

Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.

string

Specifies the group to which the audio Rendition belongs.

InputLocation

Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.

AudioOnlyHlsTrackType

Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO

AudioOnlyHlsSegmentType

Specifies the segment type.

integer

Minimum: 0

Maximum: 8191

Selects a specific PID from within a source.

string

MinLength: 1

The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.

AudioSelectorSettings

The audio selector settings.

AudioHlsRenditionSelection

AudioLanguageSelection

AudioPidSelection

AudioTrackSelection

string

The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank.

integer

Minimum: 1000

The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS.

integer

Minimum: 1

1-based integer value that maps to a specific audio track

Array of type AudioTrack

Selects one or more unique audio tracks from within a source.

NielsenWatermarksSettings

Settings to configure Nielsen Watermarks in the audio encode

integer

Minimum: 1

This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input.

Array of type FailoverCondition

A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input.

InputPreference

Input preference when deciding which input to make active when a previously failed input has recovered.

string

The input ID of the secondary input in the automatic input failover pair.

InputLocation

Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.

AvailBlankingState

When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.

AvailSettings

Ad avail settings.

Scte35SpliceInsert

Scte35TimeSignalApos

string

InputLocation

Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.

BlackoutSlateNetworkEndBlackout

Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".

InputLocation

Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

string

MinLength: 34

MaxLength: 34

Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

BlackoutSlateState

When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

BurnInAlignment

If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

BurnInBackgroundColor

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 0

Maximum: 255

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

InputLocation

External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

BurnInFontColor

Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 0

Maximum: 255

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 96

Maximum: 600

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

string

When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.

BurnInOutlineColor

Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 0

Maximum: 10

Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

BurnInShadowColor

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 0

Maximum: 255

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

integer

Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.

integer

Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.

BurnInTeletextGridControl

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

integer

Minimum: 0

Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 0

Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.

string

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

CaptionDestinationSettings

Additional settings for captions destination that depend on the destination type.

string

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

string

Human readable information to indicate captions available for players (eg. English, or Spanish).

string

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

AribDestinationSettings

BurnInDestinationSettings

DvbSubDestinationSettings

EbuTtDDestinationSettings

EmbeddedDestinationSettings

EmbeddedPlusScte20DestinationSettings

RtmpCaptionInfoDestinationSettings

Scte20PlusEmbeddedDestinationSettings

Scte27DestinationSettings

SmpteTtDestinationSettings

TeletextDestinationSettings

TtmlDestinationSettings

WebvttDestinationSettings

integer

Minimum: 1

Maximum: 4

The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)

string

MinLength: 3

MaxLength: 3

Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)

string

MinLength: 1

Textual description of language

number

Minimum: 0

Maximum: 100

See the description in leftOffset. For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \"80\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:extent - Y in the TTML standard.

number

Minimum: 0

Maximum: 100

Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them. For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard.

number

Minimum: 0

Maximum: 100

See the description in leftOffset. For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard.

number

Minimum: 0

Maximum: 100

See the description in leftOffset. For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \"80\" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard.

string

When specified this field indicates the three letter language code of the caption track to extract from the source.

string

MinLength: 1

Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.

CaptionSelectorSettings

Caption selector settings.

AncillarySourceSettings

AribSourceSettings

DvbSubSourceSettings

EmbeddedSourceSettings

Scte20SourceSettings

Scte27SourceSettings

TeletextSourceSettings

CdiInputResolution

Maximum CDI input resolution

string

The unique arn of the channel.

CdiInputSpecification

Specification of CDI inputs for this channel

ChannelClass

The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

Array of type OutputDestination

A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.

Array of type ChannelEgressEndpoint

The endpoints where outgoing connections initiate from

EncoderSettings

string

The unique ID of the channel.

Array of type InputAttachment

List of input attachments for channel.

InputSpecification

Specification of network and file inputs for this channel

LogLevel

The log level being written to CloudWatch Logs.

MaintenanceStatus

Maintenance settings for this channel.

string

The name of the channel. (user-mutable)

Array of type PipelineDetail

Runtime details for the pipelines of a running channel.

integer

The number of currently healthy pipelines.

string

The Amazon Resource Name (ARN) of the role assumed when running the Channel.

ChannelState

Tags

A collection of key-value pairs.

VpcOutputSettingsDescription

Settings for VPC output

string

Array of type ValidationError

A collection of validation error responses.

string

Public IP of where a channel's output comes from

string

The unique arn of the channel.

CdiInputSpecification

Specification of CDI inputs for this channel

ChannelClass

The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

Array of type OutputDestination

A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.

Array of type ChannelEgressEndpoint

The endpoints where outgoing connections initiate from

string

The unique id of the channel.

Array of type InputAttachment

List of input attachments for channel.

InputSpecification

Specification of network and file inputs for this channel

LogLevel

The log level being written to CloudWatch Logs.

MaintenanceStatus

Maintenance settings for this channel.

string

The name of the channel. (user-mutable)

integer

The number of currently healthy pipelines.

string

The Amazon Resource Name (ARN) of the role assumed when running the Channel.

ChannelState

Tags

A collection of key-value pairs.

VpcOutputSettingsDescription

Settings for any VPC outputs.

CdiInputSpecification

Specification of CDI inputs for this channel

ChannelClass

The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

Array of type OutputDestination

EncoderSettings

Array of type InputAttachment

List of input attachments for channel.

InputSpecification

Specification of network and file inputs for this channel

LogLevel

The log level to write to CloudWatch Logs.

MaintenanceCreateSettings

Maintenance settings for this channel.

string

Name of channel.

string

Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.

string

Deprecated field that's only usable by whitelisted customers.

string

An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.

Tags

A collection of key-value pairs.

VpcOutputSettings

Settings for the VPC outputs

Channel

integer

Minimum: 0

Maximum: 65536

The numeric value placed in the Network Information Table (NIT).

string

MinLength: 1

MaxLength: 256

The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.

integer

Minimum: 25

Maximum: 10000

The number of milliseconds between instances of this table in the output transport stream.

DvbSdtOutputSdt

Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information.

integer

Minimum: 25

Maximum: 2000

The number of milliseconds between instances of this table in the output transport stream.

string

MinLength: 1

MaxLength: 256

The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.

string

MinLength: 1

MaxLength: 256

The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.

DvbSubDestinationAlignment

If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

DvbSubDestinationBackgroundColor

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 0

Maximum: 255

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

InputLocation

External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

DvbSubDestinationFontColor

Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 0

Maximum: 255

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 96

Maximum: 600

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

string

When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.

DvbSubDestinationOutlineColor

Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 0

Maximum: 10

Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

DvbSubDestinationShadowColor

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 0

Maximum: 255

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

integer

Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.

integer

Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.

DvbSubDestinationTeletextGridControl

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

integer

Minimum: 0

Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

integer

Minimum: 0

Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

DvbSubOcrLanguage

If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text.

integer

Minimum: 1

When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.

integer

Minimum: 1000

Maximum: 30000

The number of milliseconds between instances of this table in the output transport stream.

Eac3AttenuationControl

When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.

number

Average bitrate in bits/second. Valid bitrates depend on the coding mode.

Eac3BitstreamMode

Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.

Eac3CodingMode

Dolby Digital Plus coding mode. Determines number of channels.

Eac3DcFilter

When set to enabled, activates a DC highpass filter for all input channels.

integer

Minimum: 1

Maximum: 31

Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.

Eac3DrcLine

Sets the Dolby dynamic range compression profile.

Eac3DrcRf

Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.

Eac3LfeControl

When encoding 3/2 audio, setting to lfe enables the LFE channel

Eac3LfeFilter

When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.

number

Left only/Right only center mix level. Only used for 3/2 coding mode.

number

Left only/Right only surround mix level. Only used for 3/2 coding mode.

number

Left total/Right total center mix level. Only used for 3/2 coding mode.

number

Left total/Right total surround mix level. Only used for 3/2 coding mode.

Eac3MetadataControl

When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.

Eac3PassthroughControl

When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.

Eac3PhaseControl

When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.

Eac3StereoDownmix

Stereo downmix preference. Only used for 3/2 coding mode.

Eac3SurroundExMode

When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.

Eac3SurroundMode

When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.

string

MaxLength: 1000

Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML

EbuTtDFillLineGapControl

Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled.

string

Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”.

EbuTtDDestinationStyleControl

Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information.

EmbeddedConvert608To708

If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.

EmbeddedScte20Detection

Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.

integer

Minimum: 1

Maximum: 4

Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.

integer

Minimum: 1

Maximum: 5

This field is unused and deprecated.

Array of type AudioDescription

AvailBlanking

Settings for ad avail blanking.

AvailConfiguration

Event-wide configuration settings for ad avail insertion.

BlackoutSlate

Settings for blackout slate.

Array of type CaptionDescription

Settings for caption decriptions

FeatureActivations

Feature Activations

GlobalConfiguration

Configuration settings that apply to the event as a whole.

MotionGraphicsConfiguration

Settings for motion graphics.

NielsenConfiguration

Nielsen configuration settings.

Array of type OutputGroup

TimecodeConfig

Contains settings used to acquire and adjust timecode information from inputs.

Array of type VideoDescription

FailoverConditionSettings

Failover condition type-specific settings.

AudioSilenceFailoverSettings

MediaLive will perform a failover if the specified audio selector is silent for the specified period.

InputLossFailoverSettings

MediaLive will perform a failover if content is not detected in this input for the specified period.

VideoBlackFailoverSettings

MediaLive will perform a failover if content is considered black for the specified period.

FeatureActivationsInputPrepareScheduleActions

Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled. If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule.

integer

Minimum: 4

Maximum: 20

Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.

FecOutputIncludeFec

Enables column only or column and row based FEC

integer

Minimum: 1

Maximum: 20

Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. 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, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.

string

List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.

Fmp4NielsenId3Behavior

If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

Fmp4TimedMetadataBehavior

When set to passthrough, timed metadata is passed through from input to output.

FrameCaptureS3Settings

OutputLocationRef

The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, "curling-") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curling-low.00001.jpg

FrameCaptureCdnSettings

Parameters that control interactions with the CDN.

string

Required if the output group contains more than one output. This modifier forms part of the output file name.

S3CannedAcl

Specify the canned ACL to apply to each S3 request. Defaults to none.

FrameCaptureS3LogUploads

When set to enabled, each upload to CDN or server will be logged.

integer

Minimum: 1

Maximum: 3600000

The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.

FrameCaptureIntervalUnit

Unit for the frame capture interval.

string

integer

Minimum: -60

Maximum: 60

Value to set the initial audio gain for the Live Event.

GlobalConfigurationInputEndAction

Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).

InputLossBehavior

Settings for system actions when input is lost.

GlobalConfigurationOutputLockingMode

Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.

GlobalConfigurationOutputTimingSource

Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.

GlobalConfigurationLowFramerateInputs

Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.

ColorSpacePassthroughSettings

Rec601Settings

Rec709Settings

TemporalFilterSettings

H264AdaptiveQuantization

Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization.

AfdSignaling

Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.

integer

Minimum: 1000

Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.

integer

Minimum: 0

Maximum: 100

Percentage of the buffer that should initially be filled (HRD buffer model).

integer

Minimum: 0

Size of buffer (HRD buffer model) in bits.

H264ColorMetadata

Includes colorspace metadata in the output.

H264ColorSpaceSettings

Color Space settings

H264EntropyEncoding

Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.

H264FilterSettings

Optional filters that you can apply to an encode.

FixedAfd

Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.

H264FlickerAq

Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ.

H264ForceFieldPictures

This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.

H264FramerateControl

This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.

integer

Minimum: 1

Framerate denominator.

integer

Minimum: 1

Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.

H264GopBReference

If enabled, use reference B frames for GOP structures that have B frames > 1.

integer

Minimum: 0

Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.

integer

Minimum: 0

Maximum: 7

Number of B-frames between reference frames.

number

GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.

H264GopSizeUnits

Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.

H264Level

H.264 Level.

H264LookAheadRateControl

Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.

integer

Minimum: 1000

For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.

integer

Minimum: 0

Maximum: 30

Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1

integer

Minimum: 1

Maximum: 6

Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.

H264ParControl

This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.

integer

Minimum: 1

Pixel Aspect Ratio denominator.

integer

Minimum: 1

Pixel Aspect Ratio numerator.

H264Profile

H.264 Profile.

H264QualityLevel

Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY. - STANDARD_QUALITY: Valid for any Rate control mode.

integer

Minimum: 1

Maximum: 10

Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide

H264RateControlMode

Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program.

H264ScanType

Sets the scan type of the output to progressive or top-field-first interlaced.

H264SceneChangeDetect

Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.

integer

Minimum: 1

Maximum: 32

Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.

integer

Minimum: 0

Maximum: 128

Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15.

H264SpatialAq

Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ.

H264SubGopLength

If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.

H264Syntax

Produces a bitstream compliant with SMPTE RP-2027.

H264TemporalAq

Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ.

H264TimecodeInsertionBehavior

Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config

ColorSpacePassthroughSettings

Hdr10Settings

Rec601Settings

Rec709Settings

TemporalFilterSettings

H265AdaptiveQuantization

Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.

AfdSignaling

Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.

H265AlternativeTransferFunction

Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.

integer

Minimum: 100000

Maximum: 40000000

Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.

integer

Minimum: 100000

Maximum: 80000000

Size of buffer (HRD buffer model) in bits.

H265ColorMetadata

Includes colorspace metadata in the output.

H265ColorSpaceSettings

Color Space settings

H265FilterSettings

Optional filters that you can apply to an encode.

FixedAfd

Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.

H265FlickerAq

If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.

integer

Minimum: 1

Maximum: 3003

Framerate denominator.

integer

Minimum: 1

Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.

integer

Minimum: 0

Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.

number

GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.

H265GopSizeUnits

Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.

H265Level

H.265 Level.

H265LookAheadRateControl

Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.

integer

Minimum: 100000

Maximum: 40000000

For QVBR: See the tooltip for Quality level

integer

Minimum: 0

Maximum: 30

Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1

integer

Minimum: 1

Pixel Aspect Ratio denominator.

integer

Minimum: 1

Pixel Aspect Ratio numerator.

H265Profile

H.265 Profile.

integer

Minimum: 1

Maximum: 10

Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M

H265RateControlMode

Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program.

H265ScanType

Sets the scan type of the output to progressive or top-field-first interlaced.

H265SceneChangeDetect

Scene change detection.

integer

Minimum: 1

Maximum: 16

Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.

H265Tier

H.265 Tier.

H265TimecodeInsertionBehavior

Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config