AWS Elemental MediaConvert API Reference
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Presets name

URI

/2017-08-29/presets/name

HTTP Methods

GET

Operation ID: GetPreset

Retrieve the JSON for a specific preset.

Path Parameters

Name Type Required Description
name String True

Responses

Status Code Response Model Description
200 GetPresetResponse

200 response

400 ExceptionBody

The service can't process your request because of a problem in the request. Please check your request form and syntax.

403 ExceptionBody

You don't have permissions for this action with the credentials you sent.

404 ExceptionBody

The resource you requested does not exist.

409 ExceptionBody

The service could not complete your request because there is a conflict with the current state of the resource.

429 ExceptionBody

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

500 ExceptionBody

The service encountered an unexpected condition and cannot fulfill your request.

PUT

Operation ID: UpdatePreset

Modify one of your existing presets.

Path Parameters

Name Type Required Description
name String True

Responses

Status Code Response Model Description
200 UpdatePresetResponse

200 response

400 ExceptionBody

The service can't process your request because of a problem in the request. Please check your request form and syntax.

403 ExceptionBody

You don't have permissions for this action with the credentials you sent.

404 ExceptionBody

The resource you requested does not exist.

409 ExceptionBody

The service could not complete your request because there is a conflict with the current state of the resource.

429 ExceptionBody

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

500 ExceptionBody

The service encountered an unexpected condition and cannot fulfill your request.

DELETE

Operation ID: DeletePreset

Permanently delete a preset you have created.

Path Parameters

Name Type Required Description
name String True

Responses

Status Code Response Model Description
202 DeletePresetResponse

202 response

400 ExceptionBody

The service can't process your request because of a problem in the request. Please check your request form and syntax.

403 ExceptionBody

You don't have permissions for this action with the credentials you sent.

404 ExceptionBody

The resource you requested does not exist.

409 ExceptionBody

The service could not complete your request because there is a conflict with the current state of the resource.

429 ExceptionBody

Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests.

500 ExceptionBody

The service encountered an unexpected condition and cannot fulfill your request.

OPTIONS

Supports CORS preflight requests.

Responses

Status Code Response Model Description
200 None

The request completed successfully.

Schemas

Request Bodies

Example GET

{ "name": "string" }

Example PUT

{ "description": "string", "category": "string", "name": "string", "settings": { "videoDescription": { "fixedAfd": integer, "width": integer, "scalingBehavior": enum, "crop": { "height": integer, "width": integer, "x": integer, "y": integer }, "height": integer, "videoPreprocessors": { "colorCorrector": { "brightness": integer, "colorSpaceConversion": enum, "contrast": integer, "hue": integer, "saturation": integer, "hdr10Metadata": { "redPrimaryX": integer, "redPrimaryY": integer, "greenPrimaryX": integer, "greenPrimaryY": integer, "bluePrimaryX": integer, "bluePrimaryY": integer, "whitePointX": integer, "whitePointY": integer, "maxFrameAverageLightLevel": integer, "maxContentLightLevel": integer, "maxLuminance": integer, "minLuminance": integer } }, "deinterlacer": { "algorithm": enum, "mode": enum, "control": enum }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ] }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer }, "temporalFilterSettings": { "strength": integer, "speed": integer, "aggressiveMode": integer } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "entropyEncoding": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum }, "h265Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "alternateTransferFunctionSei": enum, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "tiles": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "temporalIds": enum, "sampleAdaptiveOffsetFilterMode": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum }, "mpeg2Settings": { "interlaceMode": enum, "parNumerator": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "bitrate": integer, "intraDcPrecision": enum, "framerateControl": enum, "rateControlMode": enum, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "dynamicSubGop": enum }, "proresSettings": { "interlaceMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum } }, "afdSignaling": enum, "dropFrameTimecode": enum, "respondToAfd": enum, "colorMetadata": enum }, "audioDescriptions": [ { "audioTypeControl": enum, "audioSourceName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "correctionGateLevel": integer, "loudnessLogging": enum, "targetLkfs": number, "peakCalculation": enum }, "codecSettings": { "codec": enum, "aacSettings": { "audioDescriptionBroadcasterMix": enum, "vbrQuality": enum, "bitrate": integer, "rateControlMode": enum, "codecProfile": enum, "codingMode": enum, "rawFormat": enum, "sampleRate": integer, "specification": enum }, "ac3Settings": { "bitrate": integer, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "dynamicRangeCompressionProfile": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "eac3AtmosSettings": { "surroundExMode": enum, "loRoSurroundMixLevel": number, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "loRoCenterMixLevel": number, "codingMode": enum, "bitstreamMode": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "meteringMode": enum, "dialogueIntelligence": enum, "speechThreshold": integer }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer, "channelsOut": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "containerSettings": { "container": enum, "m3u8Settings": { "audioFramesPerPes": integer, "pcrControl": enum, "pcrPid": integer, "pmtPid": integer, "privateMetadataPid": integer, "programNumber": integer, "patInterval": integer, "pmtInterval": integer, "scte35Source": enum, "scte35Pid": integer, "nielsenId3": enum, "timedMetadata": enum, "timedMetadataPid": integer, "transportStreamId": integer, "videoPid": integer, "audioPids": [ integer ] }, "f4vSettings": { "moovPlacement": enum }, "m2tsSettings": { "audioBufferModel": enum, "minEbpInterval": integer, "esRateInPes": enum, "patInterval": integer, "dvbNitSettings": { "nitInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "scte35Source": enum, "scte35Pid": integer, "scte35Esam": { "scte35EsamPid": integer }, "videoPid": integer, "dvbTdtSettings": { "tdtInterval": integer }, "pmtInterval": integer, "segmentationStyle": enum, "segmentationTime": number, "pmtPid": integer, "bitrate": integer, "audioPids": [ integer ], "privateMetadataPid": integer, "nielsenId3": enum, "timedMetadataPid": integer, "maxPcrInterval": integer, "transportStreamId": integer, "dvbSubPids": [ integer ], "rateMode": enum, "audioFramesPerPes": integer, "pcrControl": enum, "segmentationMarkers": enum, "ebpAudioInterval": enum, "forceTsVideoEbpOrder": enum, "programNumber": integer, "pcrPid": integer, "bufferModel": enum, "dvbTeletextPid": integer, "fragmentTime": number, "ebpPlacement": enum, "nullPacketBitrate": number }, "movSettings": { "clapAtom": enum, "cslgAtom": enum, "paddingControl": enum, "reference": enum, "mpeg2FourCCControl": enum }, "mp4Settings": { "cslgAtom": enum, "freeSpaceBox": enum, "mp4MajorBrand": "string", "moovPlacement": enum } }, "captionDescriptions": [ { "destinationSettings": { "destinationType": enum, "burninDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "dvbSubDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string", "pageTypes": [ enum ] }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "imscDestinationSettings": { "stylePassthrough": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": integer, "destination708ServiceNumber": integer } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } }

Example DELETE

{ "name": "string" }

Response Bodies

Example GetPresetResponse

