AWS Elemental MediaConvert API Reference
API Reference

Jobs id

URI

/2017-08-29/jobs/ id

HTTP Methods

GET

Operation ID: GetJob

Retrieve the JSON for a specific completed transcoding job.

Path Parameters

Name Type Required Description
id String True

Responses

Status Code Response Model Description
200 GetJobResponse

200 response

400 ExceptionBody

BadRequestException

500 ExceptionBody

InternalServiceException

403 ExceptionBody

AccessDeniedException

404 ExceptionBody

ResourceNotFoundException

429 ExceptionBody

LimitExceededException

409 ExceptionBody

ResourceInUseException

See Also

DELETE

Operation ID: CancelJob

Permanently remove a job from a queue. Once you have canceled a job, you can't start it again. You can't delete a running job.

Path Parameters

Name Type Required Description
id String True

Responses

Status Code Response Model Description
400 ExceptionBody

BadRequestException

202 CancelJobResponse

202 response

500 ExceptionBody

InternalServiceException

403 ExceptionBody

AccessDeniedException

404 ExceptionBody

ResourceNotFoundException

429 ExceptionBody

LimitExceededException

409 ExceptionBody

ResourceInUseException

See Also

Schemas

Request Bodies

Example GET

{ "id": "string" }

Example DELETE

{ "id": "string" }

Response Bodies

Example GetJobResponse

{ "job": { "settings": { "timecodeConfig": { "timestampOffset": "string", "anchor": "string", "start": "string", "source": enum }, "adAvailOffset": integer, "outputGroups": [ { "outputs": [ { "extension": "string", "videoDescription": { "fixedAfd": integer, "scalingBehavior": enum, "respondToAfd": enum, "codecSettings": { "h265Settings": { "slices": integer, "minIInterval": integer, "dynamicSubGop": enum, "parNumerator": integer, "flickerAdaptiveQuantization": enum, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "sampleAdaptiveOffsetFilterMode": enum, "temporalIds": enum, "slowPal": enum, "tiles": enum, "writeMp4PackagingType": enum, "codecProfile": enum, "alternateTransferFunctionSei": enum, "unregisteredSeiTimecode": enum, "framerateControl": enum, "telecine": enum, "codecLevel": enum, "framerateConversionAlgorithm": enum, "numberReferenceFrames": integer, "temporalAdaptiveQuantization": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "gopClosedCadence": integer, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "numberBFramesBetweenReferenceFrames": integer, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "gopBReference": enum, "parDenominator": integer, "sceneChangeDetect": enum, "parControl": enum, "rateControlMode": enum }, "codec": enum, "proresSettings": { "framerateDenominator": integer, "slowPal": enum, "framerateControl": enum, "telecine": enum, "framerateConversionAlgorithm": enum, "interlaceMode": enum, "parNumerator": integer, "codecProfile": enum, "parDenominator": integer, "parControl": enum, "framerateNumerator": integer }, "mpeg2Settings": { "minIInterval": integer, "dynamicSubGop": enum, "parNumerator": integer, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "slowPal": enum, "intraDcPrecision": enum, "codecProfile": enum, "softness": integer, "framerateControl": enum, "telecine": enum, "codecLevel": enum, "framerateConversionAlgorithm": enum, "temporalAdaptiveQuantization": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "gopClosedCadence": integer, "numberBFramesBetweenReferenceFrames": integer, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "syntax": enum, "parDenominator": integer, "sceneChangeDetect": enum, "parControl": enum, "rateControlMode": enum }, "frameCaptureSettings": { "framerateDenominator": integer, "maxCaptures": integer, "framerateNumerator": integer, "quality": integer }, "h264Settings": { "slices": integer, "minIInterval": integer, "dynamicSubGop": enum, "parNumerator": integer, "flickerAdaptiveQuantization": enum, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "slowPal": enum, "codecProfile": enum, "unregisteredSeiTimecode": enum, "softness": integer, "framerateControl": enum, "telecine": enum, "codecLevel": enum, "framerateConversionAlgorithm": enum, "numberReferenceFrames": integer, "temporalAdaptiveQuantization": enum, "repeatPps": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "gopClosedCadence": integer, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "numberBFramesBetweenReferenceFrames": integer, "framerateDenominator": integer, "entropyEncoding": enum, "fieldEncoding": enum, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "gopBReference": enum, "syntax": enum, "parDenominator": integer, "sceneChangeDetect": enum, "parControl": enum, "rateControlMode": enum } }, "afdSignaling": enum, "colorMetadata": enum, "timecodeInsertion": enum, "width": integer, "videoPreprocessors": { "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "postFilterSharpenStrength": integer, "speed": integer } }, "timecodeBurnin": { "prefix": "string", "fontSize": integer, "position": enum }, "colorCorrector": { "saturation": integer, "brightness": integer, "hdr10Metadata": { "redPrimaryY": integer, "greenPrimaryY": integer, "whitePointX": integer, "maxLuminance": integer, "greenPrimaryX": integer, "whitePointY": integer, "redPrimaryX": integer, "bluePrimaryX": integer, "bluePrimaryY": integer, "maxFrameAverageLightLevel": integer, "maxContentLightLevel": integer, "minLuminance": integer }, "contrast": integer, "hue": integer, "colorSpaceConversion": enum }, "deinterlacer": { "mode": enum, "control": enum, "algorithm": enum }, "imageInserter": { "insertableImages": [ { "duration": integer, "fadeOut": integer, "imageY": integer, "fadeIn": integer, "imageX": integer, "width": integer, "startTime": "string", "opacity": integer, "layer": integer, "height": integer, "imageInserterInput": "string" } ] } }, "antiAlias": enum, "position": { "width": integer, "x": integer, "y": integer, "height": integer }, "sharpness": integer, "crop": { "width": integer, "x": integer, "y": integer, "height": integer }, "dropFrameTimecode": enum, "height": integer }, "audioDescriptions": [ { "audioTypeControl": enum, "languageCodeControl": enum, "remixSettings": { "channelsOut": integer, "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer }, "audioType": integer, "audioSourceName": "string", "codecSettings": { "codec": enum, "wavSettings": { "channels": integer, "bitDepth": integer, "format": enum, "sampleRate": integer }, "aacSettings": { "vbrQuality": enum, "codecProfile": enum, "codingMode": enum, "specification": enum, "bitrate": integer, "rawFormat": enum, "rateControlMode": enum, "sampleRate": integer, "audioDescriptionBroadcasterMix": enum }, "ac3Settings": { "dynamicRangeCompressionProfile": enum, "dialnorm": integer, "codingMode": enum, "metadataControl": enum, "bitrate": integer, "lfeFilter": enum, "bitstreamMode": enum, "sampleRate": integer }, "aiffSettings": { "channels": integer, "bitDepth": integer, "sampleRate": integer }, "eac3Settings": { "dialnorm": integer, "passthroughControl": enum, "metadataControl": enum, "bitrate": integer, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "surroundExMode": enum, "ltRtSurroundMixLevel": number, "dynamicRangeCompressionLine": enum, "lfeControl": enum, "codingMode": enum, "surroundMode": enum, "attenuationControl": enum, "lfeFilter": enum, "phaseControl": enum, "ltRtCenterMixLevel": number, "dcFilter": enum, "bitstreamMode": enum, "stereoDownmix": enum, "loRoSurroundMixLevel": number, "loRoCenterMixLevel": number }, "mp2Settings": { "channels": integer, "bitrate": integer, "sampleRate": integer } }, "languageCode": enum, "streamName": "string", "audioNormalizationSettings": { "targetLkfs": number, "algorithmControl": enum, "loudnessLogging": enum, "peakCalculation": enum, "correctionGateLevel": integer, "algorithm": enum }, "customLanguageCode": "string" } ], "containerSettings": { "container": enum, "mp4Settings": { "mp4MajorBrand": "string", "moovPlacement": enum, "cslgAtom": enum, "freeSpaceBox": enum }, "m3u8Settings": { "pmtPid": integer, "nielsenId3": enum, "pcrPid": integer, "audioPids": [ integer ], "audioFramesPerPes": integer, "scte35Pid": integer, "transportStreamId": integer, "pcrControl": enum, "videoPid": integer, "privateMetadataPid": integer, "pmtInterval": integer, "patInterval": integer, "programNumber": integer, "timedMetadataPid": integer, "timedMetadata": enum, "scte35Source": enum }, "m2tsSettings": { "dvbTeletextPid": integer, "nielsenId3": enum, "bitrate": integer, "segmentationTime": number, "audioPids": [ integer ], "rateMode": enum, "maxPcrInterval": integer, "audioFramesPerPes": integer, "ebpAudioInterval": enum, "fragmentTime": number, "scte35Pid": integer, "pmtInterval": integer, "privateMetadataPid": integer, "segmentationStyle": enum, "audioBufferModel": enum, "programNumber": integer, "dvbNitSettings": { "networkName": "string", "networkId": integer, "nitInterval": integer }, "timedMetadataPid": integer, "scte35Source": enum, "pmtPid": integer, "bufferModel": enum, "ebpPlacement": enum, "dvbSdtSettings": { "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string", "outputSdt": enum }, "nullPacketBitrate": number, "pcrPid": integer, "minEbpInterval": integer, "transportStreamId": integer, "videoPid": integer, "pcrControl": enum, "esRateInPes": enum, "segmentationMarkers": enum, "dvbTdtSettings": { "tdtInterval": integer }, "patInterval": integer, "dvbSubPids": [ integer ] }, "movSettings": { "reference": enum, "paddingControl": enum, "mpeg2FourCCControl": enum, "cslgAtom": enum, "clapAtom": enum }, "f4vSettings": { "moovPlacement": enum } }, "preset": "string", "outputSettings": { "hlsSettings": { "iFrameOnlyManifest": enum, "audioRenditionSets": "string", "audioTrackType": enum, "segmentModifier": "string", "audioGroupId": "string" } }, "captionDescriptions": [ { "captionSelectorName": "string", "languageDescription": "string", "destinationSettings": { "burninDestinationSettings": { "xPosition": integer, "backgroundColor": enum, "teletextSpacing": enum, "yPosition": integer, "backgroundOpacity": integer, "fontOpacity": integer, "fontResolution": integer, "shadowOpacity": integer, "shadowYOffset": integer, "outlineSize": integer, "outlineColor": enum, "fontSize": integer, "shadowXOffset": integer, "alignment": enum, "shadowColor": enum, "fontColor": enum }, "teletextDestinationSettings": { "pageNumber": "string" }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "destinationType": enum, "dvbSubDestinationSettings": { "xPosition": integer, "backgroundColor": enum, "teletextSpacing": enum, "yPosition": integer, "backgroundOpacity": integer, "fontOpacity": integer, "fontResolution": integer, "shadowOpacity": integer, "shadowYOffset": integer, "outlineSize": integer, "outlineColor": enum, "fontSize": integer, "shadowXOffset": integer, "alignment": enum, "shadowColor": enum, "fontColor": enum }, "sccDestinationSettings": { "framerate": enum } }, "languageCode": enum, "customLanguageCode": "string" } ], "nameModifier": "string" } ], "outputGroupSettings": { "dashIsoGroupSettings": { "fragmentLength": integer, "baseUrl": "string", "minBufferTime": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" } }, "destination": "string", "writeSegmentTimelineInRepresentation": enum, "segmentLength": integer, "segmentControl": enum, "hbbtvCompliance": enum }, "fileGroupSettings": { "destination": "string" }, "msSmoothGroupSettings": { "fragmentLength": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" } }, "audioDeduplication": enum, "manifestEncoding": enum, "destination": "string" }, "cmafGroupSettings": { "writeHlsManifest": enum, "writeDashManifest": enum, "fragmentLength": integer, "streamInfResolution": enum, "minBufferTime": integer, "clientCache": enum, "codecSpecification": enum, "destination": "string", "segmentControl": enum, "baseUrl": "string", "encryption": { "initializationVectorInManifest": enum, "constantInitializationVector": "string", "staticKeyProvider": { "keyFormatVersions": "string", "keyFormat": "string", "staticKeyValue": "string", "url": "string" }, "type": enum, "encryptionMethod": enum }, "manifestCompression": enum, "segmentLength": integer, "minFinalSegmentLength": number, "manifestDurationFormat": enum }, "type": enum, "hlsGroupSettings": { "segmentsPerSubdirectory": integer, "streamInfResolution": enum, "timestampDeltaMilliseconds": integer, "outputSelection": enum, "captionLanguageMappings": [ { "languageDescription": "string", "captionChannel": integer, "languageCode": enum, "customLanguageCode": "string" } ], "clientCache": enum, "codecSpecification": enum, "destination": "string", "timedMetadataId3Frame": enum, "segmentControl": enum, "timedMetadataId3Period": integer, "captionLanguageSetting": enum, "minSegmentLength": integer, "directoryStructure": enum, "programDateTime": enum, "baseUrl": "string", "encryption": { "initializationVectorInManifest": enum, "constantInitializationVector": "string", "staticKeyProvider": { "keyFormatVersions": "string", "keyFormat": "string", "staticKeyValue": "string", "url": "string" }, "type": enum, "encryptionMethod": enum, "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" } }, "adMarkers": [ enum ], "programDateTimePeriod": integer, "manifestCompression": enum, "segmentLength": integer, "manifestDurationFormat": enum, "minFinalSegmentLength": number } }, "name": "string", "customName": "string" } ], "nielsenConfiguration": { "distributorId": "string", "breakoutCode": integer }, "inputs": [ { "audioSelectors": { }, "audioSelectorGroups": { }, "videoSelector": { "colorSpace": enum, "hdr10Metadata": { "redPrimaryY": integer, "greenPrimaryY": integer, "whitePointX": integer, "maxLuminance": integer, "greenPrimaryX": integer, "whitePointY": integer, "redPrimaryX": integer, "bluePrimaryX": integer, "bluePrimaryY": integer, "maxFrameAverageLightLevel": integer, "maxContentLightLevel": integer, "minLuminance": integer }, "programNumber": integer, "pid": integer, "colorSpaceUsage": enum }, "denoiseFilter": enum, "filterEnable": enum, "deblockFilter": enum, "filterStrength": integer, "programNumber": integer, "timecodeSource": enum, "captionSelectors": { }, "fileInput": "string", "inputClippings": [ { "startTimecode": "string", "endTimecode": "string" } ], "psiControl": enum } ], "timedMetadataInsertion": { "id3Insertions": [ { "id3": "string", "timecode": "string" } ] }, "availBlanking": { "availBlankingImage": "string" } }, "role": "string", "outputGroupDetails": [ { "outputDetails": [ { "durationInMs": integer, "videoDetails": { "heightInPx": integer, "widthInPx": integer } } ] } ], "jobTemplate": "string", "timing": { "finishTime": "string", "submitTime": "string", "startTime": "string" }, "errorMessage": "string", "errorCode": integer, "createdAt": "string", "billingTagsSource": enum, "id": "string", "arn": "string", "userMetadata": { }, "queue": "string", "status": enum } }

