AWS Elemental MediaConvert API Reference
API Reference

Presets

URI

/2017-08-29/presets

HTTP Methods

GET

Operation ID: ListPresets

Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array.

Query Parameters

Name Type Required Description
listBy String False
nextToken String False
maxResults String False
order String False

Responses

Status Code Response Model Description
200 ListPresetsResponse

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.

See Also

POST

Operation ID: CreatePreset

Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Responses

Status Code Response Model Description
201 CreatePresetResponse

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

See Also

Schemas

Request Bodies

Example GET

{ "listBy": enum, "category": "string", "order": enum, "nextToken": "string", "maxResults": integer }

Example POST

{ "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 } }, "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 }, "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, "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, "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, "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, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string" }, "ttmlDestinationSettings": { "stylePassthrough": enum } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] }, "tags": { } }

Response Bodies

Example ListPresetsResponse

{ "presets": [ { "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 } }, "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 }, "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, "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, "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, "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, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string" }, "ttmlDestinationSettings": { "stylePassthrough": enum } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } } ], "nextToken": "string" }

Example CreatePresetResponse

{ "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 } }, "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 }, "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, "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, "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, "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, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string" }, "ttmlDestinationSettings": { "stylePassthrough": enum } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } } }

Example ExceptionBody

{ "message": "string" }

Properties

AacAudioDescriptionBroadcasterMix (enum)

Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType.

  • BROADCASTER_MIXED_AD

  • NORMAL

AacCodecProfile (enum)

AAC Profile.

  • LC

  • HEV1

  • HEV2

AacCodingMode (enum)

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

  • AD_RECEIVER_MIX

  • CODING_MODE_1_0

  • CODING_MODE_1_1

  • CODING_MODE_2_0

  • CODING_MODE_5_1

AacRateControlMode (enum)

Rate Control Mode.

  • CBR

  • VBR

AacRawFormat (enum)

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

  • LATM_LOAS

  • NONE

AacSettings

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

Property Type Required Description
audioDescriptionBroadcasterMix

string

False
vbrQuality

string

False
bitrate

integer

Minimum: 6000

Maximum: 1024000

False

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

rateControlMode

string

False
codecProfile

string

False
codingMode

string

False
rawFormat

string

False
sampleRate

integer

Minimum: 8000

Maximum: 96000

False

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

specification

string

False

See Also

AacSpecification (enum)

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

  • MPEG2

  • MPEG4

AacVbrQuality (enum)

VBR Quality Level - Only used if rate_control_mode is VBR.

  • LOW

  • MEDIUM_LOW

  • MEDIUM_HIGH

  • HIGH

Ac3BitstreamMode (enum)

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

  • COMPLETE_MAIN

  • COMMENTARY

  • DIALOGUE

  • EMERGENCY

  • HEARING_IMPAIRED

  • MUSIC_AND_EFFECTS

  • VISUALLY_IMPAIRED

  • VOICE_OVER

Ac3CodingMode (enum)

Dolby Digital coding mode. Determines number of channels.

  • CODING_MODE_1_0

  • CODING_MODE_1_1

  • CODING_MODE_2_0

  • CODING_MODE_3_2_LFE

Ac3DynamicRangeCompressionProfile (enum)

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

  • FILM_STANDARD

  • NONE

Ac3LfeFilter (enum)

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

  • ENABLED

  • DISABLED

Ac3MetadataControl (enum)

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

  • FOLLOW_INPUT

  • USE_CONFIGURED

Ac3Settings

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

Property Type Required Description
bitrate

integer

Minimum: 64000

Maximum: 640000

False

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

bitstreamMode

string

False
codingMode

string

False
dialnorm

integer

Minimum: 1

Maximum: 31

False

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

dynamicRangeCompressionProfile

string

False
metadataControl

string

False
lfeFilter

string

False
sampleRate

integer

Minimum: 48000

Maximum: 48000

False

Sample rate in hz. Sample rate is always 48000.

See Also

AfdSignaling (enum)

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

Maximum: 192000

False

Sample rate in hz.

See Also

AntiAlias (enum)

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

  • DISABLED

  • ENABLED

AudioCodec (enum)

Type of Audio codec.

  • AAC

  • MP2

  • WAV

  • AIFF

  • AC3

  • EAC3

  • PASSTHROUGH

AudioCodecSettings

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

Property Type Required Description
codec

string

False
aacSettings

AacSettings

False
ac3Settings

Ac3Settings

False
aiffSettings

AiffSettings

False
eac3Settings

Eac3Settings

False
mp2Settings

Mp2Settings

False
wavSettings

WavSettings

False

See Also

AudioDescription

Description of audio output

Property Type Required Description
audioTypeControl

string

False
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
codecSettings

AudioCodecSettings

False
remixSettings

RemixSettings

False

Advanced audio remixing settings.

streamName

string

Pattern: ^[\w\s]*$

False

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

languageCodeControl

string

False
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}$

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

string

False

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

See Also

AudioLanguageCodeControl (enum)

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

  • FOLLOW_INPUT

  • USE_CONFIGURED

AudioNormalizationAlgorithm (enum)

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

  • ITU_BS_1770_1

  • ITU_BS_1770_2

AudioNormalizationAlgorithmControl (enum)

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

  • CORRECT_AUDIO

  • MEASURE_ONLY

AudioNormalizationLoudnessLogging (enum)

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

  • LOG

  • DONT_LOG

AudioNormalizationPeakCalculation (enum)

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

  • TRUE_PEAK

  • NONE

AudioNormalizationSettings

Advanced audio normalization settings.

Property Type Required Description
algorithm

string

False
algorithmControl

string

False
correctionGateLevel

integer

Minimum: -70

Maximum: 0

False

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

loudnessLogging

string

False
targetLkfs

number

Format: float

Minimum: -59.0

Maximum: 0.0

False

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

peakCalculation

string

False

See Also

AudioTypeControl (enum)

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

  • FOLLOW_INPUT

  • USE_CONFIGURED

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

string

False
alignment

string

False
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

string

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

fontColor

string

False
backgroundColor

string

False
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

string

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

See Also

BurninSubtitleAlignment (enum)

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

  • CENTERED

  • LEFT

BurninSubtitleBackgroundColor (enum)

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

  • NONE

  • BLACK

  • WHITE

BurninSubtitleFontColor (enum)

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

  • WHITE

  • BLACK

  • YELLOW

  • RED

  • GREEN

  • BLUE

BurninSubtitleOutlineColor (enum)

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

  • BLACK

  • WHITE

  • YELLOW

  • RED

  • GREEN

  • BLUE

BurninSubtitleShadowColor (enum)

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

  • NONE

  • BLACK

  • WHITE

BurninSubtitleTeletextSpacing (enum)

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

  • FIXED_GRID

  • PROPORTIONAL

CaptionDescriptionPreset

Caption Description for preset

Property Type Required Description
destinationSettings

CaptionDestinationSettings

False
customLanguageCode

string

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

False

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

languageCode

string

False

Indicates the language of the caption output track.

languageDescription

string

Pattern: ^[\w ]*$

False

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

See Also

CaptionDestinationSettings

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

Property Type Required Description
destinationType

string

False
burninDestinationSettings

BurninDestinationSettings

False
dvbSubDestinationSettings

DvbSubDestinationSettings

False
sccDestinationSettings

SccDestinationSettings

False
teletextDestinationSettings

TeletextDestinationSettings

False
ttmlDestinationSettings

TtmlDestinationSettings

False

See Also

CaptionDestinationType (enum)

Type of Caption output, including Burn-In, Embedded (with or without SCTE20), SCC, SMI, SRT, TTML, WebVTT, DVB-Sub, Teletext.

  • BURN_IN

  • DVB_SUB

  • EMBEDDED

  • EMBEDDED_PLUS_SCTE20

  • 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

See Also

ColorCorrector

Settings for color correction.

Property Type Required Description
brightness

integer

Minimum: 1

Maximum: 100

False

Brightness level.

colorSpaceConversion

string

False
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

See Also

ColorMetadata (enum)

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

  • IGNORE

  • INSERT

ColorSpaceConversion (enum)

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

  • NONE

  • FORCE_601

  • FORCE_709

  • FORCE_HDR10

  • FORCE_HLG_2020

ContainerSettings

Container specific settings.

Property Type Required Description
container

string

False
m3u8Settings

M3u8Settings

False
f4vSettings

F4vSettings

False
m2tsSettings

M2tsSettings

False
movSettings

MovSettings

False
mp4Settings

Mp4Settings

False

See Also

ContainerType (enum)

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

  • F4V

  • ISMV

  • M2TS

  • M3U8

  • CMFC

  • MOV

  • MP4

  • MPD

  • MXF

  • RAW

CreatePresetRequest

Send your create preset request with the name of the preset and the JSON for the output settings specified by the preset.

Property Type Required Description
description

string

False

Optional. A description of the preset you are creating.

category

string

False

Optional. A category for the preset you are creating.

name

string

True

The name of the preset you are creating.

settings

PresetSettings

True
tags

object

False

The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

See Also

CreatePresetResponse

Successful create preset requests will return the preset JSON.

Property Type Required Description
preset

Preset

False

See Also

DeinterlaceAlgorithm (enum)

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

  • INTERPOLATE

  • INTERPOLATE_TICKER

  • BLEND

  • BLEND_TICKER

Deinterlacer

Settings for deinterlacer

Property Type Required Description
algorithm

string

False
mode

string

False
control

string

False

See Also

DeinterlacerControl (enum)

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

  • FORCE_ALL_FRAMES

  • NORMAL

DeinterlacerMode (enum)

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

  • DEINTERLACE

  • INVERSE_TELECINE

  • ADAPTIVE

DropFrameTimecode (enum)

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

  • DISABLED

  • ENABLED

DvbNitSettings

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

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

False

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

See Also

DvbSdtSettings

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

Property Type Required Description
outputSdt

string

False
sdtInterval

integer

Minimum: 25

Maximum: 2000

False

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

serviceName

string

False

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

serviceProviderName

string

False

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

See Also

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

string

False
alignment

string

False
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

string

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

fontColor

string

False
backgroundColor

string

False
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

string

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

See Also

DvbSubtitleAlignment (enum)

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

  • CENTERED

  • LEFT

DvbSubtitleBackgroundColor (enum)

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

  • NONE

  • BLACK

  • WHITE

DvbSubtitleFontColor (enum)

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

  • WHITE

  • BLACK

  • YELLOW

  • RED

  • GREEN

  • BLUE

DvbSubtitleOutlineColor (enum)

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

  • BLACK

  • WHITE

  • YELLOW

  • RED

  • GREEN

  • BLUE

DvbSubtitleShadowColor (enum)

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

  • NONE

  • BLACK

  • WHITE

DvbSubtitleTeletextSpacing (enum)

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

  • FIXED_GRID

  • PROPORTIONAL

DvbTdtSettings

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

Property Type Required Description
tdtInterval

integer

Minimum: 1000

Maximum: 30000

False

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

See Also

Eac3AttenuationControl (enum)

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

  • ATTENUATE_3_DB

  • NONE

Eac3BitstreamMode (enum)

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

  • COMPLETE_MAIN

  • COMMENTARY

  • EMERGENCY

  • HEARING_IMPAIRED

  • VISUALLY_IMPAIRED

Eac3CodingMode (enum)

Dolby Digital Plus coding mode. Determines number of channels.

  • CODING_MODE_1_0

  • CODING_MODE_2_0

  • CODING_MODE_3_2

Eac3DcFilter (enum)

Activates a DC highpass filter for all input channels.

  • ENABLED

  • DISABLED

Eac3DynamicRangeCompressionLine (enum)

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

  • NONE

  • FILM_STANDARD

  • FILM_LIGHT

  • MUSIC_STANDARD

  • MUSIC_LIGHT

  • SPEECH

Eac3DynamicRangeCompressionRf (enum)

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

  • NONE

  • FILM_STANDARD

  • FILM_LIGHT

  • MUSIC_STANDARD

  • MUSIC_LIGHT

  • SPEECH

Eac3LfeControl (enum)

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

  • LFE

  • NO_LFE

Eac3LfeFilter (enum)

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

  • ENABLED

  • DISABLED

Eac3MetadataControl (enum)

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

  • FOLLOW_INPUT

  • USE_CONFIGURED

Eac3PassthroughControl (enum)

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

  • WHEN_POSSIBLE

  • NO_PASSTHROUGH

Eac3PhaseControl (enum)

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

  • SHIFT_90_DEGREES

  • NO_SHIFT

Eac3Settings

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

Property Type Required Description
metadataControl

string

False
surroundExMode

string

False
loRoSurroundMixLevel

number

Format: float

Minimum: -60.0

Maximum: -1.5

False

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

phaseControl

string

False
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

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

bitrate

integer

Minimum: 64000

Maximum: 640000

False

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

ltRtCenterMixLevel

number

Format: float

Minimum: -60.0

Maximum: 3.0

False

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

passthroughControl

string

False
lfeControl

string

False
loRoCenterMixLevel

number

Format: float

Minimum: -60.0

Maximum: 3.0

False

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

attenuationControl

string

False
codingMode

string

False
surroundMode

string

False
bitstreamMode

string

False
lfeFilter

string

False
stereoDownmix

string

False
dynamicRangeCompressionRf

string

False
sampleRate

integer

Minimum: 48000

Maximum: 48000

False

Sample rate in hz. Sample rate is always 48000.

dynamicRangeCompressionLine

string

False
dcFilter

string

False

See Also

Eac3StereoDownmix (enum)

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

  • NOT_INDICATED

  • LO_RO

  • LT_RT

  • DPL2

Eac3SurroundExMode (enum)

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

  • NOT_INDICATED

  • ENABLED

  • DISABLED

Eac3SurroundMode (enum)

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

  • NOT_INDICATED

  • ENABLED

  • DISABLED

ExceptionBody

Property Type Required Description
message

string

False

See Also

F4vMoovPlacement (enum)

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

  • PROGRESSIVE_DOWNLOAD

  • NORMAL

F4vSettings

Settings for F4v container

Property Type Required Description
moovPlacement

string

False

See Also

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.

See Also

H264AdaptiveQuantization (enum)

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

  • HIGHER

  • MAX

H264CodecLevel (enum)

H.264 Level.

  • AUTO

  • LEVEL_1

  • LEVEL_1_1

  • LEVEL_1_2

  • LEVEL_1_3

  • LEVEL_2

  • LEVEL_2_1

  • LEVEL_2_2

  • LEVEL_3

  • LEVEL_3_1

  • LEVEL_3_2

  • LEVEL_4

  • LEVEL_4_1

  • LEVEL_4_2

  • LEVEL_5

  • LEVEL_5_1

  • LEVEL_5_2

H264CodecProfile (enum)

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

  • BASELINE

  • HIGH

  • HIGH_10BIT

  • HIGH_422

  • HIGH_422_10BIT

  • MAIN

H264DynamicSubGop (enum)

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

  • ADAPTIVE

  • STATIC

H264EntropyEncoding (enum)

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

  • CABAC

  • CAVLC

H264FieldEncoding (enum)

Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.

  • PAFF

  • FORCE_FIELD

H264FlickerAdaptiveQuantization (enum)

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

  • DISABLED

  • ENABLED

H264FramerateControl (enum)

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264FramerateConversionAlgorithm (enum)

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

  • DUPLICATE_DROP

  • INTERPOLATE

H264GopBReference (enum)

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

  • DISABLED

  • ENABLED

H264GopSizeUnits (enum)

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

  • FRAMES

  • SECONDS

H264InterlaceMode (enum)

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

  • PROGRESSIVE

  • TOP_FIELD

  • BOTTOM_FIELD

  • FOLLOW_TOP_FIELD

  • FOLLOW_BOTTOM_FIELD

H264ParControl (enum)

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264QualityTuningLevel (enum)

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

  • SINGLE_PASS

  • SINGLE_PASS_HQ

  • MULTI_PASS_HQ

H264QvbrSettings

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

Property Type Required Description
qvbrQualityLevel

integer

Minimum: 1

Maximum: 10

False

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

maxAverageBitrate

integer

Minimum: 1000

Maximum: 1152000000

False

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

See Also

H264RateControlMode (enum)

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

  • VBR

  • CBR

  • QVBR

H264RepeatPps (enum)

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

  • DISABLED

  • ENABLED

H264SceneChangeDetect (enum)

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

  • DISABLED

  • ENABLED

H264Settings

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

Property Type Required Description
interlaceMode

string

False
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

string

False
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 framerate conversion, specify the framerate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use framerate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.

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

string

False
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

string

False
parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

spatialAdaptiveQuantization

string

False
temporalAdaptiveQuantization

string

False
flickerAdaptiveQuantization

string

False
entropyEncoding

string

False
bitrate

integer

Minimum: 1000

Maximum: 1152000000

False

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

framerateControl

string

False
rateControlMode

string

False
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

string

False
telecine

string

False
framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Framerate numerator - framerate 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

string

False
codecLevel

string

False
fieldEncoding

string

False
sceneChangeDetect

string

False
qualityTuningLevel

string

False
framerateConversionAlgorithm

string

False
unregisteredSeiTimecode

string

False
gopSizeUnits

string

False
parControl

string

False
numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

repeatPps

string

False
dynamicSubGop

string

False

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

See Also

H264SlowPal (enum)

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

  • DISABLED

  • ENABLED

H264SpatialAdaptiveQuantization (enum)

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

  • DISABLED

  • ENABLED

H264Syntax (enum)

Produces a bitstream compliant with SMPTE RP-2027.

  • DEFAULT

  • RP2027

H264Telecine (enum)

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

  • NONE

  • SOFT

  • HARD

H264TemporalAdaptiveQuantization (enum)

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

  • DISABLED

  • ENABLED

H264UnregisteredSeiTimecode (enum)

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

  • DISABLED

  • ENABLED

H265AdaptiveQuantization (enum)

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

  • HIGHER

  • MAX

H265AlternateTransferFunctionSei (enum)

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

  • DISABLED

  • ENABLED

H265CodecLevel (enum)

H.265 Level.

  • AUTO

  • LEVEL_1

  • LEVEL_2

  • LEVEL_2_1

  • LEVEL_3

  • LEVEL_3_1

  • LEVEL_4

  • LEVEL_4_1

  • LEVEL_5

  • LEVEL_5_1

  • LEVEL_5_2

  • LEVEL_6

  • LEVEL_6_1

  • LEVEL_6_2

H265CodecProfile (enum)

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

  • MAIN_MAIN

  • MAIN_HIGH

  • MAIN10_MAIN

  • MAIN10_HIGH

  • MAIN_422_8BIT_MAIN

  • MAIN_422_8BIT_HIGH

  • MAIN_422_10BIT_MAIN

  • MAIN_422_10BIT_HIGH

H265DynamicSubGop (enum)

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

  • ADAPTIVE

  • STATIC

H265FlickerAdaptiveQuantization (enum)

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

  • DISABLED

  • ENABLED

H265FramerateControl (enum)

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H265FramerateConversionAlgorithm (enum)

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

  • DUPLICATE_DROP

  • INTERPOLATE

H265GopBReference (enum)

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

  • DISABLED

  • ENABLED

H265GopSizeUnits (enum)

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

  • FRAMES

  • SECONDS

H265InterlaceMode (enum)

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

  • PROGRESSIVE

  • TOP_FIELD

  • BOTTOM_FIELD

  • FOLLOW_TOP_FIELD

  • FOLLOW_BOTTOM_FIELD

H265ParControl (enum)

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H265QualityTuningLevel (enum)

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

  • SINGLE_PASS

  • SINGLE_PASS_HQ

  • MULTI_PASS_HQ

H265QvbrSettings

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

Property Type Required Description
qvbrQualityLevel

integer

Minimum: 1

Maximum: 10

False

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

maxAverageBitrate

integer

Minimum: 1000

Maximum: 1466400000

False

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

See Also

H265RateControlMode (enum)

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

  • VBR

  • CBR

  • QVBR

H265SampleAdaptiveOffsetFilterMode (enum)

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

  • DEFAULT

  • ADAPTIVE

  • OFF

H265SceneChangeDetect (enum)

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

  • DISABLED

  • ENABLED

H265Settings

Settings for H265 codec

Property Type Required Description
interlaceMode

string

False
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

Framerate 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

string

False
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

string

False
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

string

False
parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

spatialAdaptiveQuantization

string

False
temporalAdaptiveQuantization

string

False
flickerAdaptiveQuantization

string

False
bitrate

integer

Minimum: 1000

Maximum: 1466400000

False

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

framerateControl

string

False
rateControlMode

string

False
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

string

False
tiles

string

False
telecine

string

False
framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Framerate numerator - framerate 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

string

False
codecLevel

string

False
sceneChangeDetect

string

False
qualityTuningLevel

string

False
framerateConversionAlgorithm

string

False
unregisteredSeiTimecode

string

False
gopSizeUnits

string

False
parControl

string

False
numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

temporalIds

string

False
sampleAdaptiveOffsetFilterMode

string

False
writeMp4PackagingType

string

False
dynamicSubGop

string

False

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

See Also

H265SlowPal (enum)

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

  • DISABLED

  • ENABLED

H265SpatialAdaptiveQuantization (enum)

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

  • DISABLED

  • ENABLED

H265Telecine (enum)

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

  • NONE

  • SOFT

  • HARD

H265TemporalAdaptiveQuantization (enum)

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

  • DISABLED

  • ENABLED

H265TemporalIds (enum)

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

  • DISABLED

  • ENABLED

H265Tiles (enum)

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

  • DISABLED

  • ENABLED

H265UnregisteredSeiTimecode (enum)

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

  • DISABLED

  • ENABLED

H265WriteMp4PackagingType (enum)

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

  • HVC1

  • HEV1

Hdr10Metadata

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

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

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.

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

See Also

ImageInserter

Enable the Image inserter (ImageInserter) 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.

See Also

InsertableImage

Settings that specify how your 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

Use Left (ImageX) to set 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

Use Top (ImageY) to set 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

Set the time, in milliseconds, for the image to remain on the output video.

fadeIn

integer

Minimum: 0

Maximum: 2147483647

False

Set 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)$