{ "preset": { "arn": "string", "createdAt": "string", "lastUpdated": "string", "description": "string", "category": "string", "name": "string", "type": enum, "settings": { "videoDescription": { "fixedAfd": integer, "width": integer, "scalingBehavior": enum, "crop": { "height": integer, "width": integer, "x": integer, "y": integer }, "height": integer, "videoPreprocessors": { "colorCorrector": { "brightness": integer, "colorSpaceConversion": enum, "contrast": integer, "hue": integer, "saturation": integer, "hdr10Metadata": { "redPrimaryX": integer, "redPrimaryY": integer, "greenPrimaryX": integer, "greenPrimaryY": integer, "bluePrimaryX": integer, "bluePrimaryY": integer, "whitePointX": integer, "whitePointY": integer, "maxFrameAverageLightLevel": integer, "maxContentLightLevel": integer, "maxLuminance": integer, "minLuminance": integer } }, "deinterlacer": { "algorithm": enum, "mode": enum, "control": enum }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ] }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer }, "temporalFilterSettings": { "strength": integer, "speed": integer, "aggressiveMode": integer } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "entropyEncoding": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum }, "h265Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "alternateTransferFunctionSei": enum, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "tiles": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "temporalIds": enum, "sampleAdaptiveOffsetFilterMode": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum }, "mpeg2Settings": { "interlaceMode": enum, "parNumerator": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "bitrate": integer, "intraDcPrecision": enum, "framerateControl": enum, "rateControlMode": enum, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "dynamicSubGop": enum }, "proresSettings": { "interlaceMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum } }, "afdSignaling": enum, "dropFrameTimecode": enum, "respondToAfd": enum, "colorMetadata": enum }, "audioDescriptions": [ { "audioTypeControl": enum, "audioSourceName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "correctionGateLevel": integer, "loudnessLogging": enum, "targetLkfs": number, "peakCalculation": enum }, "codecSettings": { "codec": enum, "aacSettings": { "audioDescriptionBroadcasterMix": enum, "vbrQuality": enum, "bitrate": integer, "rateControlMode": enum, "codecProfile": enum, "codingMode": enum, "rawFormat": enum, "sampleRate": integer, "specification": enum }, "ac3Settings": { "bitrate": integer, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "dynamicRangeCompressionProfile": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "eac3AtmosSettings": { "surroundExMode": enum, "loRoSurroundMixLevel": number, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "loRoCenterMixLevel": number, "codingMode": enum, "bitstreamMode": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "meteringMode": enum, "dialogueIntelligence": enum, "speechThreshold": integer }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer, "channelsOut": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "containerSettings": { "container": enum, "m3u8Settings": { "audioFramesPerPes": integer, "pcrControl": enum, "pcrPid": integer, "pmtPid": integer, "privateMetadataPid": integer, "programNumber": integer, "patInterval": integer, "pmtInterval": integer, "scte35Source": enum, "scte35Pid": integer, "nielsenId3": enum, "timedMetadata": enum, "timedMetadataPid": integer, "transportStreamId": integer, "videoPid": integer, "audioPids": [ integer ] }, "f4vSettings": { "moovPlacement": enum }, "m2tsSettings": { "audioBufferModel": enum, "minEbpInterval": integer, "esRateInPes": enum, "patInterval": integer, "dvbNitSettings": { "nitInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "scte35Source": enum, "scte35Pid": integer, "scte35Esam": { "scte35EsamPid": integer }, "videoPid": integer, "dvbTdtSettings": { "tdtInterval": integer }, "pmtInterval": integer, "segmentationStyle": enum, "segmentationTime": number, "pmtPid": integer, "bitrate": integer, "audioPids": [ integer ], "privateMetadataPid": integer, "nielsenId3": enum, "timedMetadataPid": integer, "maxPcrInterval": integer, "transportStreamId": integer, "dvbSubPids": [ integer ], "rateMode": enum, "audioFramesPerPes": integer, "pcrControl": enum, "segmentationMarkers": enum, "ebpAudioInterval": enum, "forceTsVideoEbpOrder": enum, "programNumber": integer, "pcrPid": integer, "bufferModel": enum, "dvbTeletextPid": integer, "fragmentTime": number, "ebpPlacement": enum, "nullPacketBitrate": number }, "movSettings": { "clapAtom": enum, "cslgAtom": enum, "paddingControl": enum, "reference": enum, "mpeg2FourCCControl": enum }, "mp4Settings": { "cslgAtom": enum, "freeSpaceBox": enum, "mp4MajorBrand": "string", "moovPlacement": enum } }, "captionDescriptions": [ { "destinationSettings": { "destinationType": enum, "burninDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "dvbSubDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string", "pageTypes": [ enum ] }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "imscDestinationSettings": { "stylePassthrough": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": integer, "destination708ServiceNumber": integer } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } } }

Example UpdatePresetResponse

{ "preset": { "arn": "string", "createdAt": "string", "lastUpdated": "string", "description": "string", "category": "string", "name": "string", "type": enum, "settings": { "videoDescription": { "fixedAfd": integer, "width": integer, "scalingBehavior": enum, "crop": { "height": integer, "width": integer, "x": integer, "y": integer }, "height": integer, "videoPreprocessors": { "colorCorrector": { "brightness": integer, "colorSpaceConversion": enum, "contrast": integer, "hue": integer, "saturation": integer, "hdr10Metadata": { "redPrimaryX": integer, "redPrimaryY": integer, "greenPrimaryX": integer, "greenPrimaryY": integer, "bluePrimaryX": integer, "bluePrimaryY": integer, "whitePointX": integer, "whitePointY": integer, "maxFrameAverageLightLevel": integer, "maxContentLightLevel": integer, "maxLuminance": integer, "minLuminance": integer } }, "deinterlacer": { "algorithm": enum, "mode": enum, "control": enum }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ] }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer }, "temporalFilterSettings": { "strength": integer, "speed": integer, "aggressiveMode": integer } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "entropyEncoding": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum }, "h265Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "alternateTransferFunctionSei": enum, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "tiles": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "temporalIds": enum, "sampleAdaptiveOffsetFilterMode": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum }, "mpeg2Settings": { "interlaceMode": enum, "parNumerator": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "bitrate": integer, "intraDcPrecision": enum, "framerateControl": enum, "rateControlMode": enum, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "dynamicSubGop": enum }, "proresSettings": { "interlaceMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum } }, "afdSignaling": enum, "dropFrameTimecode": enum, "respondToAfd": enum, "colorMetadata": enum }, "audioDescriptions": [ { "audioTypeControl": enum, "audioSourceName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "correctionGateLevel": integer, "loudnessLogging": enum, "targetLkfs": number, "peakCalculation": enum }, "codecSettings": { "codec": enum, "aacSettings": { "audioDescriptionBroadcasterMix": enum, "vbrQuality": enum, "bitrate": integer, "rateControlMode": enum, "codecProfile": enum, "codingMode": enum, "rawFormat": enum, "sampleRate": integer, "specification": enum }, "ac3Settings": { "bitrate": integer, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "dynamicRangeCompressionProfile": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "eac3AtmosSettings": { "surroundExMode": enum, "loRoSurroundMixLevel": number, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "loRoCenterMixLevel": number, "codingMode": enum, "bitstreamMode": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "meteringMode": enum, "dialogueIntelligence": enum, "speechThreshold": integer }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer, "channelsOut": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "containerSettings": { "container": enum, "m3u8Settings": { "audioFramesPerPes": integer, "pcrControl": enum, "pcrPid": integer, "pmtPid": integer, "privateMetadataPid": integer, "programNumber": integer, "patInterval": integer, "pmtInterval": integer, "scte35Source": enum, "scte35Pid": integer, "nielsenId3": enum, "timedMetadata": enum, "timedMetadataPid": integer, "transportStreamId": integer, "videoPid": integer, "audioPids": [ integer ] }, "f4vSettings": { "moovPlacement": enum }, "m2tsSettings": { "audioBufferModel": enum, "minEbpInterval": integer, "esRateInPes": enum, "patInterval": integer, "dvbNitSettings": { "nitInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "scte35Source": enum, "scte35Pid": integer, "scte35Esam": { "scte35EsamPid": integer }, "videoPid": integer, "dvbTdtSettings": { "tdtInterval": integer }, "pmtInterval": integer, "segmentationStyle": enum, "segmentationTime": number, "pmtPid": integer, "bitrate": integer, "audioPids": [ integer ], "privateMetadataPid": integer, "nielsenId3": enum, "timedMetadataPid": integer, "maxPcrInterval": integer, "transportStreamId": integer, "dvbSubPids": [ integer ], "rateMode": enum, "audioFramesPerPes": integer, "pcrControl": enum, "segmentationMarkers": enum, "ebpAudioInterval": enum, "forceTsVideoEbpOrder": enum, "programNumber": integer, "pcrPid": integer, "bufferModel": enum, "dvbTeletextPid": integer, "fragmentTime": number, "ebpPlacement": enum, "nullPacketBitrate": number }, "movSettings": { "clapAtom": enum, "cslgAtom": enum, "paddingControl": enum, "reference": enum, "mpeg2FourCCControl": enum }, "mp4Settings": { "cslgAtom": enum, "freeSpaceBox": enum, "mp4MajorBrand": "string", "moovPlacement": enum } }, "captionDescriptions": [ { "destinationSettings": { "destinationType": enum, "burninDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "dvbSubDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string", "pageTypes": [ enum ] }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "imscDestinationSettings": { "stylePassthrough": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": integer, "destination708ServiceNumber": integer } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } } }

Example DeletePresetResponse

{ }

Example ExceptionBody

{ "message": "string" }

Properties

AacAudioDescriptionBroadcasterMix

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

AAC Profile.

  • LC

  • HEV1

  • HEV2

AacCodingMode

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

Rate Control Mode.

  • CBR

  • VBR

AacRawFormat

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
audioDescriptionBroadcasterMix

AacAudioDescriptionBroadcasterMix

False

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.

vbrQuality

AacVbrQuality

False

VBR Quality Level - Only used if rate_control_mode is VBR.

bitrate

integer

Minimum: 6000

Maximum: 1024000

False

Specify the average bitrate in bits per second. The set of valid values for this setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000. The value you set is also constrained by the values that you choose for Profile (codecProfile), Bitrate control mode (codingMode), and Sample rate (sampleRate). Default values depend on Bitrate control mode and Profile.

rateControlMode

AacRateControlMode

False

Rate Control Mode.

codecProfile

AacCodecProfile

False

AAC Profile.

codingMode

AacCodingMode

False

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.

rawFormat

AacRawFormat

False

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.

sampleRate

integer

Minimum: 8000

Maximum: 96000

False

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

specification

AacSpecification

False

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