Example CancelJobResponse

{ }

Example ExceptionBody

{ "message": "string" }

Properties

AacAudioDescriptionBroadcasterMix (enum)

Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for 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. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType.

  • BROADCASTER_MIXED_AD

  • NORMAL

AacCodecProfile (enum)

AAC Profile.

  • LC

  • HEV1

  • HEV2

AacCodingMode (enum)

Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. "1.0 - Audio Description (Receiver Mix)" 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.

  • AD_RECEIVER_MIX

  • CODING_MODE_1_0

  • CODING_MODE_1_1

  • CODING_MODE_2_0

  • CODING_MODE_5_1

AacRateControlMode (enum)

Rate Control Mode.

  • CBR

  • VBR

AacRawFormat (enum)

Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose "No container" for the output container.

  • LATM_LOAS

  • NONE

AacSettings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode (rateControlMode) to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the rate control mode.

Property Type Required Description
vbrQuality

string

False
codecProfile

string

False
codingMode

string

False
specification

string

False
bitrate

integer

Minimum: 6000

Maximum: 1024000

False

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

rawFormat

string

False
rateControlMode

string

False
sampleRate

integer

Minimum: 8000

Maximum: 96000

False

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

audioDescriptionBroadcasterMix

string

False

See Also

AacSpecification (enum)

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

  • MPEG2

  • MPEG4

AacVbrQuality (enum)

VBR Quality Level - Only used if rate_control_mode is VBR.

  • LOW

  • MEDIUM_LOW

  • MEDIUM_HIGH

  • HIGH

Ac3BitstreamMode (enum)

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

  • COMPLETE_MAIN

  • COMMENTARY

  • DIALOGUE

  • EMERGENCY

  • HEARING_IMPAIRED

  • MUSIC_AND_EFFECTS

  • VISUALLY_IMPAIRED

  • VOICE_OVER

Ac3CodingMode (enum)

Dolby Digital coding mode. Determines number of channels.

  • CODING_MODE_1_0

  • CODING_MODE_1_1

  • CODING_MODE_2_0

  • CODING_MODE_3_2_LFE

Ac3DynamicRangeCompressionProfile (enum)

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

  • FILM_STANDARD

  • NONE

Ac3LfeFilter (enum)

Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.

  • ENABLED

  • DISABLED

Ac3MetadataControl (enum)

When set to FOLLOW_INPUT, 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.

  • FOLLOW_INPUT

  • USE_CONFIGURED

Ac3Settings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3.

Property Type Required Description
dynamicRangeCompressionProfile

string

False
dialnorm

integer

Minimum: 1

Maximum: 31

False

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

codingMode

string

False
metadataControl

string

False
bitrate

integer

Minimum: 64000

Maximum: 640000

False

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

lfeFilter

string

False
bitstreamMode

string

False
sampleRate

integer

Minimum: 48000

Maximum: 48000

False

Sample rate in hz. Sample rate is always 48000.

See Also

AfdSignaling (enum)

This setting only applies to H.264 and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

  • NONE

  • AUTO

  • FIXED

AiffSettings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF.

Property Type Required Description
channels

integer

Minimum: 1

Maximum: 2

False

Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2.

bitDepth

integer

Minimum: 16

Maximum: 24

False

Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.

sampleRate

integer