False

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

startTime

string

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

False

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

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.

See Also

LanguageCode (enum)

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

  • ENG

  • SPA

  • FRA

  • DEU

  • GER

  • ZHO

  • ARA

  • HIN

  • JPN

  • RUS

  • POR

  • ITA

  • URD

  • VIE

  • KOR

  • PAN

  • ABK

  • AAR

  • AFR

  • AKA

  • SQI

  • AMH

  • ARG

  • HYE

  • ASM

  • AVA

  • AVE

  • AYM

  • AZE

  • BAM

  • BAK

  • EUS

  • BEL

  • BEN

  • BIH

  • BIS

  • BOS

  • BRE

  • BUL

  • MYA

  • CAT

  • KHM

  • CHA

  • CHE

  • NYA

  • CHU

  • CHV

  • COR

  • COS

  • CRE

  • HRV

  • CES

  • DAN

  • DIV

  • NLD

  • DZO

  • ENM

  • EPO

  • EST

  • EWE

  • FAO

  • FIJ

  • FIN

  • FRM

  • FUL

  • GLA

  • GLG

  • LUG

  • KAT

  • ELL

  • GRN

  • GUJ

  • HAT

  • HAU

  • HEB

  • HER

  • HMO

  • HUN

  • ISL

  • IDO

  • IBO

  • IND

  • INA

  • ILE

  • IKU

  • IPK

  • GLE

  • JAV

  • KAL

  • KAN

  • KAU

  • KAS

  • KAZ

  • KIK

  • KIN

  • KIR

  • KOM

  • KON

  • KUA

  • KUR

  • LAO

  • LAT

  • LAV

  • LIM

  • LIN

  • LIT

  • LUB

  • LTZ

  • MKD

  • MLG

  • MSA

  • MAL

  • MLT

  • GLV

  • MRI

  • MAR

  • MAH

  • MON

  • NAU

  • NAV

  • NDE

  • NBL

  • NDO

  • NEP

  • SME

  • NOR

  • NOB

  • NNO

  • OCI

  • OJI

  • ORI

  • ORM

  • OSS

  • PLI

  • FAS

  • POL

  • PUS

  • QUE

  • QAA

  • RON

  • ROH

  • RUN

  • SMO

  • SAG

  • SAN

  • SRD

  • SRB

  • SNA

  • III

  • SND

  • SIN

  • SLK

  • SLV

  • SOM

  • SOT

  • SUN

  • SWA

  • SSW

  • SWE

  • TGL

  • TAH

  • TGK

  • TAM

  • TAT

  • TEL

  • THA

  • BOD

  • TIR

  • TON

  • TSO

  • TSN

  • TUR

  • TUK

  • TWI

  • UIG

  • UKR

  • UZB

  • VEN

  • VOL

  • WLN

  • CYM

  • FRY

  • WOL

  • XHO

  • YID

  • YOR

  • ZHA

  • ZUL

  • ORJ

  • QPC

  • TNG