AacSpecification

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

  • MPEG2

  • MPEG4

AacVbrQuality

VBR Quality Level - Only used if rate_control_mode is VBR.

  • LOW

  • MEDIUM_LOW

  • MEDIUM_HIGH

  • HIGH

Ac3BitstreamMode

Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).

  • COMPLETE_MAIN

  • COMMENTARY

  • DIALOGUE

  • EMERGENCY

  • HEARING_IMPAIRED

  • MUSIC_AND_EFFECTS

  • VISUALLY_IMPAIRED

  • VOICE_OVER

Ac3CodingMode

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

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

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

  • ENABLED

  • DISABLED

Ac3MetadataControl

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
bitrate

integer

Minimum: 64000

Maximum: 640000

False

Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode.

bitstreamMode

Ac3BitstreamMode

False

Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).

codingMode

Ac3CodingMode

False

Dolby Digital coding mode. Determines number of channels.

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.

dynamicRangeCompressionProfile

Ac3DynamicRangeCompressionProfile

False

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

metadataControl

Ac3MetadataControl

False

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.

lfeFilter

Ac3LfeFilter

False

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

sampleRate

integer

Minimum: 48000

Maximum: 48000

False

This value is always 48000. It represents the sample rate in Hz.

AfdSignaling

This setting only applies to H.264, H.265, 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
bitDepth

integer

Minimum: 16

Maximum: 24

False

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

channels

integer

Minimum: 1

Maximum: 64

False

Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64.

sampleRate

integer

Minimum: 8000

Maximum: 192000

False

Sample rate in hz.

AntiAlias

The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

  • DISABLED

  • ENABLED

AudioCodec

Type of Audio codec.

  • AAC

  • MP2

  • WAV

  • AIFF

  • AC3

  • EAC3

  • EAC3_ATMOS

  • 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 that you choose for Audio codec (Codec). For each codec enum that 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 * EAC3_ATMOS, Eac3AtmosSettings

Property Type Required Description
codec

AudioCodec

False

Type of Audio codec.

aacSettings

AacSettings

False

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.

ac3Settings

Ac3Settings

False

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

aiffSettings

AiffSettings

False

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

eac3Settings

Eac3Settings

False

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

eac3AtmosSettings

Eac3AtmosSettings

False

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

mp2Settings

Mp2Settings

False

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

wavSettings

WavSettings

False

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

AudioDescription

Description of audio output

Property Type Required Description
audioTypeControl

AudioTypeControl

False

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.

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.

audioNormalizationSettings

AudioNormalizationSettings

False

Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.

codecSettings

AudioCodecSettings

False

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 that you choose for Audio codec (Codec). For each codec enum that 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 * EAC3_ATMOS, Eac3AtmosSettings

remixSettings

RemixSettings

False

Advanced audio remixing settings.

streamName

string

Pattern: ^[\w\s]*$

False

Specify a label for this output audio stream. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

languageCodeControl

AudioLanguageCodeControl

False

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.

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.

customLanguageCode

string

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

MinLength: 3

MaxLength: 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.

languageCode

LanguageCode

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.

AudioLanguageCodeControl

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

Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.

  • ITU_BS_1770_1

  • ITU_BS_1770_2

  • ITU_BS_1770_3

  • ITU_BS_1770_4

AudioNormalizationAlgorithmControl

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

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

  • LOG

  • DONT_LOG

AudioNormalizationPeakCalculation

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. Ignore these settings unless you need to comply with a loudness standard.

Property Type Required Description
algorithm

AudioNormalizationAlgorithm

False

Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.

algorithmControl

AudioNormalizationAlgorithmControl

False

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

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.

loudnessLogging

AudioNormalizationLoudnessLogging

False

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

targetLkfs

number

Format: float

Minimum: -59.0

Maximum: 0.0

False

When you use Audio normalization (AudioNormalizationSettings), optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.

peakCalculation

AudioNormalizationPeakCalculation

False

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

AudioTypeControl

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

BurninDestinationSettings

Burn-In Destination Settings.

Property Type Required Description
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.

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.

teletextSpacing

BurninSubtitleTeletextSpacing

False

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.

alignment

BurninSubtitleAlignment

False

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.

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.

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.

shadowColor

BurninSubtitleShadowColor

False

Specifies the color of the shadow cast by the captions. 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.

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.

fontScript

FontScript

False

Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions.

fontColor

BurninSubtitleFontColor

False

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.

backgroundColor

BurninSubtitleBackgroundColor

False

Specifies the color of the rectangle behind the captions. 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.

outlineColor

BurninSubtitleOutlineColor

False

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.

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.

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.

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.

BurninSubtitleAlignment

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

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

  • NONE

  • BLACK

  • WHITE

BurninSubtitleFontColor

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

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

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

  • NONE

  • BLACK

  • WHITE

BurninSubtitleTeletextSpacing

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

CaptionDescriptionPreset

Caption Description for preset

Property Type Required Description
destinationSettings

CaptionDestinationSettings

False

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.

customLanguageCode

string

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

MinLength: 3

MaxLength: 3

False

Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

languageCode

LanguageCode

False

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

languageDescription

string

False

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

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
destinationType

CaptionDestinationType

False

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

burninDestinationSettings

BurninDestinationSettings

False

Burn-In Destination Settings.

dvbSubDestinationSettings

DvbSubDestinationSettings

False

DVB-Sub Destination Settings

sccDestinationSettings

SccDestinationSettings

False

Settings for SCC caption output.

teletextDestinationSettings

TeletextDestinationSettings

False

Settings for Teletext caption output

ttmlDestinationSettings

TtmlDestinationSettings

False

Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).

imscDestinationSettings

ImscDestinationSettings

False

Settings specific to IMSC caption outputs.

embeddedDestinationSettings

EmbeddedDestinationSettings

False

Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.

CaptionDestinationType

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

  • BURN_IN

  • DVB_SUB

  • EMBEDDED

  • EMBEDDED_PLUS_SCTE20

  • IMSC

  • SCTE20_PLUS_EMBEDDED

  • SCC

  • SRT

  • SMI

  • TELETEXT

  • TTML

  • WEBVTT

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

ColorCorrector

Settings for color correction.

Property Type Required Description
brightness

integer

Minimum: 1

Maximum: 100

False

Brightness level.

colorSpaceConversion

ColorSpaceConversion

False

Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output.

contrast

integer

Minimum: 1

Maximum: 100

False

Contrast level.

hue

integer

Minimum: -180

Maximum: 180

False

Hue in degrees.

saturation

integer

Minimum: 1

Maximum: 100

False

Saturation level.

hdr10Metadata

Hdr10Metadata

False

Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.

ColorMetadata

Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

  • IGNORE

  • INSERT

ColorSpaceConversion

Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output.

  • NONE

  • FORCE_601

  • FORCE_709

  • FORCE_HDR10

  • FORCE_HLG_2020

ContainerSettings

Container specific settings.

Property Type Required Description
container

ContainerType

False

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

m3u8Settings

M3u8Settings

False

Settings for TS segments in HLS

f4vSettings

F4vSettings

False

Settings for F4v container

m2tsSettings

M2tsSettings

False

MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.

movSettings

MovSettings

False

Settings for MOV Container.

mp4Settings

Mp4Settings

False

Settings for MP4 container. You can create audio-only AAC outputs with this container.

ContainerType

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

DeinterlaceAlgorithm

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
algorithm

DeinterlaceAlgorithm

False

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.

mode

DeinterlacerMode

False

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.

control

DeinterlacerControl

False

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

DeinterlacerControl

- 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

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

DeletePresetRequest

Delete a preset by sending a request with the preset name

Property Type Required Description
name

string

False

The name of the preset to be deleted.

DeletePresetResponse

Delete preset requests will return an OK message or error message with an empty body.

DropFrameTimecode

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
nitInterval

integer

Minimum: 25

Maximum: 10000

False

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

networkId

integer

Minimum: 0

Maximum: 65535

False

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

networkName

string

MinLength: 1

MaxLength: 256

False

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

DvbSdtSettings

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

Property Type Required Description
outputSdt

OutputSdt

False

Selects method of inserting SDT information into output stream. "Follow input SDT" copies SDT information from input stream to output stream. "Follow input SDT if present" copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. Enter "SDT Manually" means user will enter the SDT information. "No SDT" means output stream will not contain SDT information.

sdtInterval

integer

Minimum: 25

Maximum: 2000

False

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

serviceName

string

MinLength: 1

MaxLength: 256

False

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

serviceProviderName

string

MinLength: 1

MaxLength: 256

False

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

DvbSubDestinationSettings

DVB-Sub Destination Settings

Property Type Required Description
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.

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.

teletextSpacing

DvbSubtitleTeletextSpacing

False

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.

alignment

DvbSubtitleAlignment

False

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.

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.

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.

shadowColor

DvbSubtitleShadowColor

False

Specifies the color of the shadow cast by the captions. 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.

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.

fontScript