Minimum: 8000

Maximum: 192000

False

Sample rate in hz.

See Also

AncillarySourceSettings

Settings for ancillary captions source.

Property Type Required Description
sourceAncillaryChannelNumber

integer

Minimum: 1

Maximum: 4

False

Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough.

See Also

AntiAlias (enum)

Enable Anti-alias (AntiAlias) to enhance sharp edges in video output when your input resolution is much larger than your output resolution. Default is enabled.

  • DISABLED

  • ENABLED

AudioCodec (enum)

Type of Audio codec.

  • AAC

  • MP2

  • WAV

  • AIFF

  • AC3

  • EAC3

  • PASSTHROUGH

AudioCodecSettings

Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value you choose for Audio codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings

Property Type Required Description
codec

string

False
wavSettings

WavSettings

False
aacSettings

AacSettings

False
ac3Settings

Ac3Settings

False
aiffSettings

AiffSettings

False
eac3Settings

Eac3Settings

False
mp2Settings

Mp2Settings

False

See Also

AudioDefaultSelection (enum)

Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.

  • DEFAULT

  • NOT_DEFAULT

AudioDescription

Description of audio output

Property Type Required Description
audioTypeControl

string

False
languageCodeControl

string

False
remixSettings

RemixSettings

False

Advanced audio remixing settings.

audioType

integer

Minimum: 0

Maximum: 255

False

Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved.

audioSourceName

string

False

Specifies which audio data to use from each input. In the simplest case, specify an "Audio Selector":#inputs-audio_selector by name based on its order within each input. For example if you specify "Audio Selector 3", then the third audio selector will be used from each input. If an input does not have an "Audio Selector 3", then the audio selector marked as "default" in that input will be used. If there is no audio selector marked as "default", silence will be inserted for the duration of that input. Alternatively, an "Audio Selector Group":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then "Audio Selector 1" will be chosen automatically.

codecSettings

AudioCodecSettings

False
languageCode

string

False

Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.

streamName

string

Pattern: ^[\w\s]*$

False

Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). Alphanumeric characters, spaces, and underscore are legal.

audioNormalizationSettings

AudioNormalizationSettings

False
customLanguageCode

string

Pattern: ^[A-Za-z]{3}$

False

Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code. The language specified will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.

See Also

AudioLanguageCodeControl (enum)

Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The language specified for languageCode' will be used when USE_CONFIGURED is selected or when FOLLOW_INPUT is selected but there is no ISO 639 language code specified by the input.

  • FOLLOW_INPUT

  • USE_CONFIGURED

AudioNormalizationAlgorithm (enum)

Audio normalization algorithm to use. 1770-1 conforms to the CALM Act specification, 1770-2 conforms to the EBU R-128 specification.

  • ITU_BS_1770_1

  • ITU_BS_1770_2

AudioNormalizationAlgorithmControl (enum)

When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

  • CORRECT_AUDIO

  • MEASURE_ONLY

AudioNormalizationLoudnessLogging (enum)

If set to LOG, log each output's audio track loudness to a CSV file.

  • LOG

  • DONT_LOG

AudioNormalizationPeakCalculation (enum)

If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.

  • TRUE_PEAK

  • NONE

AudioNormalizationSettings

Advanced audio normalization settings.

Property Type Required Description
targetLkfs

number

Format: float

Minimum: -59.0

Maximum: 0.0

False

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.

algorithmControl

string

False
loudnessLogging

string

False
peakCalculation

string

False
correctionGateLevel

integer

Minimum: -70

Maximum: 0

False

Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected. Gating only applies when not using real_time_correction.

algorithm

string

False

See Also

AudioSelectorType (enum)

Specifies the type of the audio selector.

  • PID

  • TRACK

  • LANGUAGE_CODE

AudioTypeControl (enum)

When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.

  • FOLLOW_INPUT

  • USE_CONFIGURED

AvailBlanking

Settings for Avail Blanking

Property Type Required Description
availBlankingImage

string

Pattern: ^(s3:\/\/)(.*?)\.(bmp|BMP|png|PNG)$

False

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

See Also

BillingTagsSource (enum)

Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.

  • QUEUE

  • PRESET

  • JOB_TEMPLATE

BurninDestinationSettings

Burn-In Destination Settings.

Property Type Required Description
xPosition

integer

Minimum: 0

Maximum: 2147483647

False

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 x_position 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.

backgroundColor

string

False
teletextSpacing

string

False
yPosition

integer

Minimum: 0

Maximum: 2147483647

False

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 y_position 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.

backgroundOpacity

integer

Minimum: 0

Maximum: 255

False

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.

fontOpacity

integer

Minimum: 0

Maximum: 255

False

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

fontResolution

integer

Minimum: 96

Maximum: 600

False

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

shadowOpacity

integer

Minimum: 0

Maximum: 255

False

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.

shadowYOffset

integer

Minimum: -2147483648

Maximum: 2147483647

False

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.

outlineSize

integer

Minimum: 0

Maximum: 10

False

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.

outlineColor

string

False
fontSize

integer

Minimum: 0

Maximum: 96

False

A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.

shadowXOffset

integer

Minimum: -2147483648

Maximum: 2147483647

False

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.

alignment

string

False
shadowColor

string

False
fontColor

string

False

See Also

BurninSubtitleAlignment (enum)

If no explicit x_position or y_position 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. 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.

  • CENTERED

  • LEFT

BurninSubtitleBackgroundColor (enum)

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

  • NONE

  • BLACK

  • WHITE

BurninSubtitleFontColor (enum)

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.

  • WHITE

  • BLACK

  • YELLOW

  • RED

  • GREEN

  • BLUE

BurninSubtitleOutlineColor (enum)

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.

  • BLACK

  • WHITE

  • YELLOW

  • RED

  • GREEN

  • BLUE

BurninSubtitleShadowColor (enum)

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

  • NONE

  • BLACK

  • WHITE

BurninSubtitleTeletextSpacing (enum)

Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.

  • FIXED_GRID

  • PROPORTIONAL

CancelJobRequest

Cancel a job by sending a request with the job ID

Property Type Required Description
id

string

False

The Job ID of the job to be cancelled.

See Also

CancelJobResponse

A cancel job request will receive a response with an empty body.

Property Type Required Description

See Also

CaptionDescription

Description of Caption output

Property Type Required Description
captionSelectorName

string

False

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input.

languageDescription

string

Pattern: ^[\w ]*$

False

Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal.

destinationSettings

CaptionDestinationSettings

False
languageCode

string

False

Indicates the language of the caption output track.

customLanguageCode

string

Pattern: ^[A-Za-z]{3}$

False

Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code

See Also

CaptionDestinationSettings

Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.

Property Type Required Description
burninDestinationSettings

BurninDestinationSettings

False
teletextDestinationSettings

TeletextDestinationSettings

False
ttmlDestinationSettings

TtmlDestinationSettings

False
destinationType

string

False
dvbSubDestinationSettings

DvbSubDestinationSettings

False
sccDestinationSettings

SccDestinationSettings

False

See Also

CaptionDestinationType (enum)

Type of Caption output, including Burn-In, Embedded, SCC, SRT, TTML, WebVTT, DVB-Sub, Teletext.

  • BURN_IN

  • DVB_SUB

  • EMBEDDED

  • SCC

  • SRT

  • TELETEXT

  • TTML

  • WEBVTT

CaptionSourceSettings

Source settings (SourceSettings) contains the group of settings for captions in the input.

Property Type Required Description
fileSourceSettings

FileSourceSettings

False
ancillarySourceSettings

AncillarySourceSettings

False
embeddedSourceSettings

EmbeddedSourceSettings

False
sourceType

string

False
dvbSubSourceSettings

DvbSubSourceSettings

False
teletextSourceSettings

TeletextSourceSettings

False

See Also

CaptionSourceType (enum)

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

  • ANCILLARY

  • DVB_SUB

  • EMBEDDED

  • SCC

  • TTML

  • STL

  • SRT

  • TELETEXT

  • NULL_SOURCE

ChannelMapping

Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification).

Property Type Required Description
outputChannels

Array of type OutputChannelMapping

False

List of output channels

See Also

CmafClientCache (enum)

When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.

  • DISABLED

  • ENABLED

CmafCodecSpecification (enum)

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

  • RFC_6381

  • RFC_4281

CmafEncryptionSettings

Settings for CMAF encryption

Property Type Required Description
initializationVectorInManifest

string

False
constantInitializationVector

string

Pattern: ^[0-9a-fA-F]{32}$

False

This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default.

staticKeyProvider

StaticKeyProvider

False
type

string

False
encryptionMethod

string

False

See Also

CmafEncryptionType (enum)

Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.

  • SAMPLE_AES

CmafGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output.

Property Type Required Description
writeHlsManifest

string

False
writeDashManifest

string

False
fragmentLength

integer

Minimum: 1

Maximum: 2147483647

False

Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.

streamInfResolution

string

False
minBufferTime

integer

Minimum: 0

Maximum: 2147483647

False

Minimum time of initially buffered media that is needed to ensure smooth playout.

clientCache

string

False
codecSpecification

string

False
destination

string

Pattern: ^s3:\/\/

False

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

segmentControl

string

False
baseUrl

string

False