ListPresetsRequest

You can send list presets requests with an empty body. Optionally, you can filter the response by category by specifying it in your request body. You can also optionally specify the maximum number, up to twenty, of queues to be returned.

Property Type Required Description
listBy

string

False
category

string

False

Optionally, specify a preset category to limit responses to only presets from that category.

order

string

False
nextToken

string

False

Use this string, provided with the response to a previous request, to request the next batch of presets.

maxResults

integer

Format: int32

Minimum: 1

Maximum: 20

False

Optional. Number of presets, up to twenty, that will be returned at one time

See Also

ListPresetsResponse

Successful list presets requests return a JSON array of presets. If you don't specify how they are ordered, you will receive them alphabetically by name.

Property Type Required Description
presets

Array of type Preset

False

List of presets

nextToken

string

False

Use this string to request the next batch of presets.

See Also

M2tsAudioBufferModel (enum)

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

  • DVB

  • ATSC

M2tsBufferModel (enum)

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

  • MULTIPLEX

  • NONE

M2tsEbpAudioInterval (enum)

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

  • VIDEO_AND_FIXED_INTERVALS

  • VIDEO_INTERVAL

M2tsEbpPlacement (enum)

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

  • VIDEO_AND_AUDIO_PIDS

  • VIDEO_PID

M2tsEsRateInPes (enum)

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

  • INCLUDE

  • EXCLUDE