FontScript

False

Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is used to help determine the appropriate font for rendering DVB-Sub captions.

fontColor

DvbSubtitleFontColor

False

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.

backgroundColor

DvbSubtitleBackgroundColor

False

Specifies the color of the rectangle behind the captions. 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.

outlineColor

DvbSubtitleOutlineColor

False

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.

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.

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.

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.

DvbSubtitleAlignment

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

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

  • NONE

  • BLACK

  • WHITE

DvbSubtitleFontColor

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

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

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

  • NONE

  • BLACK

  • WHITE

DvbSubtitleTeletextSpacing

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.

Eac3AtmosBitstreamMode

Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).

  • COMPLETE_MAIN

Eac3AtmosCodingMode

The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).

  • CODING_MODE_9_1_6

Eac3AtmosDialogueIntelligence

Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.

  • ENABLED

  • DISABLED

Eac3AtmosDynamicRangeCompressionLine

Specify the absolute peak level for a signal with dynamic range compression.

  • NONE

  • FILM_STANDARD

  • FILM_LIGHT

  • MUSIC_STANDARD

  • MUSIC_LIGHT

  • SPEECH

Eac3AtmosDynamicRangeCompressionRf

Specify how the service limits the audio dynamic range when compressing the audio.

  • NONE

  • FILM_STANDARD

  • FILM_LIGHT

  • MUSIC_STANDARD

  • MUSIC_LIGHT

  • SPEECH

Eac3AtmosMeteringMode

Choose how the service meters the loudness of your audio.

  • LEQ_A

  • ITU_BS_1770_1

  • ITU_BS_1770_2

  • ITU_BS_1770_3

  • ITU_BS_1770_4

Eac3AtmosSettings

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

Property Type Required Description
surroundExMode

Eac3AtmosSurroundExMode

False

Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.

loRoSurroundMixLevel

number

Format: float

Minimum: -60.0

Maximum: -1.5

False

Specify a value for the following Dolby Atmos setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.

ltRtSurroundMixLevel

number

Format: float

Minimum: -60.0

Maximum: -1.5

False

Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.

bitrate

integer

Minimum: 384000

Maximum: 768000

False

Specify the average bitrate in bits per second. Valid values: 384k, 448k, 640k, 768k

ltRtCenterMixLevel

number

Format: float

Minimum: -6.0

Maximum: 3.0

False

Specify a value for the following Dolby Atmos setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.

loRoCenterMixLevel

number

Format: float

Minimum: -6.0

Maximum: 3.0

False

Specify a value for the following Dolby Atmos setting: Left only/Right only center mix (Lo/Ro center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.

codingMode

Eac3AtmosCodingMode

False

The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).

bitstreamMode

Eac3AtmosBitstreamMode

False

Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).

stereoDownmix

Eac3AtmosStereoDownmix

False

Choose how the service does stereo downmixing.

dynamicRangeCompressionRf

Eac3AtmosDynamicRangeCompressionRf

False

Specify how the service limits the audio dynamic range when compressing the audio.

sampleRate

integer

Minimum: 48000

Maximum: 48000

False

This value is always 48000. It represents the sample rate in Hz.

dynamicRangeCompressionLine

Eac3AtmosDynamicRangeCompressionLine

False

Specify the absolute peak level for a signal with dynamic range compression.

meteringMode

Eac3AtmosMeteringMode

False

Choose how the service meters the loudness of your audio.

dialogueIntelligence

Eac3AtmosDialogueIntelligence

False

Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.

speechThreshold

integer

Minimum: 1

Maximum: 100

False

Specify the percentage of audio content that must be speech before the encoder uses the measured speech loudness as the overall program loudness.

Eac3AtmosStereoDownmix

Choose how the service does stereo downmixing.

  • NOT_INDICATED

  • STEREO

  • SURROUND

  • DPL2

Eac3AtmosSurroundExMode

Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.

  • NOT_INDICATED

  • ENABLED

  • DISABLED

Eac3AttenuationControl

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

Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).

  • COMPLETE_MAIN

  • COMMENTARY

  • EMERGENCY

  • HEARING_IMPAIRED

  • VISUALLY_IMPAIRED

Eac3CodingMode

Dolby Digital Plus coding mode. Determines number of channels.

  • CODING_MODE_1_0

  • CODING_MODE_2_0

  • CODING_MODE_3_2

Eac3DcFilter

Activates a DC highpass filter for all input channels.

  • ENABLED

  • DISABLED

Eac3DynamicRangeCompressionLine

Specify the absolute peak level for a signal with dynamic range compression.

  • NONE

  • FILM_STANDARD

  • FILM_LIGHT

  • MUSIC_STANDARD

  • MUSIC_LIGHT

  • SPEECH

Eac3DynamicRangeCompressionRf

Specify how the service limits the audio dynamic range when compressing the audio.

  • NONE

  • FILM_STANDARD

  • FILM_LIGHT

  • MUSIC_STANDARD

  • MUSIC_LIGHT

  • SPEECH

Eac3LfeControl

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

  • LFE

  • NO_LFE

Eac3LfeFilter

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

  • ENABLED

  • DISABLED

Eac3MetadataControl

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

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

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
metadataControl

Eac3MetadataControl

False

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.

surroundExMode

Eac3SurroundExMode

False

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

loRoSurroundMixLevel

number

Format: float

Minimum: -60.0

Maximum: -1.5

False

Specify a value for the following Dolby Digital Plus setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only surround (loRoSurroundMixLevel).

phaseControl

Eac3PhaseControl

False

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

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.

ltRtSurroundMixLevel

number

Format: float

Minimum: -60.0

Maximum: -1.5

False

Specify a value for the following Dolby Digital Plus setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total surround (ltRtSurroundMixLevel).

bitrate

integer

Minimum: 64000

Maximum: 640000

False

Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode.

ltRtCenterMixLevel

number

Format: float

Minimum: -60.0

Maximum: 3.0

False

Specify a value for the following Dolby Digital Plus setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total center (ltRtCenterMixLevel).

passthroughControl

Eac3PassthroughControl

False

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.

lfeControl

Eac3LfeControl

False

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

loRoCenterMixLevel

number

Format: float

Minimum: -60.0

Maximum: 3.0

False

Specify a value for the following Dolby Digital Plus setting: Left only/Right only center mix (Lo/Ro center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only center (loRoCenterMixLevel).

attenuationControl

Eac3AttenuationControl

False

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

codingMode

Eac3CodingMode

False

Dolby Digital Plus coding mode. Determines number of channels.

surroundMode

Eac3SurroundMode

False

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

bitstreamMode

Eac3BitstreamMode

False

Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).

lfeFilter

Eac3LfeFilter

False

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

stereoDownmix

Eac3StereoDownmix

False

Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Stereo downmix (Eac3StereoDownmix).

dynamicRangeCompressionRf

Eac3DynamicRangeCompressionRf

False

Specify how the service limits the audio dynamic range when compressing the audio.

sampleRate

integer

Minimum: 48000

Maximum: 48000

False

This value is always 48000. It represents the sample rate in Hz.

dynamicRangeCompressionLine

Eac3DynamicRangeCompressionLine

False

Specify the absolute peak level for a signal with dynamic range compression.

dcFilter

Eac3DcFilter

False

Activates a DC highpass filter for all input channels.

Eac3StereoDownmix

Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Stereo downmix (Eac3StereoDownmix).

  • NOT_INDICATED

  • LO_RO

  • LT_RT

  • DPL2

Eac3SurroundExMode

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

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

  • NOT_INDICATED

  • ENABLED

  • DISABLED

EmbeddedDestinationSettings

Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.

Property Type Required Description
destination608ChannelNumber

integer

Minimum: 1

Maximum: 4

False

Ignore this setting unless your input captions are SCC format and your output captions are embedded in the video stream. Specify a CC number for each captions channel in this output. If you have two channels, choose CC numbers that aren't in the same field. For example, choose 1 and 3. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded.

destination708ServiceNumber

integer

Minimum: 1

Maximum: 6

False

Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a different number for each channel. To use this setting, also set Force 608 to 708 upconvert (Convert608To708) to Upconvert (UPCONVERT) in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, MediaConvert uses the number that you specify for CC channel number (destination608ChannelNumber) for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded.

ExceptionBody

Property Type Required Description
message

string

False

F4vMoovPlacement

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

F4vMoovPlacement

False

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.

FontScript

Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset.

  • AUTOMATIC

  • HANS

  • HANT

FrameCaptureSettings

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

Property Type Required Description
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.

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

quality

integer

Minimum: 1

Maximum: 100

False

JPEG Quality - a higher value equals higher quality.

GetPresetRequest

Query a preset by sending a request with the preset name.

Property Type Required Description
name

string

False

The name of the preset.

GetPresetResponse

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

Property Type Required Description
preset

Preset

False

A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.

H264AdaptiveQuantization

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

  • HIGHER

  • MAX