A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.

encryption

CmafEncryptionSettings

False

DRM settings.

manifestCompression

string

False
segmentLength

integer

Minimum: 1

Maximum: 2147483647

False

Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment.

minFinalSegmentLength

number

Format: float

Minimum: 0.0

Maximum: 2147483647

False

Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.

manifestDurationFormat

string

False

See Also

CmafInitializationVectorInManifest (enum)

The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.

  • INCLUDE

  • EXCLUDE

CmafKeyProviderType (enum)

Indicates which type of key provider is used for encryption.

  • STATIC_KEY

CmafManifestCompression (enum)

When set to GZIP, compresses HLS playlist.

  • GZIP

  • NONE

CmafManifestDurationFormat (enum)

Indicates whether the output manifest should use floating point values for segment duration.

  • FLOATING_POINT

  • INTEGER

CmafSegmentControl (enum)

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

  • SINGLE_FILE

  • SEGMENTED_FILES

CmafStreamInfResolution (enum)

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

  • INCLUDE

  • EXCLUDE

CmafWriteDASHManifest (enum)

When set to ENABLED, a DASH MPD manifest will be generated for this output.

  • DISABLED

  • ENABLED

CmafWriteHLSManifest (enum)

When set to ENABLED, an Apple HLS manifest will be generated for this output.

  • DISABLED

  • ENABLED

ColorCorrector

Settings for color correction.

Property Type Required Description
saturation

integer

Minimum: 1

Maximum: 100

False

Saturation level.

brightness

integer

Minimum: 1

Maximum: 100

False

Brightness level.

hdr10Metadata

Hdr10Metadata

False
contrast

integer

Minimum: 1

Maximum: 100

False

Contrast level.

hue

integer

Minimum: -180

Maximum: 180

False

Hue in degrees.

colorSpaceConversion

string

False

See Also

ColorMetadata (enum)

Enable Insert color metadata (ColorMetadata) to include color metadata in this output. This setting is enabled by default.

  • IGNORE

  • INSERT

ColorSpace (enum)

If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value FOLLOW. The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, or if your input video is missing color space metadata that should be there, specify the accurate color space here. If you choose HDR10, you can also correct inaccurate color space coefficients, using the HDR master display information controls. You must also set Color space usage (ColorSpaceUsage) to FORCE for the service to use these values.

  • FOLLOW

  • REC_601

  • REC_709

  • HDR10

  • HLG_2020

ColorSpaceConversion (enum)

Determines if colorspace conversion will be performed. If set to _None_, no conversion will be performed. If _Force 601_ or _Force 709_ are selected, conversion will be performed for inputs with differing colorspaces. An input's colorspace can be specified explicitly in the "Video Selector":#inputs-video_selector if necessary.

  • NONE

  • FORCE_601

  • FORCE_709

  • FORCE_HDR10

  • FORCE_HLG_2020

ColorSpaceUsage (enum)

There are two sources for color metadata, the input file and the job configuration (in the Color space and HDR master display informaiton settings). The Color space usage setting controls which takes precedence. FORCE: The system will use color metadata supplied by user, if any. If the user does not supply color metadata, the system will use data from the source. FALLBACK: The system will use color metadata from the source. If source has no color metadata, the system will use user-supplied color metadata values if available.

  • FORCE

  • FALLBACK

ContainerSettings

Container specific settings.

Property Type Required Description
container

string

False
mp4Settings

Mp4Settings

False
m3u8Settings

M3u8Settings

False
m2tsSettings

M2tsSettings

False
movSettings

MovSettings

False
f4vSettings

F4vSettings

False

See Also

ContainerType (enum)

Container for this output. Some containers require a container settings object. If not specified, the default object will be created.

  • F4V

  • ISMV

  • M2TS

  • M3U8

  • CMFC

  • MOV

  • MP4

  • MPD

  • MXF

  • RAW

DashIsoEncryptionSettings

Specifies DRM settings for DASH outputs.

Property Type Required Description
spekeKeyProvider

SpekeKeyProvider

False

See Also

DashIsoGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS.

Property Type Required Description
fragmentLength

integer

Minimum: 1

Maximum: 2147483647

False

Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.

baseUrl

string

False

A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.

minBufferTime

integer

Minimum: 0

Maximum: 2147483647

False

Minimum time of initially buffered media that is needed to ensure smooth playout.

encryption

DashIsoEncryptionSettings

False

DRM settings.

destination

string

Pattern: ^s3:\/\/

False

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

writeSegmentTimelineInRepresentation

string

False

When ENABLED, segment durations are indicated in the manifest using SegmentTimeline and SegmentTimeline will be promoted down into Representation from AdaptationSet.

segmentLength

integer

Minimum: 1

Maximum: 2147483647

False

Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.

segmentControl

string

False
hbbtvCompliance

string

False

See Also

DashIsoHbbtvCompliance (enum)

Supports HbbTV specification as indicated

  • HBBTV_1_5

  • NONE

DashIsoSegmentControl (enum)

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

  • SINGLE_FILE

  • SEGMENTED_FILES

DashIsoWriteSegmentTimelineInRepresentation (enum)

When ENABLED, segment durations are indicated in the manifest using SegmentTimeline and SegmentTimeline will be promoted down into Representation from AdaptationSet.

  • ENABLED

  • DISABLED

DeinterlaceAlgorithm (enum)

Only applies when you set Deinterlacer (DeinterlaceMode) to Deinterlace (DEINTERLACE) or Adaptive (ADAPTIVE). Motion adaptive interpolate (INTERPOLATE) produces sharper pictures, while blend (BLEND) produces smoother motion. Use (INTERPOLATE_TICKER) OR (BLEND_TICKER) if your source file includes a ticker, such as a scrolling headline at the bottom of the frame.

  • INTERPOLATE

  • INTERPOLATE_TICKER

  • BLEND

  • BLEND_TICKER

Deinterlacer

Settings for deinterlacer

Property Type Required Description
mode

string

False
control

string

False
algorithm

string

False

See Also

DeinterlacerControl (enum)

- When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video.

  • FORCE_ALL_FRAMES

  • NORMAL

DeinterlacerMode (enum)

Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive.

  • DEINTERLACE

  • INVERSE_TELECINE

  • ADAPTIVE

DropFrameTimecode (enum)

Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.

  • DISABLED

  • ENABLED

DvbNitSettings

Inserts DVB Network Information Table (NIT) at the specified table repetition interval.

Property Type Required Description
networkName

string

False

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

networkId

integer

Minimum: 0

Maximum: 65535

False

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

nitInterval

integer

Minimum: 25

Maximum: 10000

False

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

See Also

DvbSdtSettings

Inserts DVB Service Description Table (NIT) at the specified table repetition interval.

Property Type Required Description
sdtInterval

integer

Minimum: 25

Maximum: 2000

False

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

serviceName

string

False

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

serviceProviderName

string

False

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

outputSdt

string

False

See Also

DvbSubDestinationSettings

DVB-Sub Destination Settings

Property Type Required Description
xPosition

integer

Minimum: 0

Maximum: 2147483647

False

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 x_position 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.

backgroundColor

string

False
teletextSpacing

string

False
yPosition

integer

Minimum: 0

Maximum: 2147483647

False

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 y_position 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.

backgroundOpacity

integer

Minimum: 0

Maximum: 255

False

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.

fontOpacity

integer

Minimum: 0

Maximum: 255

False

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

fontResolution

integer

Minimum: 96

Maximum: 600

False

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

shadowOpacity

integer

Minimum: 0

Maximum: 255

False

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.

shadowYOffset

integer

Minimum: -2147483648

Maximum: 2147483647

False

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.

outlineSize

integer

Minimum: 0

Maximum: 10

False

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.

outlineColor

string

False
fontSize

integer

Minimum: 0

Maximum: 96

False

A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.

shadowXOffset

integer

Minimum: -2147483648

Maximum: 2147483647

False

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.

alignment

string

False
shadowColor

string

False
fontColor

string

False

See Also

DvbSubSourceSettings

DVB Sub Source Settings

Property Type Required Description
pid

integer

Minimum: 1

Maximum: 2147483647

False

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.

See Also

DvbSubtitleAlignment (enum)

If no explicit x_position or y_position 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. 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.

  • CENTERED

  • LEFT

DvbSubtitleBackgroundColor (enum)

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

  • NONE

  • BLACK

  • WHITE

DvbSubtitleFontColor (enum)

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.

  • WHITE

  • BLACK

  • YELLOW

  • RED

  • GREEN

  • BLUE

DvbSubtitleOutlineColor (enum)

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.

  • BLACK

  • WHITE

  • YELLOW

  • RED

  • GREEN

  • BLUE

DvbSubtitleShadowColor (enum)

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

  • NONE

  • BLACK

  • WHITE

DvbSubtitleTeletextSpacing (enum)

Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.

  • FIXED_GRID

  • PROPORTIONAL

DvbTdtSettings

Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.

Property Type Required Description
tdtInterval

integer

Minimum: 1000

Maximum: 30000

False

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

See Also

Eac3AttenuationControl (enum)

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

  • ATTENUATE_3_DB

  • NONE