M2tsNielsenId3 (enum)

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

  • INSERT

  • NONE

M2tsPcrControl (enum)

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

  • PCR_EVERY_PES_PACKET

  • CONFIGURED_PCR_PERIOD

M2tsRateMode (enum)

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

  • VBR

  • CBR

M2tsScte35Source (enum)

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

  • PASSTHROUGH

  • NONE

M2tsSegmentationMarkers (enum)

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

  • NONE

  • RAI_SEGSTART

  • RAI_ADAPT

  • PSI_SEGSTART

  • EBP

  • EBP_LEGACY

M2tsSegmentationStyle (enum)

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

  • MAINTAIN_CADENCE

  • RESET_CADENCE

M2tsSettings

Settings for M2TS Container.

Property Type Required Description
audioBufferModel

string

False
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

string

False
patInterval

integer

Minimum: 0

Maximum: 1000

False

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

dvbNitSettings

DvbNitSettings

False
dvbSdtSettings

DvbSdtSettings

False
scte35Source

string

False
scte35Pid

integer

Minimum: 32

Maximum: 8182

False

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

videoPid

integer

Minimum: 32

Maximum: 8182

False

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

dvbTdtSettings

DvbTdtSettings

False
pmtInterval

integer

Minimum: 0

Maximum: 1000