H264CodecLevel

Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO).

  • 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

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

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

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

  • CABAC

  • CAVLC

H264FieldEncoding

Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.

  • PAFF

  • FORCE_FIELD

H264FlickerAdaptiveQuantization

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

  • DISABLED

  • ENABLED

H264FramerateControl

If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate 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 frame rate 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 frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264FramerateConversionAlgorithm

When set to INTERPOLATE, produces smoother motion during frame rate conversion.

  • DUPLICATE_DROP

  • INTERPOLATE

H264GopBReference

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

  • DISABLED

  • ENABLED

H264GopSizeUnits

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

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

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

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

H264RateControlMode

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

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

  • DISABLED

  • ENABLED

H264SceneChangeDetect

Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.

  • DISABLED

  • ENABLED

  • TRANSITION_DETECTION

H264Settings

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

Property Type Required Description
interlaceMode

H264InterlaceMode

False

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.

parNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio numerator.

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.

syntax

H264Syntax

False

Produces a bitstream compliant with SMPTE RP-2027.

softness

integer

Minimum: 0

Maximum: 128

False

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

framerateDenominator

integer

Minimum: 1

Maximum: 2147483647

False

When you use the API for transcode jobs that use frame rate conversion, specify the frame rate 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 frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.

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.

hrdBufferInitialFillPercentage

integer

Minimum: 0

Maximum: 100

False

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

gopSize

number

Format: float

Minimum: 0.0

False

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

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.

gopBReference

H264GopBReference

False

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

hrdBufferSize

integer

Minimum: 0

Maximum: 1152000000

False

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

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.

slowPal

H264SlowPal

False

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

parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

spatialAdaptiveQuantization

H264SpatialAdaptiveQuantization

False

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

temporalAdaptiveQuantization

H264TemporalAdaptiveQuantization

False

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

flickerAdaptiveQuantization

H264FlickerAdaptiveQuantization

False

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

entropyEncoding

H264EntropyEncoding

False

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

bitrate

integer

Minimum: 1000

Maximum: 1152000000

False

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

framerateControl

H264FramerateControl

False

If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate 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 frame rate 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 frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.

rateControlMode

H264RateControlMode

False

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

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.

codecProfile

H264CodecProfile

False

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

telecine

H264Telecine

False

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.

framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps.

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

adaptiveQuantization

H264AdaptiveQuantization

False

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

codecLevel

H264CodecLevel

False

Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO).

fieldEncoding

H264FieldEncoding

False

Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.

sceneChangeDetect

H264SceneChangeDetect

False

Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.

qualityTuningLevel

H264QualityTuningLevel

False

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

framerateConversionAlgorithm

H264FramerateConversionAlgorithm

False

When set to INTERPOLATE, produces smoother motion during frame rate conversion.

unregisteredSeiTimecode

H264UnregisteredSeiTimecode

False

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

gopSizeUnits

H264GopSizeUnits

False

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.

parControl

H264ParControl

False

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.

numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

repeatPps

H264RepeatPps

False

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

dynamicSubGop

H264DynamicSubGop

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

H264SlowPal

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

  • DISABLED

  • ENABLED

H264SpatialAdaptiveQuantization

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

  • DISABLED

  • ENABLED

H264Syntax

Produces a bitstream compliant with SMPTE RP-2027.

  • DEFAULT

  • RP2027

H264Telecine

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

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

  • DISABLED

  • ENABLED

H264UnregisteredSeiTimecode

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

  • DISABLED

  • ENABLED

H265AdaptiveQuantization

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

  • HIGHER

  • MAX

H265AlternateTransferFunctionSei

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

  • DISABLED

  • ENABLED

H265CodecLevel

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

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

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

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

  • DISABLED

  • ENABLED

H265FramerateControl

If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate 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 frame rate 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 frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H265FramerateConversionAlgorithm

When set to INTERPOLATE, produces smoother motion during frame rate conversion.

  • DUPLICATE_DROP

  • INTERPOLATE

H265GopBReference

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

  • DISABLED

  • ENABLED

H265GopSizeUnits

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

Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. 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, your output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE).

  • PROGRESSIVE

  • TOP_FIELD

  • BOTTOM_FIELD

  • FOLLOW_TOP_FIELD

  • FOLLOW_BOTTOM_FIELD

H265ParControl

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

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

H265RateControlMode

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

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

  • DEFAULT

  • ADAPTIVE

  • OFF

H265SceneChangeDetect

Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.

  • DISABLED

  • ENABLED

  • TRANSITION_DETECTION

H265Settings

Settings for H265 codec

Property Type Required Description
interlaceMode

H265InterlaceMode

False

Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. 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, your output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE).

parNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio numerator.

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.

framerateDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Frame rate denominator.

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.

alternateTransferFunctionSei

H265AlternateTransferFunctionSei

False

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

hrdBufferInitialFillPercentage

integer

Minimum: 0

Maximum: 100

False

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

gopSize

number

Format: float

Minimum: 0.0

False

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

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.

gopBReference

H265GopBReference

False

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

hrdBufferSize

integer

Minimum: 0

Maximum: 1466400000

False

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

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.

slowPal

H265SlowPal

False

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

parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

spatialAdaptiveQuantization

H265SpatialAdaptiveQuantization

False

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

temporalAdaptiveQuantization

H265TemporalAdaptiveQuantization

False

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

flickerAdaptiveQuantization

H265FlickerAdaptiveQuantization

False

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

bitrate

integer

Minimum: 1000

Maximum: 1466400000

False

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

framerateControl

H265FramerateControl

False

If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate 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 frame rate 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 frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.

rateControlMode

H265RateControlMode

False

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

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.

codecProfile

H265CodecProfile

False

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.

tiles

H265Tiles

False

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

telecine

H265Telecine

False

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.

framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps.

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

adaptiveQuantization

H265AdaptiveQuantization

False

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

codecLevel

H265CodecLevel

False

H.265 Level.

sceneChangeDetect

H265SceneChangeDetect

False

Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.

qualityTuningLevel

H265QualityTuningLevel

False

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

framerateConversionAlgorithm

H265FramerateConversionAlgorithm

False

When set to INTERPOLATE, produces smoother motion during frame rate conversion.

unregisteredSeiTimecode

H265UnregisteredSeiTimecode

False

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

gopSizeUnits

H265GopSizeUnits

False

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.

parControl

H265ParControl

False

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.

numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

temporalIds

H265TemporalIds

False

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.

sampleAdaptiveOffsetFilterMode

H265SampleAdaptiveOffsetFilterMode

False

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

writeMp4PackagingType

H265WriteMp4PackagingType

False

Use this setting only for outputs encoded with H.265 that are in CMAF or DASH output groups. If you include writeMp4PackagingType in your JSON job specification for other outputs, your video might not work properly with downstream systems and video players. If the location of parameter set NAL units don't matter in your workflow, ignore this setting. The service defaults to marking your output as HEV1. Choose HVC1 to mark your output as HVC1. This makes your output compliant with this specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. Keep the default HEV1 to mark your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples.

dynamicSubGop

H265DynamicSubGop

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

H265SlowPal

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

  • DISABLED

  • ENABLED

H265SpatialAdaptiveQuantization

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

  • DISABLED

  • ENABLED

H265Telecine

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

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

  • DISABLED

  • ENABLED

H265TemporalIds

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

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

  • DISABLED

  • ENABLED

H265UnregisteredSeiTimecode

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

  • DISABLED

  • ENABLED

H265WriteMp4PackagingType

Use this setting only for outputs encoded with H.265 that are in CMAF or DASH output groups. If you include writeMp4PackagingType in your JSON job specification for other outputs, your video might not work properly with downstream systems and video players. If the location of parameter set NAL units don't matter in your workflow, ignore this setting. The service defaults to marking your output as HEV1. Choose HVC1 to mark your output as HVC1. This makes your output compliant with this specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. Keep the default HEV1 to mark your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples.

  • HVC1

  • HEV1

Hdr10Metadata

Use these settings to specify static color calibration metadata, as defined by SMPTE ST 2086. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator.

Property Type Required Description
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.

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.

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.

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.

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.

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.

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.

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. This setting doesn't have a default value; you must specify a value that is suitable for the content.

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. This setting doesn't have a default value; you must specify a value that is suitable for the content.

maxLuminance

integer

Minimum: 0

Maximum: 2147483647

False

Nominal maximum mastering display luminance in units of of 0.0001 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

ImageInserter

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

Property Type Required Description
insertableImages

Array of type InsertableImage

False

Specify the images that you want to overlay on your video. The images must be PNG or TGA files.

ImscDestinationSettings

Settings specific to IMSC caption outputs.

Property Type Required Description
stylePassthrough

ImscStylePassthrough

False

Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are CFF-TT, IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions.

ImscStylePassthrough

Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are CFF-TT, IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions.

  • ENABLED

  • DISABLED

InsertableImage