Eac3BitstreamMode (enum)

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

  • COMPLETE_MAIN

  • COMMENTARY

  • EMERGENCY

  • HEARING_IMPAIRED

  • VISUALLY_IMPAIRED

Eac3CodingMode (enum)

Dolby Digital Plus coding mode. Determines number of channels.

  • CODING_MODE_1_0

  • CODING_MODE_2_0

  • CODING_MODE_3_2

Eac3DcFilter (enum)

Activates a DC highpass filter for all input channels.

  • ENABLED

  • DISABLED

Eac3DynamicRangeCompressionLine (enum)

Enables Dynamic Range Compression that restricts the absolute peak level for a signal.

  • NONE

  • FILM_STANDARD

  • FILM_LIGHT

  • MUSIC_STANDARD

  • MUSIC_LIGHT

  • SPEECH

Eac3DynamicRangeCompressionRf (enum)

Enables Heavy Dynamic Range Compression, ensures that the instantaneous signal peaks do not exceed specified levels.

  • NONE

  • FILM_STANDARD

  • FILM_LIGHT

  • MUSIC_STANDARD

  • MUSIC_LIGHT

  • SPEECH

Eac3LfeControl (enum)

When encoding 3/2 audio, controls whether the LFE channel is enabled

  • LFE

  • NO_LFE

Eac3LfeFilter (enum)

Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.

  • ENABLED

  • DISABLED

Eac3MetadataControl (enum)

When set to FOLLOW_INPUT, 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.

  • FOLLOW_INPUT

  • USE_CONFIGURED

Eac3PassthroughControl (enum)

When set to WHEN_POSSIBLE, 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.

  • WHEN_POSSIBLE

  • NO_PASSTHROUGH

Eac3PhaseControl (enum)

Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode.

  • SHIFT_90_DEGREES

  • NO_SHIFT

Eac3Settings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.

Property Type Required Description
dialnorm

integer

Minimum: 1

Maximum: 31

False

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

passthroughControl

string

False
metadataControl

string

False
bitrate

integer

Minimum: 64000

Maximum: 640000

False

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

dynamicRangeCompressionRf

string

False
sampleRate

integer

Minimum: 48000

Maximum: 48000

False

Sample rate in hz. Sample rate is always 48000.

surroundExMode

string

False
ltRtSurroundMixLevel

number

Format: float

Minimum: -60.0

Maximum: -1.5

False

Left total/Right total surround mix level. Only used for 3/2 coding mode. Valid values: -1.5 -3.0 -4.5 -6.0 -60

dynamicRangeCompressionLine

string

False
lfeControl

string

False
codingMode

string

False
surroundMode

string

False
attenuationControl

string

False
lfeFilter

string

False
phaseControl

string

False
ltRtCenterMixLevel

number

Format: float

Minimum: -60.0

Maximum: 3.0

False

Left total/Right total center mix level. Only used for 3/2 coding mode. Valid values: 3.0, 1.5, 0.0, -1.5 -3.0 -4.5 -6.0 -60

dcFilter

string

False
bitstreamMode

string

False
stereoDownmix

string

False
loRoSurroundMixLevel

number

Format: float

Minimum: -60.0

Maximum: -1.5

False

Left only/Right only surround mix level. Only used for 3/2 coding mode. Valid values: -1.5 -3.0 -4.5 -6.0 -60

loRoCenterMixLevel

number

Format: float

Minimum: -60.0

Maximum: 3.0

False

Left only/Right only center mix level. Only used for 3/2 coding mode. Valid values: 3.0, 1.5, 0.0, -1.5 -3.0 -4.5 -6.0 -60

See Also

Eac3StereoDownmix (enum)

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

  • NOT_INDICATED

  • LO_RO

  • LT_RT

  • DPL2

Eac3SurroundExMode (enum)

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

  • NOT_INDICATED

  • ENABLED

  • DISABLED

Eac3SurroundMode (enum)

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

  • NOT_INDICATED

  • ENABLED

  • DISABLED

EmbeddedConvert608To708 (enum)

When set to 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.

  • UPCONVERT

  • DISABLED

EmbeddedSourceSettings

Settings for embedded captions Source

Property Type Required Description
source608ChannelNumber

integer

Minimum: 1

Maximum: 4

False

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

convert608To708

string

False
source608TrackNumber

integer

Minimum: 1

Maximum: 1

False

Specifies the video track index used for extracting captions. The system only supports one input video track, so this should always be set to '1'.

See Also

ExceptionBody

Property Type Required Description
message

string

False

See Also

F4vMoovPlacement (enum)

If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end.

  • PROGRESSIVE_DOWNLOAD

  • NORMAL

F4vSettings

Settings for F4v container

Property Type Required Description
moovPlacement

string

False

See Also

FileGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILE_GROUP_SETTINGS.

Property Type Required Description
destination

string

Pattern: ^s3:\/\/

False

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

See Also

FileSourceConvert608To708 (enum)

If set to UPCONVERT, 608 caption 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.

  • UPCONVERT

  • DISABLED

FileSourceSettings

Settings for File-based Captions in Source

Property Type Required Description
timeDelta

integer

Minimum: -2147483648

Maximum: 2147483647

False

Specifies a time delta in seconds to offset the captions from the source file.

convert608To708

string

False
sourceFile

string

Pattern: ^(s3:\/\/)(.*?)\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|smi|SMI)$

False

External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', and 'smi'.

See Also

FrameCaptureSettings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.

Property Type Required Description
framerateDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.

maxCaptures

integer

Minimum: 1

Maximum: 10000000

False

Maximum number of captures (encoded jpg output files).

framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.

quality

integer

Minimum: 1

Maximum: 100

False

JPEG Quality - a higher value equals higher quality.

See Also

GetJobRequest

Query a job by sending a request with the job ID.

Property Type Required Description
id

string

False

the job ID of the job.

See Also

GetJobResponse

Successful get job requests will return an OK message and the job JSON.

Property Type Required Description
job

Job

False

See Also

H264AdaptiveQuantization (enum)

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

  • HIGHER

  • MAX

H264CodecLevel (enum)

H.264 Level.

  • AUTO

  • LEVEL_1

  • LEVEL_1_1

  • LEVEL_1_2

  • LEVEL_1_3

  • LEVEL_2

  • LEVEL_2_1

  • LEVEL_2_2

  • LEVEL_3

  • LEVEL_3_1

  • LEVEL_3_2

  • LEVEL_4

  • LEVEL_4_1

  • LEVEL_4_2

  • LEVEL_5

  • LEVEL_5_1

  • LEVEL_5_2

H264CodecProfile (enum)

H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.

  • BASELINE

  • HIGH

  • HIGH_10BIT

  • HIGH_422

  • HIGH_422_10BIT

  • MAIN

H264DynamicSubGop (enum)

Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).

  • ADAPTIVE

  • STATIC

H264EntropyEncoding (enum)

Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC.

  • CABAC

  • CAVLC

H264FieldEncoding (enum)

Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.

  • PAFF

  • FORCE_FIELD

H264FlickerAdaptiveQuantization (enum)

Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.

  • DISABLED

  • ENABLED

H264FramerateControl (enum)

If you are using the console, use the Framerate setting to specify the framerate for this output. If you want to keep the same framerate as the input video, choose Follow source. If you want to do framerate conversion, choose a framerate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your framerate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the framerate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Choose SPECIFIED if you want the service to use the framerate you specify in the settings FramerateNumerator and FramerateDenominator.

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264FramerateConversionAlgorithm (enum)

When set to INTERPOLATE, produces smoother motion during framerate conversion.

  • DUPLICATE_DROP

  • INTERPOLATE

H264GopBReference (enum)

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

  • DISABLED

  • ENABLED

H264GopSizeUnits (enum)

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

  • FRAMES

  • SECONDS

H264InterlaceMode (enum)

Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type, as follows. - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of "top field first" and "bottom field first". - If the source is progressive, the output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the Follow options you chose.

  • PROGRESSIVE

  • TOP_FIELD

  • BOTTOM_FIELD

  • FOLLOW_TOP_FIELD

  • FOLLOW_BOTTOM_FIELD

H264ParControl (enum)

Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio.

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264QualityTuningLevel (enum)

Use Quality tuning level (H264QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding.

  • SINGLE_PASS

  • SINGLE_PASS_HQ

  • MULTI_PASS_HQ

H264QvbrSettings

Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.

Property Type Required Description
qvbrQualityLevel

integer

Minimum: 1

Maximum: 10

False

Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h264Settings. Specify the target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9.

maxAverageBitrate

integer

Minimum: 1000

Maximum: 1152000000

False

Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output.

See Also

H264RateControlMode (enum)

Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).

  • VBR

  • CBR

  • QVBR

H264RepeatPps (enum)

Places a PPS header on each encoded picture, even if repeated.

  • DISABLED

  • ENABLED

H264SceneChangeDetect (enum)

Scene change detection (inserts I-frames on scene changes).

  • DISABLED

  • ENABLED

H264Settings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.

Property Type Required Description
slices

integer

Minimum: 1

Maximum: 32

False

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.

minIInterval

integer

Minimum: 0

Maximum: 30

False

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. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1

dynamicSubGop

string

False

Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).

parNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio numerator.

flickerAdaptiveQuantization

string

False
gopSizeUnits