False

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

segmentationStyle

string

False
segmentationTime

number

Format: float

Minimum: 0.0

False

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

pmtPid

integer

Minimum: 32

Maximum: 8182

False

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

bitrate

integer

Minimum: 0

Maximum: 2147483647

False

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

audioPids

Array of type integer

False

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

privateMetadataPid

integer

Minimum: 32

Maximum: 8182

False

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

nielsenId3

string

False
timedMetadataPid

integer

Minimum: 32

Maximum: 8182

False

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

maxPcrInterval

integer

Minimum: 0

Maximum: 500

False

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

transportStreamId

integer

Minimum: 0

Maximum: 65535

False

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

dvbSubPids

Array of type integer

False

Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation.

rateMode

string

False
audioFramesPerPes

integer

Minimum: 0

Maximum: 2147483647

False

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

pcrControl

string

False
segmentationMarkers

string

False
ebpAudioInterval

string

False
programNumber

integer

Minimum: 0

Maximum: 65535

False

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

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.

bufferModel

string

False
dvbTeletextPid

integer

Minimum: 32

Maximum: 8182

False

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

fragmentTime

number

Format: float

Minimum: 0.0

False

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

ebpPlacement

string

False
nullPacketBitrate

number

Format: float

Minimum: 0.0

False

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