Settings that specify how your still graphic overlay appears.

Property Type Required Description
width

integer

Minimum: 0

Maximum: 2147483647

False

Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.

height

integer

Minimum: 0

Maximum: 2147483647

False

Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank.

imageX

integer

Minimum: 0

Maximum: 2147483647

False

Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify.

imageY

integer

Minimum: 0

Maximum: 2147483647

False

Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.

duration

integer

Minimum: 0

Maximum: 2147483647

False

Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time.

fadeIn

integer

Minimum: 0

Maximum: 2147483647

False

Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.

layer

integer

Minimum: 0

Maximum: 99

False

Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.

imageInserterInput

string

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

MinLength: 14

False

Specify the Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.

startTime

string

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

False

Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.

fadeOut

integer

Minimum: 0

Maximum: 2147483647

False

Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.

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.

LanguageCode

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

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

  • DVB

  • ATSC

M2tsBufferModel

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

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

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

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

  • INCLUDE

  • EXCLUDE

M2tsForceTsVideoEbpOrder

Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE).

  • FORCE

  • DEFAULT

M2tsNielsenId3

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

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

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

M2tsScte35Esam

Settings for SCTE-35 signals from ESAM. Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

Property Type Required Description
scte35EsamPid

integer

Minimum: 32

Maximum: 8182

False

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

M2tsScte35Source

For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).

  • PASSTHROUGH

  • NONE

M2tsSegmentationMarkers

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

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

MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.

Property Type Required Description
audioBufferModel

M2tsAudioBufferModel

False

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

minEbpInterval

integer

Minimum: 0

Maximum: 10000

False

When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.

esRateInPes

M2tsEsRateInPes

False

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

patInterval

integer

Minimum: 0

Maximum: 1000

False

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

dvbNitSettings

DvbNitSettings

False

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

dvbSdtSettings

DvbSdtSettings

False

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

scte35Source

M2tsScte35Source

False

For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).

scte35Pid

integer

Minimum: 32

Maximum: 8182

False

Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream.

scte35Esam

M2tsScte35Esam

False

Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

videoPid

integer

Minimum: 32

Maximum: 8182

False

Specify the packet identifier (PID) of the elementary video stream in the transport stream.

dvbTdtSettings

DvbTdtSettings

False

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

pmtInterval

integer

Minimum: 0

Maximum: 1000

False

Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream.

segmentationStyle

M2tsSegmentationStyle

False

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.

segmentationTime

number

Format: float

Minimum: 0.0

False

Specify the length, in seconds, of each segment. Required unless markers is set to _none_.

pmtPid

integer

Minimum: 32

Maximum: 8182

False

Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480.

bitrate

integer

Minimum: 0

Maximum: 2147483647

False

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

audioPids

Array of type integer

Minimum: 32

Maximum: 8182

False

Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492.

privateMetadataPid

integer

Minimum: 32

Maximum: 8182

False

Specify the packet identifier (PID) of the private metadata stream. Default is 503.

nielsenId3

M2tsNielsenId3

False

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.

timedMetadataPid

integer

Minimum: 32

Maximum: 8182

False

Specify the packet identifier (PID) for timed metadata in this output. Default is 502.

maxPcrInterval

integer

Minimum: 0

Maximum: 500

False

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

transportStreamId

integer

Minimum: 0

Maximum: 65535

False

Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.

dvbSubPids

Array of type integer

Minimum: 32

Maximum: 8182

False

Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479.

rateMode

M2tsRateMode

False

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.

audioFramesPerPes

integer

Minimum: 0

Maximum: 2147483647

False

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

pcrControl

M2tsPcrControl

False

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.

segmentationMarkers

M2tsSegmentationMarkers

False

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.

ebpAudioInterval

M2tsEbpAudioInterval

False

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

forceTsVideoEbpOrder

M2tsForceTsVideoEbpOrder

False

Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE).

programNumber

integer

Minimum: 0

Maximum: 65535

False

Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.

pcrPid

integer

Minimum: 32

Maximum: 8182

False

Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID (VideoPid).

bufferModel

M2tsBufferModel

False

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.

dvbTeletextPid

integer

Minimum: 32

Maximum: 8182

False

Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499.

fragmentTime

number

Format: float

Minimum: 0.0

False

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

ebpPlacement

M2tsEbpPlacement

False

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

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.

M3u8NielsenId3

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

M3u8PcrControl

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

  • PCR_EVERY_PES_PACKET

  • CONFIGURED_PCR_PERIOD

M3u8Scte35Source

For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml).

  • PASSTHROUGH

  • NONE

M3u8Settings

Settings for TS segments in HLS

Property Type Required Description
audioFramesPerPes

integer

Minimum: 0

Maximum: 2147483647

False

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

pcrControl

M3u8PcrControl

False

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

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.

pmtPid

integer

Minimum: 32

Maximum: 8182

False

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

privateMetadataPid

integer

Minimum: 32

Maximum: 8182

False

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

programNumber

integer

Minimum: 0

Maximum: 65535

False

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

patInterval

integer

Minimum: 0

Maximum: 1000

False

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

pmtInterval

integer

Minimum: 0

Maximum: 1000

False

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

scte35Source

M3u8Scte35Source

False

For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml).

scte35Pid

integer

Minimum: 32

Maximum: 8182

False

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

nielsenId3

M3u8NielsenId3

False

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.

timedMetadata

TimedMetadata

False

Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.

timedMetadataPid

integer

Minimum: 32

Maximum: 8182

False

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

transportStreamId

integer

Minimum: 0

Maximum: 65535

False

The value of the transport stream ID field in the Program Map Table.

videoPid

integer

Minimum: 32

Maximum: 8182

False

Packet Identifier (PID) of the elementary video stream in the transport stream.

audioPids

Array of type integer

Minimum: 32

Maximum: 8182

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.

MovClapAtom

When enabled, include 'clap' atom if appropriate for the video output settings.

  • INCLUDE

  • EXCLUDE

MovCslgAtom

When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.

  • INCLUDE

  • EXCLUDE

MovMpeg2FourCCControl

When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable when the video codec is MPEG2.

  • XDCAM

  • MPEG

MovPaddingControl

If set to OMNEON, inserts Omneon-compatible padding

  • OMNEON

  • NONE

MovReference

Always keep the default value (SELF_CONTAINED) for this setting.

  • SELF_CONTAINED

  • EXTERNAL

MovSettings

Settings for MOV Container.

Property Type Required Description
clapAtom

MovClapAtom

False

When enabled, include 'clap' atom if appropriate for the video output settings.

cslgAtom

MovCslgAtom

False

When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.

paddingControl

MovPaddingControl

False

If set to OMNEON, inserts Omneon-compatible padding

reference

MovReference

False

Always keep the default value (SELF_CONTAINED) for this setting.

mpeg2FourCCControl

MovMpeg2FourCCControl

False

When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable when the video codec is MPEG2.

Mp2Settings

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

Property Type Required Description
bitrate

integer

Minimum: 32000

Maximum: 384000

False

Specify the average bitrate in bits per second.

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.

sampleRate

integer

Minimum: 32000

Maximum: 48000

False

Sample rate in hz.

Mp4CslgAtom

When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.

  • INCLUDE

  • EXCLUDE

Mp4FreeSpaceBox

Inserts a free-space box immediately after the moov box.

  • INCLUDE

  • EXCLUDE

Mp4MoovPlacement

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

Mp4Settings

Settings for MP4 container. You can create audio-only AAC outputs with this container.

Property Type Required Description
cslgAtom

Mp4CslgAtom

False

When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.

freeSpaceBox

Mp4FreeSpaceBox

False

Inserts a free-space box immediately after the moov box.

mp4MajorBrand

string

False

Overrides the "Major Brand" field in the output file. Usually not necessary to specify.

moovPlacement

Mp4MoovPlacement

False

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.

Mpeg2AdaptiveQuantization

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

Mpeg2CodecLevel

Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output.

  • AUTO

  • LOW

  • MAIN

  • HIGH1440

  • HIGH

Mpeg2CodecProfile

Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output.

  • MAIN

  • PROFILE_422

Mpeg2DynamicSubGop

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

Mpeg2FramerateControl

If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate 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 frame rate 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 frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

Mpeg2FramerateConversionAlgorithm

When set to INTERPOLATE, produces smoother motion during frame rate conversion.

  • DUPLICATE_DROP

  • INTERPOLATE

Mpeg2GopSizeUnits

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

  • FRAMES

  • SECONDS

Mpeg2InterlaceMode

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

Mpeg2IntraDcPrecision

Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio.

  • AUTO

  • INTRA_DC_PRECISION_8

  • INTRA_DC_PRECISION_9

  • INTRA_DC_PRECISION_10

  • INTRA_DC_PRECISION_11

Mpeg2ParControl

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

Mpeg2QualityTuningLevel

Use Quality tuning level (Mpeg2QualityTuningLevel) to specifiy whether to use single-pass or multipass video encoding.

  • SINGLE_PASS

  • MULTI_PASS