string

False
hrdBufferSize

integer

Minimum: 0

Maximum: 1152000000

False

Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.

qualityTuningLevel

string

False
maxBitrate

integer

Minimum: 1000

Maximum: 1152000000

False

Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.

bitrate

integer

Minimum: 1000

Maximum: 1152000000

False

Average bitrate in bits/second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.

spatialAdaptiveQuantization

string

False
slowPal

string

False
codecProfile

string

False
unregisteredSeiTimecode

string

False
softness

integer

Minimum: 0

Maximum: 128

False

Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.

framerateControl

string

False
telecine

string

False
codecLevel

string

False
framerateConversionAlgorithm

string

False
numberReferenceFrames

integer

Minimum: 1

Maximum: 6

False

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

temporalAdaptiveQuantization

string

False
repeatPps

string

False
hrdBufferInitialFillPercentage

integer

Minimum: 0

Maximum: 100

False

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

framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

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

gopClosedCadence

integer

Minimum: 0

Maximum: 2147483647

False

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.

qvbrSettings

H264QvbrSettings

False

Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.

numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

framerateDenominator

integer

Minimum: 1

Maximum: 2147483647

False

When you use the API for transcode jobs that use framerate conversion, specify the framerate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use framerate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.

entropyEncoding

string

False
fieldEncoding

string

False
adaptiveQuantization

string

False
interlaceMode

string

False
gopSize

number

Format: float

Minimum: 0.0

False

GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.

gopBReference

string

False
syntax

string

False
parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

sceneChangeDetect

string

False
parControl

string

False
rateControlMode

string

False

See Also

H264SlowPal (enum)

Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.

  • DISABLED

  • ENABLED

H264SpatialAdaptiveQuantization (enum)

Adjust quantization within each frame based on spatial variation of content complexity.

  • DISABLED

  • ENABLED

H264Syntax (enum)

Produces a bitstream compliant with SMPTE RP-2027.

  • DEFAULT

  • RP2027

H264Telecine (enum)

This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.

  • NONE

  • SOFT

  • HARD

H264TemporalAdaptiveQuantization (enum)

Adjust quantization within each frame based on temporal variation of content complexity.

  • DISABLED

  • ENABLED

H264UnregisteredSeiTimecode (enum)

Inserts timecode for each frame as 4 bytes of an unregistered SEI message.

  • DISABLED

  • ENABLED

H265AdaptiveQuantization (enum)

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

  • HIGHER

  • MAX

H265AlternateTransferFunctionSei (enum)

Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF).

  • DISABLED

  • ENABLED

H265CodecLevel (enum)

H.265 Level.

  • AUTO

  • LEVEL_1

  • LEVEL_2

  • LEVEL_2_1

  • LEVEL_3

  • LEVEL_3_1

  • LEVEL_4

  • LEVEL_4_1

  • LEVEL_5

  • LEVEL_5_1

  • LEVEL_5_2

  • LEVEL_6

  • LEVEL_6_1

  • LEVEL_6_2

H265CodecProfile (enum)

Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so "Main/High" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License.

  • MAIN_MAIN

  • MAIN_HIGH

  • MAIN10_MAIN

  • MAIN10_HIGH

  • MAIN_422_8BIT_MAIN

  • MAIN_422_8BIT_HIGH

  • MAIN_422_10BIT_MAIN

  • MAIN_422_10BIT_HIGH

H265DynamicSubGop (enum)

Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).

  • ADAPTIVE

  • STATIC

H265FlickerAdaptiveQuantization (enum)

Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.

  • DISABLED

  • ENABLED

H265FramerateControl (enum)

If you are using the console, use the Framerate setting to specify the framerate for this output. If you want to keep the same framerate as the input video, choose Follow source. If you want to do framerate conversion, choose a framerate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your framerate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the framerate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Choose SPECIFIED if you want the service to use the framerate you specify in the settings FramerateNumerator and FramerateDenominator.

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H265FramerateConversionAlgorithm (enum)

When set to INTERPOLATE, produces smoother motion during framerate conversion.

  • DUPLICATE_DROP

  • INTERPOLATE

H265GopBReference (enum)

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

  • DISABLED

  • ENABLED

H265GopSizeUnits (enum)

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

  • FRAMES

  • SECONDS

H265InterlaceMode (enum)

Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type. - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of "top field first" and "bottom field first". - If the source is progressive, the output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the Follow options you chose.

  • PROGRESSIVE

  • TOP_FIELD

  • BOTTOM_FIELD

  • FOLLOW_TOP_FIELD

  • FOLLOW_BOTTOM_FIELD

H265ParControl (enum)

Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio.

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H265QualityTuningLevel (enum)

Use Quality tuning level (H265QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding.

  • SINGLE_PASS

  • SINGLE_PASS_HQ

  • MULTI_PASS_HQ

H265QvbrSettings

Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.

Property Type Required Description
qvbrQualityLevel

integer

Minimum: 1

Maximum: 10

False

Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h265Settings. Specify the target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9.

maxAverageBitrate

integer

Minimum: 1000

Maximum: 1466400000

False

Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output.

See Also

H265RateControlMode (enum)

Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).

  • VBR

  • CBR

  • QVBR

H265SampleAdaptiveOffsetFilterMode (enum)

Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content

  • DEFAULT

  • ADAPTIVE

  • OFF

H265SceneChangeDetect (enum)

Scene change detection (inserts I-frames on scene changes).

  • DISABLED

  • ENABLED

H265Settings

Settings for H265 codec

Property Type Required Description
slices

integer

Minimum: 1

Maximum: 32

False

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.

minIInterval

integer

Minimum: 0

Maximum: 30

False

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. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1

dynamicSubGop

string

False

Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).

parNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio numerator.

flickerAdaptiveQuantization

string

False
gopSizeUnits

string

False
hrdBufferSize

integer

Minimum: 0

Maximum: 1466400000

False

Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.

qualityTuningLevel

string

False
maxBitrate

integer

Minimum: 1000

Maximum: 1466400000

False

Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.

bitrate

integer

Minimum: 1000

Maximum: 1466400000

False

Average bitrate in bits/second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.

spatialAdaptiveQuantization

string

False
sampleAdaptiveOffsetFilterMode

string

False
temporalIds

string

False
slowPal

string

False
tiles

string

False
writeMp4PackagingType

string

False
codecProfile

string

False
alternateTransferFunctionSei

string

False
unregisteredSeiTimecode

string

False
framerateControl

string

False
telecine

string

False
codecLevel

string

False
framerateConversionAlgorithm

string

False
numberReferenceFrames

integer

Minimum: 1

Maximum: 6

False

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

temporalAdaptiveQuantization

string

False
hrdBufferInitialFillPercentage

integer

Minimum: 0

Maximum: 100

False

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

framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

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

gopClosedCadence

integer

Minimum: 0

Maximum: 2147483647

False

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.

qvbrSettings

H265QvbrSettings

False

Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.

numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

framerateDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Framerate denominator.

adaptiveQuantization

string

False
interlaceMode

string

False
gopSize

number

Format: float

Minimum: 0.0

False

GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.

gopBReference

string

False
parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

sceneChangeDetect

string

False
parControl

string

False
rateControlMode

string

False

See Also

H265SlowPal (enum)

Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.

  • DISABLED

  • ENABLED

H265SpatialAdaptiveQuantization (enum)

Adjust quantization within each frame based on spatial variation of content complexity.

  • DISABLED

  • ENABLED

H265Telecine (enum)

This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.

  • NONE

  • SOFT

  • HARD

H265TemporalAdaptiveQuantization (enum)

Adjust quantization within each frame based on temporal variation of content complexity.

  • DISABLED

  • ENABLED

H265TemporalIds (enum)

Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame rate output.

  • DISABLED

  • ENABLED

H265Tiles (enum)

Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures.

  • DISABLED

  • ENABLED

H265UnregisteredSeiTimecode (enum)

Inserts timecode for each frame as 4 bytes of an unregistered SEI message.

  • DISABLED

  • ENABLED

H265WriteMp4PackagingType (enum)

If HVC1, output that is H.265 will be marked as HVC1 and adhere to the ISO-IECJTC1-SC29_N13798_Text_ISOIEC_FDIS_14496-15_3rd_E spec which states that parameter set NAL units will be stored in the sample headers but not in the samples directly. If HEV1, then H.265 will be marked as HEV1 and parameter set NAL units will be written into the samples.

  • HVC1

  • HEV1

Hdr10Metadata