See Also

M3u8NielsenId3 (enum)

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

  • INSERT

  • NONE

M3u8PcrControl (enum)

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

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

  • 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

string

False
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

string

False
scte35Pid

integer

Minimum: 32

Maximum: 8182

False

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

nielsenId3

string

False
timedMetadata

string

False
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

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.

See Also

MovClapAtom (enum)

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

  • INCLUDE

  • EXCLUDE

MovCslgAtom (enum)

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

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

If set to OMNEON, inserts Omneon-compatible padding

  • OMNEON

  • NONE

MovReference (enum)

A value of 'external' creates separate media files and the wrapper file (.mov) contains references to these media files. A value of 'self_contained' creates only a wrapper (.mov) file and this file contains all of the media.

  • SELF_CONTAINED

  • EXTERNAL

MovSettings

Settings for MOV Container.

Property Type Required Description
clapAtom

string

False
cslgAtom

string

False
paddingControl

string

False
reference

string

False
mpeg2FourCCControl

string

False

See Also

Mp2Settings

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

Property Type Required Description
bitrate

integer

Minimum: 32000

Maximum: 384000

False

Average bitrate in bits/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.

See Also

Mp4CslgAtom (enum)

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

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

  • INCLUDE

  • EXCLUDE

Mp4MoovPlacement (enum)

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

  • PROGRESSIVE_DOWNLOAD

  • NORMAL