Mpeg2RateControlMode

Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is variable (vbr) or constant (cbr).

  • VBR

  • CBR

Mpeg2SceneChangeDetect

Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default.

  • DISABLED

  • ENABLED

Mpeg2Settings

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

Property Type Required Description
interlaceMode

Mpeg2InterlaceMode

False

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.

parNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio numerator.

syntax

Mpeg2Syntax

False

Produces a Type D-10 compatible bitstream (SMPTE 356M-2001).

softness

integer

Minimum: 0

Maximum: 128

False

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

framerateDenominator

integer

Minimum: 1

Maximum: 1001

False

Frame rate denominator.

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.

hrdBufferInitialFillPercentage

integer

Minimum: 0

Maximum: 100

False

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

gopSize

number

Format: float

Minimum: 0.0

False

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

hrdBufferSize

integer

Minimum: 0

Maximum: 47185920

False

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

maxBitrate

integer

Minimum: 1000

Maximum: 300000000

False

Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000.

slowPal

Mpeg2SlowPal

False

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

parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

spatialAdaptiveQuantization

Mpeg2SpatialAdaptiveQuantization

False

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

temporalAdaptiveQuantization

Mpeg2TemporalAdaptiveQuantization

False

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

bitrate

integer

Minimum: 1000

Maximum: 288000000

False

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

intraDcPrecision

Mpeg2IntraDcPrecision

False

Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio.

framerateControl

Mpeg2FramerateControl

False

If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate 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 frame rate 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 frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.

rateControlMode

Mpeg2RateControlMode

False

Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is variable (vbr) or constant (cbr).

codecProfile

Mpeg2CodecProfile

False

Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output.

telecine

Mpeg2Telecine

False