Use the HDR master display (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. These values vary depending on the input video and must be provided by a color grader. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that these settings are not color correction. Note that if you are creating HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, you must use the HVC1 for H.265 setting.

Property Type Required Description
redPrimaryY

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

greenPrimaryY

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

whitePointX

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

maxLuminance

integer

Minimum: 0

Maximum: 2147483647

False

Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter.

greenPrimaryX

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

whitePointY

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

redPrimaryX

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

bluePrimaryX

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

bluePrimaryY

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

maxFrameAverageLightLevel

integer

Minimum: 0

Maximum: 65535

False

Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter.

maxContentLightLevel

integer

Minimum: 0

Maximum: 65535

False

Maximum light level among all samples in the coded video sequence, in units of candelas per square meter.

minLuminance

integer

Minimum: 0

Maximum: 2147483647

False

Nominal minimum mastering display luminance in units of of 0.0001 candelas per square meter

See Also

HlsAdMarkers (enum)

  • ELEMENTAL

  • ELEMENTAL_SCTE35

HlsAudioTrackType (enum)

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

  • ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT

  • ALTERNATE_AUDIO_AUTO_SELECT

  • ALTERNATE_AUDIO_NOT_AUTO_SELECT

  • AUDIO_ONLY_VARIANT_STREAM

HlsCaptionLanguageMapping

Caption Language Mapping

Property Type Required Description
languageDescription

string

False

Caption language description.

captionChannel

integer

Minimum: -2147483648

Maximum: 2147483647

False

Caption channel.

languageCode

string

False
customLanguageCode

string

Pattern: ^[A-Za-z]{3}$

False

Specify the language for this caption channel, using the ISO 639-2 or ISO 639-3 three-letter language code

See Also

HlsCaptionLanguageSetting (enum)

Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

  • INSERT

  • OMIT

  • NONE

HlsClientCache (enum)

When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.

  • DISABLED

  • ENABLED

HlsCodecSpecification (enum)

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

  • RFC_6381

  • RFC_4281

HlsDirectoryStructure (enum)

Indicates whether segments should be placed in subdirectories.

  • SINGLE_DIRECTORY

  • SUBDIRECTORY_PER_STREAM

HlsEncryptionSettings

Settings for HLS encryption

Property Type Required Description
initializationVectorInManifest

string

False
constantInitializationVector

string

Pattern: ^[0-9a-fA-F]{32}$

False

This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default.

staticKeyProvider

StaticKeyProvider

False
type

string

False
encryptionMethod

string

False
spekeKeyProvider

SpekeKeyProvider

False

See Also

HlsEncryptionType (enum)

Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.

  • AES128

  • SAMPLE_AES

HlsGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.

Property Type Required Description
segmentsPerSubdirectory

integer

Minimum: 1

Maximum: 2147483647

False

Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.

streamInfResolution

string

False
timestampDeltaMilliseconds

integer

Minimum: -2147483648

Maximum: 2147483647

False

Provides an extra millisecond delta offset to fine tune the timestamps.

outputSelection

string

False
captionLanguageMappings

Array of type HlsCaptionLanguageMapping

False

Language to be used on Caption outputs

clientCache

string

False
codecSpecification

string

False
destination

string

Pattern: ^s3:\/\/

False

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

timedMetadataId3Frame

string

False
segmentControl

string

False
timedMetadataId3Period

integer

Minimum: -2147483648

Maximum: 2147483647

False

Timed Metadata interval in seconds.

captionLanguageSetting

string

False
minSegmentLength

integer

Minimum: 0

Maximum: 2147483647

False

When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

directoryStructure

string

False
programDateTime

string

False
baseUrl

string

False

A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

encryption

HlsEncryptionSettings

False

DRM settings.

adMarkers

Array of type string

False

Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

programDateTimePeriod

integer

Minimum: 0

Maximum: 3600

False

Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

manifestCompression

string

False
segmentLength

integer

Minimum: 1

Maximum: 2147483647

False

Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.

manifestDurationFormat

string

False
minFinalSegmentLength

number

Format: float

Minimum: 0.0

Maximum: 2147483647

False

Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.

See Also

HlsIFrameOnlyManifest (enum)

When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

  • INCLUDE

  • EXCLUDE

HlsInitializationVectorInManifest (enum)

The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.

  • INCLUDE

  • EXCLUDE

HlsKeyProviderType (enum)

Indicates which type of key provider is used for encryption.

  • SPEKE

  • STATIC_KEY

HlsManifestCompression (enum)

When set to GZIP, compresses HLS playlist.

  • GZIP

  • NONE

HlsManifestDurationFormat (enum)

Indicates whether the output manifest should use floating point values for segment duration.

  • FLOATING_POINT

  • INTEGER

HlsOutputSelection (enum)

Indicates whether the .m3u8 manifest file should be generated for this HLS output group.

  • MANIFESTS_AND_SEGMENTS

  • SEGMENTS_ONLY

HlsProgramDateTime (enum)

Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

  • INCLUDE

  • EXCLUDE

HlsSegmentControl (enum)

When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

  • SINGLE_FILE

  • SEGMENTED_FILES

HlsSettings

Settings for HLS output groups

Property Type Required Description
iFrameOnlyManifest

string

False
audioRenditionSets

string

False

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 ','.

audioTrackType

string

False
segmentModifier

string

False

String concatenated to end of segment filenames. Accepts "Format Identifiers":#format_identifier_parameters.

audioGroupId

string

False

Specifies the group to which the audio Rendition belongs.

See Also

HlsStreamInfResolution (enum)

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

  • INCLUDE

  • EXCLUDE

HlsTimedMetadataId3Frame (enum)

Indicates ID3 frame that has the timecode.

  • NONE

  • PRIV

  • TDRL

Id3Insertion

To insert ID3 tags in your output, specify two values. Use ID3 tag (Id3) to specify the base 64 encoded string and use Timecode (TimeCode) to specify the time when the tag should be inserted. To insert multiple ID3 tags in your output, create multiple instances of ID3 insertion (Id3Insertion).

Property Type Required Description
id3

string

Pattern: ^[A-Za-z0-9+\/]+={0,2}$

False

Use ID3 tag (Id3) to provide a tag value in base64-encode format.

timecode

string

Format: timecode

Pattern: ^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$

False

Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format.

See Also

ImageInserter

Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this feature for each output individually. This setting is disabled by default.

Property Type Required Description
insertableImages

Array of type InsertableImage

False

Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames.

See Also

Input

Specifies media input

Property Type Required Description
audioSelectors

object

False

Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use mutiple Audio selectors per input.

audioSelectorGroups

object

False

Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See "Audio Selector Group":#inputs-audio_selector_group for more information.

videoSelector

VideoSelector

False
denoiseFilter

string

False
filterEnable

string

False
deblockFilter

string

False
filterStrength

integer

Minimum: -5

Maximum: 5

False

Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.

programNumber

integer

Minimum: 1

Maximum: 2147483647

False

Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default.

timecodeSource

string

False
captionSelectors

object

False

Use Captions selectors (CaptionSelectors) to specify the captions data from the input that you will use in your outputs. You can use mutiple captions selectors per input.

fileInput

string

Pattern: ^(s3:\/\/)([^\/]+\/)+([^\/\.]+|(([^\/]*)\.([mM]2[vV]|[mM][pP][eE][gG]|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM])))$

False

Use Input (fileInput) to define the source file used in the transcode job. There can be multiple inputs in a job. These inputs are concantenated, in the order they are specified in the job, to create the output.

inputClippings

Array of type InputClipping

False