Mp4Settings

Settings for MP4 Container

Property Type Required Description
cslgAtom

string

False
freeSpaceBox

string

False
mp4MajorBrand

string

False

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

moovPlacement

string

False

See Also

Mpeg2AdaptiveQuantization (enum)

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

Mpeg2CodecLevel (enum)

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

  • AUTO

  • LOW

  • MAIN

  • HIGH1440

  • HIGH

Mpeg2CodecProfile (enum)

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

  • MAIN

  • PROFILE_422

Mpeg2DynamicSubGop (enum)

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

  • ADAPTIVE

  • STATIC

Mpeg2FramerateControl (enum)

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

Mpeg2FramerateConversionAlgorithm (enum)

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

  • DUPLICATE_DROP

  • INTERPOLATE

Mpeg2GopSizeUnits (enum)

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

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

  • PROGRESSIVE

  • TOP_FIELD

  • BOTTOM_FIELD

  • FOLLOW_TOP_FIELD

  • FOLLOW_BOTTOM_FIELD

Mpeg2IntraDcPrecision (enum)

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

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

Mpeg2QualityTuningLevel (enum)

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

  • SINGLE_PASS

  • MULTI_PASS

Mpeg2RateControlMode (enum)

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

  • VBR

  • CBR

Mpeg2SceneChangeDetect (enum)

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

  • DISABLED

  • ENABLED