Only use Telecine (Mpeg2Telecine) when you set Framerate (Framerate) to 29.970. Set Telecine (Mpeg2Telecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player.

framerateNumerator

integer

Minimum: 24

Maximum: 60000

False

Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps.

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

adaptiveQuantization

Mpeg2AdaptiveQuantization

False

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

codecLevel

Mpeg2CodecLevel

False

Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output.

sceneChangeDetect

Mpeg2SceneChangeDetect

False

Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default.

qualityTuningLevel

Mpeg2QualityTuningLevel

False

Use Quality tuning level (Mpeg2QualityTuningLevel) to specifiy whether to use single-pass or multipass video encoding.

framerateConversionAlgorithm

Mpeg2FramerateConversionAlgorithm

False

When set to INTERPOLATE, produces smoother motion during frame rate conversion.

gopSizeUnits

Mpeg2GopSizeUnits

False

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

parControl

Mpeg2ParControl

False

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.

numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

dynamicSubGop

Mpeg2DynamicSubGop

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

Mpeg2SlowPal

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

  • DISABLED

  • ENABLED

Mpeg2SpatialAdaptiveQuantization

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

  • DISABLED

  • ENABLED

Mpeg2Syntax

Produces a Type D-10 compatible bitstream (SMPTE 356M-2001).

  • DEFAULT

  • D_10

Mpeg2Telecine

Only use Telecine (Mpeg2Telecine) when you set Framerate (Framerate) to 29.970. Set Telecine (Mpeg2Telecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player.

  • NONE

  • SOFT

  • HARD

Mpeg2TemporalAdaptiveQuantization

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

  • DISABLED

  • ENABLED

NoiseReducer

Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default. When you enable Noise reducer (NoiseReducer), you must also select a value for Noise reducer filter (NoiseReducerFilter).

Property Type Required Description
filter

NoiseReducerFilter

False

Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution filtering. * Conserve does min/max noise reduction. * Spatial does frequency-domain filtering based on JND principles. * Temporal optimizes video quality for complex motion.

filterSettings

NoiseReducerFilterSettings

False

Settings for a noise reducer filter

spatialFilterSettings

NoiseReducerSpatialFilterSettings

False

Noise reducer filter settings for spatial filter.

temporalFilterSettings

NoiseReducerTemporalFilterSettings

False

Noise reducer filter settings for temporal filter.

NoiseReducerFilter

Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution filtering. * Conserve does min/max noise reduction. * Spatial does frequency-domain filtering based on JND principles. * Temporal optimizes video quality for complex motion.

  • BILATERAL

  • MEAN

  • GAUSSIAN

  • LANCZOS

  • SHARPEN

  • CONSERVE

  • SPATIAL

  • TEMPORAL

NoiseReducerFilterSettings

Settings for a noise reducer filter

Property Type Required Description
strength

integer

Minimum: 0

Maximum: 3

False

Relative strength of noise reducing filter. Higher values produce stronger filtering.

NoiseReducerSpatialFilterSettings

Noise reducer filter settings for spatial filter.

Property Type Required Description
strength

integer

Minimum: 0

Maximum: 16

False

Relative strength of noise reducing filter. Higher values produce stronger filtering.

speed

integer

Minimum: -2

Maximum: 3

False

The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 being the nominal value.

postFilterSharpenStrength

integer

Minimum: 0

Maximum: 3

False

Specify strength of post noise reduction sharpening filter, with 0 disabling the filter and 3 enabling it at maximum strength.

NoiseReducerTemporalFilterSettings

Noise reducer filter settings for temporal filter.

Property Type Required Description
strength

integer

Minimum: 0

Maximum: 16

False

Specify the strength of the noise reducing filter on this output. Higher values produce stronger filtering. We recommend the following value ranges, depending on the result that you want: * 0-2 for complexity reduction with minimal sharpness loss * 2-8 for complexity reduction with image preservation * 8-16 for a high level of complexity reduction

speed

integer

Minimum: -1

Maximum: 3

False

The speed of the filter (higher number is faster). Low setting reduces bit rate at the cost of transcode time, high setting improves transcode time at the cost of bit rate.

aggressiveMode

integer

Minimum: 0

Maximum: 4

False

Use Aggressive mode for content that has complex motion. Higher values produce stronger temporal filtering. This filters highly complex scenes more aggressively and creates better VQ for low bitrate outputs.

OutputChannelMapping

OutputChannel mapping settings.

Property Type Required Description
inputChannels

Array of type integer

Minimum: -60

Maximum: 6

False

List of input channels

OutputSdt

Selects method of inserting SDT information into output stream. "Follow input SDT" copies SDT information from input stream to output stream. "Follow input SDT if present" copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. Enter "SDT Manually" means user will enter the SDT information. "No SDT" means output stream will not contain SDT information.

  • SDT_FOLLOW

  • SDT_FOLLOW_IF_PRESENT

  • SDT_MANUAL

  • SDT_NONE

Preset

A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.

Property Type Required Description
arn

string

False

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

createdAt

string

Format: date-time

False

The timestamp in epoch seconds for preset creation.

lastUpdated

string

Format: date-time

False

The timestamp in epoch seconds when the preset was last updated.

description

string

False

An optional description you create for each preset.

category

string

False

An optional category you create to organize your presets.

name

string

True

A name you create for each preset. Each name must be unique within your account.

type

Type

False

A preset can be of two types: system or custom. System or built-in preset can't be modified or deleted by the user.

settings

PresetSettings

True

Settings for preset

PresetSettings

Settings for preset

Property Type Required Description
videoDescription

VideoDescription

False

(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec that you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output.

audioDescriptions

Array of type AudioDescription

False

(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.

containerSettings

ContainerSettings

False

Container specific settings.

captionDescriptions

Array of type CaptionDescriptionPreset

False

Caption settings for this preset. There can be multiple caption settings in a single output.

ProresCodecProfile

Use Profile (ProResCodecProfile) to specifiy the type of Apple ProRes codec to use for this output.

  • APPLE_PRORES_422

  • APPLE_PRORES_422_HQ

  • APPLE_PRORES_422_LT

  • APPLE_PRORES_422_PROXY

ProresFramerateControl

If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate 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 frame rate 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 frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

ProresFramerateConversionAlgorithm

When set to INTERPOLATE, produces smoother motion during frame rate conversion.

  • DUPLICATE_DROP

  • INTERPOLATE

ProresInterlaceMode

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

ProresParControl

Use (ProresParControl) to specify how the service determines the pixel aspect ratio. Set to Follow source (INITIALIZE_FROM_SOURCE) to use the pixel aspect ratio from the input. To specify a different pixel aspect ratio: Using the console, choose it from the dropdown menu. Using the API, set ProresParControl to (SPECIFIED) and provide for (ParNumerator) and (ParDenominator).

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

ProresSettings

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

Property Type Required Description
interlaceMode

ProresInterlaceMode

False

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.

parNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio numerator.

framerateDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Frame rate denominator.

codecProfile

ProresCodecProfile

False

Use Profile (ProResCodecProfile) to specifiy the type of Apple ProRes codec to use for this output.

slowPal

ProresSlowPal

False

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

parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

framerateControl

ProresFramerateControl

False

If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate 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 frame rate 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 frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.

telecine

ProresTelecine

False

Only use Telecine (ProresTelecine) when you set Framerate (Framerate) to 29.970. Set Telecine (ProresTelecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player.

framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator.

framerateConversionAlgorithm

ProresFramerateConversionAlgorithm

False

When set to INTERPOLATE, produces smoother motion during frame rate conversion.

parControl

ProresParControl

False

Use (ProresParControl) to specify how the service determines the pixel aspect ratio. Set to Follow source (INITIALIZE_FROM_SOURCE) to use the pixel aspect ratio from the input. To specify a different pixel aspect ratio: Using the console, choose it from the dropdown menu. Using the API, set ProresParControl to (SPECIFIED) and provide for (ParNumerator) and (ParDenominator).

ProresSlowPal

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

  • DISABLED

  • ENABLED

ProresTelecine

Only use Telecine (ProresTelecine) when you set Framerate (Framerate) to 29.970. Set Telecine (ProresTelecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player.

  • NONE

  • HARD

Rectangle

Use Rectangle to identify a specific area of the video frame.

Property Type Required Description
height

integer

Minimum: 2

Maximum: 2147483647

False

Height of rectangle in pixels. Specify only even numbers.

width

integer

Minimum: 2

Maximum: 2147483647

False

Width of rectangle in pixels. Specify only even numbers.

x

integer

Minimum: 0

Maximum: 2147483647

False

The distance, in pixels, between the rectangle and the left edge of the video frame. Specify only even numbers.

y

integer

Minimum: 0

Maximum: 2147483647

False

The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers.

RemixSettings

Use Manual audio remixing (RemixSettings) to adjust audio levels for each audio channel in each output of your job. With audio remixing, you can output more or fewer audio channels than your input audio source provides.

Property Type Required Description
channelMapping

ChannelMapping

False

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

channelsIn

integer

Minimum: 1

Maximum: 64

False

Specify the number of audio channels from your input that you want to use in your output. With remixing, you might combine or split the data in these channels, so the number of channels in your final output might be different.

channelsOut

integer

Minimum: 1

Maximum: 64

False

Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8... 64. (1 and even numbers to 64.)

RespondToAfd

Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

  • NONE

  • RESPOND

  • PASSTHROUGH

ScalingBehavior

Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

  • DEFAULT

  • STRETCH_TO_OUTPUT

SccDestinationFramerate

Set Framerate (SccDestinationFramerate) to make sure that the captions and the video are synchronized in the output. Specify a frame rate that matches the frame rate of the associated video. If the video frame rate is 29.97, choose 29.97 dropframe (FRAMERATE_29_97_DROPFRAME) only if the video has video_insertion=true and drop_frame_timecode=true; otherwise, choose 29.97 non-dropframe (FRAMERATE_29_97_NON_DROPFRAME).

  • FRAMERATE_23_97

  • FRAMERATE_24

  • FRAMERATE_29_97_DROPFRAME

  • FRAMERATE_29_97_NON_DROPFRAME

SccDestinationSettings

Settings for SCC caption output.

Property Type Required Description
framerate

SccDestinationFramerate

False

Set Framerate (SccDestinationFramerate) to make sure that the captions and the video are synchronized in the output. Specify a frame rate that matches the frame rate of the associated video. If the video frame rate is 29.97, choose 29.97 dropframe (FRAMERATE_29_97_DROPFRAME) only if the video has video_insertion=true and drop_frame_timecode=true; otherwise, choose 29.97 non-dropframe (FRAMERATE_29_97_NON_DROPFRAME).

TeletextDestinationSettings

Settings for Teletext caption output

Property Type Required Description
pageNumber

string

Pattern: ^[1-8][0-9a-fA-F][0-9a-eA-E]$

MinLength: 3

MaxLength: 3

False

Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of Teletext data, do not use this field.

pageTypes

Array of type TeletextPageType

False

Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type to the default value Subtitle (PAGE_TYPE_SUBTITLE). If you pass through the entire set of Teletext data, don't use this field. When you pass through a set of Teletext pages, your output has the same page types as your input.

TeletextPageType

A page type as defined in the standard ETSI EN 300 468, Table 94

  • PAGE_TYPE_INITIAL

  • PAGE_TYPE_SUBTITLE

  • PAGE_TYPE_ADDL_INFO

  • PAGE_TYPE_PROGRAM_SCHEDULE

  • PAGE_TYPE_HEARING_IMPAIRED_SUBTITLE

TimecodeBurnin

Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output.

Property Type Required Description
fontSize

integer

Minimum: 10

Maximum: 48

False

Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid values are 10, 16, 32, 48.

position

TimecodeBurninPosition

False

Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify the location the burned-in timecode on output video.

prefix

string

Pattern: ^[ -~]+$

False

Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. For example, a prefix of "EZ-" will result in the timecode "EZ-00:00:00:00". Provide either the characters themselves or the ASCII code equivalents. The supported range of characters is 0x20 through 0x7e. This includes letters, numbers, and all special characters represented on a standard English keyboard.

TimecodeBurninPosition

Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify the location the burned-in timecode on output video.

  • TOP_CENTER

  • TOP_LEFT

  • TOP_RIGHT

  • MIDDLE_LEFT

  • MIDDLE_CENTER

  • MIDDLE_RIGHT

  • BOTTOM_LEFT

  • BOTTOM_CENTER

  • BOTTOM_RIGHT

TimedMetadata

Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.

  • PASSTHROUGH

  • NONE

TtmlDestinationSettings

Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).

Property Type Required Description
stylePassthrough

TtmlStylePassthrough

False

Pass through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.

TtmlStylePassthrough

Pass through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.

  • ENABLED

  • DISABLED

Type

  • SYSTEM

  • CUSTOM

UpdatePresetRequest

Modify a preset by sending a request with the preset name and any of the following that you wish to change: description, category, and transcoding settings.

Property Type Required Description
description

string

False

The new description for the preset, if you are changing it.

category

string

False

The new category for the preset, if you are changing it.

name

string

False

The name of the preset you are modifying.

settings

PresetSettings

False

Settings for preset

UpdatePresetResponse

Successful update preset requests will return the new preset JSON.

Property Type Required Description
preset

Preset

False

A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.

VideoCodec

Type of video codec

  • FRAME_CAPTURE

  • H_264

  • H_265

  • MPEG2

  • PRORES

VideoCodecSettings

Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings

Property Type Required Description
codec

VideoCodec

False

Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec.

frameCaptureSettings

FrameCaptureSettings

False

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

h264Settings

H264Settings

False

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

h265Settings

H265Settings

False

Settings for H265 codec

mpeg2Settings

Mpeg2Settings

False

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

proresSettings

ProresSettings

False

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

VideoDescription

Settings for video outputs

Property Type Required Description
fixedAfd

integer

Minimum: 0

Maximum: 15

False

Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.

width

integer

Minimum: 32

Maximum: 4096

False

Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width.

scalingBehavior

ScalingBehavior

False

Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.

crop

Rectangle

False

Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.

height

integer

Minimum: 32

Maximum: 4096

False

Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.

videoPreprocessors

VideoPreprocessor

False

Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

timecodeInsertion

VideoTimecodeInsertion

False

Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

antiAlias

AntiAlias

False

The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.

position

Rectangle

False

Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.

sharpness

integer

Minimum: 0

Maximum: 100

False

Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

codecSettings

VideoCodecSettings

False

Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings

afdSignaling

AfdSignaling

False

This setting only applies to H.264, H.265, 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.

dropFrameTimecode

DropFrameTimecode

False

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.

respondToAfd

RespondToAfd

False

Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.

colorMetadata

ColorMetadata

False

Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.

VideoPreprocessor

Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default.

Property Type Required Description
colorCorrector

ColorCorrector

False

Enable the Color corrector (ColorCorrector) feature if necessary. Enable or disable this feature for each output individually. This setting is disabled by default.

deinterlacer

Deinterlacer

False

Use Deinterlacer (Deinterlacer) to produce smoother motion and a clearer picture.

imageInserter

ImageInserter

False

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.

noiseReducer

NoiseReducer

False

Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default.

timecodeBurnin

TimecodeBurnin

False

Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output.

VideoTimecodeInsertion

Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.

  • DISABLED

  • PIC_TIMING_SEI

WavFormat

The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size, or if you otherwise need the extended support of the RF64 format, set your output WAV file format to RF64.

  • RIFF

  • RF64

WavSettings

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

Property Type Required Description
bitDepth

integer

Minimum: 16

Maximum: 24

False

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

channels

integer

Minimum: 1

Maximum: 64

False

Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64.

sampleRate

integer

Minimum: 8000

Maximum: 192000

False

Sample rate in Hz.

format

WavFormat

False

The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size, or if you otherwise need the extended support of the RF64 format, set your output WAV file format to RF64.

See Also

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

GetPreset

UpdatePreset

DeletePreset