(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them.

psiControl

string

False

See Also

InputClipping

To transcode only portions of your input (clips), include one Input clipping (one instance of InputClipping in the JSON job file) for each input clip. All input clips you specify will be included in every output of the job.

Property Type Required Description
startTimecode

string

Format: timecode

Pattern: ^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$

False

Set Start timecode (StartTimecode) to the beginning of the portion of the input you are clipping. The frame corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:05:00:00.

endTimecode

string

Format: timecode

Pattern: ^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$

False

Set End timecode (EndTimecode) to the end of the portion of the input you are clipping. The frame corresponding to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for timecode source under input settings (InputTimecodeSource). For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end six minutes into the video, use 01:06:00:00.

See Also

InputDeblockFilter (enum)

Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully controllable for MPEG2 and uncompressed video inputs.

  • ENABLED

  • DISABLED

InputDenoiseFilter (enum)

Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.

  • ENABLED

  • DISABLED

InputFilterEnable (enum)

Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type.

  • AUTO

  • DISABLE

  • FORCE

InputPsiControl (enum)

Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.

  • IGNORE_PSI

  • USE_PSI

InputTimecodeSource (enum)

Timecode source under input settings (InputTimecodeSource) only affects the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Use this setting to specify whether the service counts frames by timecodes embedded in the video (EMBEDDED) or by starting the first frame at zero (ZEROBASED). In both cases, the timecode format is HH:MM:SS:FF or HH:MM:SS;FF, where FF is the frame number. Only set this to EMBEDDED if your source video has embedded timecodes.

  • EMBEDDED

  • ZEROBASED

  • SPECIFIEDSTART

InsertableImage

Settings for Insertable Image

Property Type Required Description
duration

integer

Minimum: -2147483648

Maximum: 2147483647

False

Use Duration (Duration) to set the time, in milliseconds, for the image to remain on the output video.

fadeOut

integer

Minimum: -2147483648

Maximum: 2147483647

False

Use Fade out (FadeOut) to set the length, in milliseconds, of the inserted image fade out. If you don't specify a value for Fade out, the image will disappear abruptly at the end of the inserted image duration.

imageY

integer

Minimum: -2147483648

Maximum: 2147483647

False

Use Top (ImageY) to set the distance, in pixels, between the inserted image and the top edge of the video frame. Required for BMP, PNG and TGA input.

fadeIn

integer

Minimum: -2147483648

Maximum: 2147483647

False

Use Fade in (FadeIut) to set the length, in milliseconds, of the inserted image fade in. If you don't specify a value for Fade in, the image will appear abruptly at the Start time.

imageX

integer

Minimum: -2147483648

Maximum: 2147483647

False

Use Left (ImageX) to set the distance, in pixels, between the inserted image and the left edge of the frame. Required for BMP, PNG and TGA input.

width

integer

Minimum: -2147483648

Maximum: 2147483647

False

Specify the Width (Width) of the inserted image. Use a value that is less than or equal to the video resolution width. Leave this setting blank to use the native width of the image.

startTime

string

Pattern: ^((([0-1]\d)|(2[0-3]))(:[0-5]\d){2}([:;][0-5]\d))$

False

Use Start time (StartTime) to specify the video timecode when the image is inserted in the output. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format.

opacity

integer

Minimum: 0

Maximum: 100

False

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

layer

integer

Minimum: 0

Maximum: 99

False

Use Layer (Layer) to specify how overlapping inserted images appear. Images with higher values of layer appear on top of images with lower values of layer.

height

integer

Minimum: -2147483648

Maximum: 2147483647

False

Specify the Height (Height) of the inserted image. Use a value that is less than or equal to the video resolution height. Leave this setting blank to use the native height of the image.

imageInserterInput

string

Pattern: ^(s3:\/\/)(.*?)\.(bmp|BMP|png|PNG|tga|TGA)$

False

Use Image location (imageInserterInput) to specify the Amazon S3 location of the image to be inserted into the output. Use a 32 bit BMP, PNG, or TGA file that fits inside the video frame.

See Also

Job

Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Property Type Required Description
settings

JobSettings

True
role

string

True

The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html

outputGroupDetails

Array of type OutputGroupDetail

False

List of output group details

jobTemplate

string

False

The job template that the job is created from, if it is created from a job template.

timing

Timing

False
errorMessage

string

False

Error message of Job

errorCode

integer

Format: int32

False

Error code for the job

createdAt

string

Format: date-time

False

The time, in Unix epoch format in seconds, when the job got created.

billingTagsSource

string

False
id

string

False

A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources

arn

string

False

An identifier for this resource that is unique within all of AWS.

userMetadata

object

False

User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

queue

string

False

Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

status

string

False

See Also

JobSettings

JobSettings contains all the transcode settings for a job.

Property Type Required Description
timecodeConfig

TimecodeConfig

False

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

adAvailOffset

integer

Minimum: -1000

Maximum: 1000

False

When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.

outputGroups

Array of type OutputGroup

False

(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

nielsenConfiguration

NielsenConfiguration

False
inputs

Array of type Input

False

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

timedMetadataInsertion

TimedMetadataInsertion

False
availBlanking

AvailBlanking

False

Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.

See Also

JobStatus (enum)

A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

  • SUBMITTED

  • PROGRESSING

  • COMPLETE

  • CANCELED

  • ERROR

LanguageCode (enum)

Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php.

  • ENG

  • SPA

  • FRA

  • DEU

  • GER

  • ZHO

  • ARA

  • HIN

  • JPN

  • RUS

  • POR

  • ITA

  • URD

  • VIE

  • KOR

  • PAN

  • ABK

  • AAR

  • AFR

  • AKA

  • SQI

  • AMH

  • ARG

  • HYE

  • ASM

  • AVA

  • AVE

  • AYM

  • AZE

  • BAM

  • BAK

  • EUS

  • BEL

  • BEN

  • BIH

  • BIS

  • BOS

  • BRE

  • BUL

  • MYA

  • CAT

  • KHM

  • CHA

  • CHE

  • NYA

  • CHU

  • CHV

  • COR

  • COS

  • CRE

  • HRV

  • CES

  • DAN

  • DIV

  • NLD

  • DZO

  • ENM

  • EPO

  • EST

  • EWE

  • FAO

  • FIJ

  • FIN

  • FRM

  • FUL

  • GLA

  • GLG

  • LUG

  • KAT

  • ELL

  • GRN

  • GUJ

  • HAT

  • HAU

  • HEB

  • HER

  • HMO

  • HUN

  • ISL

  • IDO

  • IBO

  • IND

  • INA

  • ILE

  • IKU

  • IPK

  • GLE

  • JAV

  • KAL

  • KAN

  • KAU

  • KAS

  • KAZ

  • KIK

  • KIN

  • KIR

  • KOM

  • KON

  • KUA

  • KUR

  • LAO

  • LAT

  • LAV

  • LIM

  • LIN

  • LIT

  • LUB

  • LTZ

  • MKD

  • MLG

  • MSA

  • MAL

  • MLT

  • GLV

  • MRI

  • MAR

  • MAH

  • MON

  • NAU

  • NAV

  • NDE

  • NBL

  • NDO

  • NEP

  • SME

  • NOR

  • NOB

  • NNO

  • OCI

  • OJI

  • ORI

  • ORM

  • OSS

  • PLI

  • FAS

  • POL

  • PUS

  • QUE

  • QAA

  • RON

  • ROH

  • RUN

  • SMO

  • SAG

  • SAN

  • SRD

  • SRB

  • SNA

  • III

  • SND

  • SIN

  • SLK

  • SLV

  • SOM

  • SOT

  • SUN

  • SWA

  • SSW

  • SWE

  • TGL

  • TAH

  • TGK

  • TAM

  • TAT

  • TEL

  • THA

  • BOD

  • TIR

  • TON

  • TSO

  • TSN

  • TUR

  • TUK

  • TWI

  • UIG

  • UKR

  • UZB

  • VEN

  • VOL

  • WLN

  • CYM

  • FRY

  • WOL

  • XHO

  • YID

  • YOR

  • ZHA

  • ZUL

  • ORJ

  • QPC

  • TNG

M2tsAudioBufferModel (enum)

Selects between the DVB and ATSC buffer models for Dolby Digital audio.

  • DVB

  • ATSC

M2tsBufferModel (enum)

Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.

  • MULTIPLEX

  • NONE

M2tsEbpAudioInterval (enum)

When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).

  • VIDEO_AND_FIXED_INTERVALS

  • VIDEO_INTERVAL

M2tsEbpPlacement (enum)

Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).

  • VIDEO_AND_AUDIO_PIDS

  • VIDEO_PID

M2tsEsRateInPes (enum)

Controls whether to include the ES Rate field in the PES header.

  • INCLUDE

  • EXCLUDE

M2tsNielsenId3 (enum)

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

  • INSERT

  • NONE

M2tsPcrControl (enum)

When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream.

  • PCR_EVERY_PES_PACKET

  • CONFIGURED_PCR_PERIOD

M2tsRateMode (enum)

When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.

  • VBR

  • CBR

M2tsScte35Source (enum)

Enables SCTE-35 passthrough (scte35Source) to pass any SCTE-35 signals from input to output.

  • PASSTHROUGH

  • NONE

M2tsSegmentationMarkers (enum)

Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.

  • NONE

  • RAI_SEGSTART

  • RAI_ADAPT

  • PSI_SEGSTART

  • EBP

  • EBP_LEGACY

M2tsSegmentationStyle (enum)

The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "reset_cadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of "maintain_cadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.

  • MAINTAIN_CADENCE

  • RESET_CADENCE

M2tsSettings

Settings for M2TS Container.

Property Type Required Description
dvbTeletextPid

integer

Minimum: 32

Maximum: 8182

False

Packet Identifier (PID) for input source DVB Teletext data to this output.

nielsenId3

string

False
bitrate

integer

Minimum: 0

Maximum: 2147483647

False

The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000.

segmentationTime

number

Format: float

Minimum: 0.0

False

The length in seconds of each segment. Required unless markers is set to _none_.

audioPids

Array of type integer

False

Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation.

rateMode

string

False
maxPcrInterval

integer

Minimum: 0

Maximum: 500

False

Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.

audioFramesPerPes

integer

Minimum: 0

Maximum: 2147483647

False

The number of audio frames to insert for each PES packet.

ebpAudioInterval

string

False
fragmentTime

number

Format: float

Minimum: 0.0

False

The length in seconds of each fragment. Only used with EBP markers.

scte35Pid

integer

Minimum: 32

Maximum: 8182

False

Packet Identifier (PID) of the SCTE-35 stream in the transport stream.

pmtInterval

integer

Minimum: 0

Maximum: 1000

False

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

privateMetadataPid

integer

Minimum: 32

Maximum: 8182

False

Packet Identifier (PID) of the private metadata stream in the transport stream.

segmentationStyle

string

False
audioBufferModel

string

False
programNumber

integer

Minimum: 0

Maximum: 65535

False

The value of the program number field in the Program Map Table.

dvbNitSettings

DvbNitSettings

False
timedMetadataPid

integer

Minimum: 32

Maximum: 8182

False

Packet Identifier (PID) of the timed metadata stream in the transport stream.

scte35Source

string

False
pmtPid

integer

Minimum: 32

Maximum: 8182

False

Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream.

bufferModel

string

False
ebpPlacement

string

False
dvbSdtSettings

DvbSdtSettings

False
nullPacketBitrate

number

Format: float

Minimum: 0.0

False

Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.

pcrPid

integer

Minimum: 32

Maximum: 8182

False

Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID.

minEbpInterval

integer

Minimum: 0