Mpeg2Settings

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

Property Type Required Description
interlaceMode

string

False
parNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio numerator.

syntax

string

False
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

Framerate 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

string

False
parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

spatialAdaptiveQuantization

string

False
temporalAdaptiveQuantization

string

False
bitrate

integer

Minimum: 1000

Maximum: 288000000

False

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

intraDcPrecision

string

False
framerateControl

string

False
rateControlMode

string

False
codecProfile

string

False
telecine

string

False
framerateNumerator

integer

Minimum: 24

Maximum: 60000

False

Framerate numerator - framerate 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

string

False
codecLevel

string

False
sceneChangeDetect

string

False
qualityTuningLevel

string

False
framerateConversionAlgorithm

string

False
gopSizeUnits

string

False
parControl

string

False
numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

dynamicSubGop

string

False

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

See Also

Mpeg2SlowPal (enum)

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

  • DISABLED

  • ENABLED

Mpeg2SpatialAdaptiveQuantization (enum)

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

  • DISABLED

  • ENABLED

Mpeg2Syntax (enum)

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

  • DEFAULT

  • D_10

Mpeg2Telecine (enum)

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

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

string

False
filterSettings

NoiseReducerFilterSettings

False
spatialFilterSettings

NoiseReducerSpatialFilterSettings

False

See Also

NoiseReducerFilter (enum)

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 is an edge preserving noise reduction filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain filter based on JND principles.

  • BILATERAL

  • MEAN

  • GAUSSIAN

  • LANCZOS

  • SHARPEN

  • CONSERVE

  • SPATIAL

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.

See Also

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.

See Also

Order (enum)

When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

  • ASCENDING

  • DESCENDING

OutputChannelMapping

OutputChannel mapping settings.

Property Type Required Description
inputChannels

Array of type integer

False

List of input channels

See Also

OutputSdt (enum)

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

string

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

See Also

PresetListBy (enum)

Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.

  • NAME

  • CREATION_DATE

  • SYSTEM

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

Array of type CaptionDescriptionPreset

False

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

See Also

ProresCodecProfile (enum)

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

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

ProresFramerateConversionAlgorithm (enum)

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

  • DUPLICATE_DROP

  • INTERPOLATE

ProresInterlaceMode (enum)

Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore,