Jobs
URI
/2017-08-29/jobs
HTTP methods
GET
Operation ID: ListJobs
Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.
Name | Type | Required | Description |
---|---|---|---|
status | String | False | |
nextToken | String | False | |
maxResults | String | False | |
order | String | False | |
queue | String | False |
Status code | Response model | Description |
---|---|---|
200 | ListJobsResponse | 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. |
POST
Operation ID: CreateJob
Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
Status code | Response model | Description |
---|---|---|
201 | CreateJobResponse | 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. |
OPTIONS
Supports CORS preflight requests.
Status code | Response model | Description |
---|---|---|
200 | None | The request completed successfully. |
Schemas
Request bodies
{ "queue": "string", "status": enum, "order": enum, "nextToken": "string", "maxResults": integer }
{ "clientRequestToken": "string", "jobTemplate": "string", "jobEngineVersion": "string", "queue": "string", "role": "string", "settings": { "timecodeConfig": { "anchor": "string", "source": enum, "start": "string", "timestampOffset": "string" }, "outputGroups": [ { "customName": "string", "name": "string", "outputs": [ { "containerSettings": { "container": enum, "m3u8Settings": { "audioFramesPerPes": integer, "pcrControl": enum, "dataPTSControl": enum, "maxPcrInterval": integer, "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, "ptsOffsetMode": enum, "ptsOffset": integer, "audioPids": [ integer ], "audioDuration": enum }, "f4vSettings": { "moovPlacement": enum }, "m2tsSettings": { "audioBufferModel": enum, "minEbpInterval": integer, "esRateInPes": enum, "patInterval": integer, "dvbNitSettings": { "nitInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "scte35Source": enum, "scte35Pid": integer, "scte35Esam": { "scte35EsamPid": integer }, "klvMetadata": enum, "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, "dataPTSControl": enum, "segmentationMarkers": enum, "ebpAudioInterval": enum, "forceTsVideoEbpOrder": enum, "programNumber": integer, "pcrPid": integer, "bufferModel": enum, "dvbTeletextPid": integer, "fragmentTime": number, "ebpPlacement": enum, "nullPacketBitrate": number, "audioDuration": enum, "ptsOffsetMode": enum, "ptsOffset": integer, "preventBufferUnderflow": enum }, "movSettings": { "clapAtom": enum, "cslgAtom": enum, "paddingControl": enum, "reference": enum, "mpeg2FourCCControl": enum }, "mp4Settings": { "cslgAtom": enum, "cttsVersion": integer, "freeSpaceBox": enum, "mp4MajorBrand": "string", "moovPlacement": enum, "audioDuration": enum }, "mpdSettings": { "accessibilityCaptionHints": enum, "captionContainerType": enum, "scte35Source": enum, "scte35Esam": enum, "audioDuration": enum, "timedMetadata": enum, "timedMetadataBoxVersion": enum, "timedMetadataSchemeIdUri": "string", "timedMetadataValue": "string", "manifestMetadataSignaling": enum, "klvMetadata": enum }, "cmfcSettings": { "scte35Source": enum, "scte35Esam": enum, "audioDuration": enum, "iFrameOnlyManifest": enum, "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": enum, "descriptiveVideoServiceFlag": enum, "timedMetadata": enum, "timedMetadataBoxVersion": enum, "timedMetadataSchemeIdUri": "string", "timedMetadataValue": "string", "manifestMetadataSignaling": enum, "klvMetadata": enum }, "mxfSettings": { "afdSignaling": enum, "profile": enum, "xavcProfileSettings": { "durationMode": enum, "maxAncDataSize": integer } } }, "preset": "string", "videoDescription": { "fixedAfd": integer, "width": integer, "scalingBehavior": enum, "crop": { "height": integer, "width": integer, "x": integer, "y": integer }, "height": integer, "videoPreprocessors": { "colorCorrector": { "brightness": integer, "colorSpaceConversion": enum, "sampleRangeConversion": enum, "clipLimits": { "minimumYUV": integer, "maximumYUV": integer, "minimumRGBTolerance": integer, "maximumRGBTolerance": integer }, "sdrReferenceWhiteLevel": integer, "contrast": integer, "hue": integer, "saturation": integer, "maxLuminance": 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 }, "hdrToSdrToneMapper": enum }, "deinterlacer": { "algorithm": enum, "mode": enum, "control": enum }, "dolbyVision": { "profile": enum, "l6Mode": enum, "l6Metadata": { "maxCll": integer, "maxFall": integer }, "mapping": enum }, "hdr10Plus": { "masteringMonitorNits": integer, "targetMonitorNits": integer }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ], "sdrReferenceWhiteLevel": integer }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer }, "temporalFilterSettings": { "strength": integer, "speed": integer, "aggressiveMode": integer, "postTemporalSharpening": enum, "postTemporalSharpeningStrength": enum } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" }, "partnerWatermarking": { "nexguardFileMarkerSettings": { "license": "string", "preset": "string", "payload": integer, "strength": enum } } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "av1Settings": { "gopSize": number, "numberBFramesBetweenReferenceFrames": integer, "slices": integer, "bitDepth": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "qvbrQualityLevelFineTune": number }, "maxBitrate": integer, "adaptiveQuantization": enum, "spatialAdaptiveQuantization": enum, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "filmGrainSynthesis": enum }, "avcIntraSettings": { "avcIntraClass": enum, "avcIntraUhdSettings": { "qualityTuningLevel": enum }, "interlaceMode": enum, "scanTypeConversionMode": enum, "framerateDenominator": integer, "slowPal": enum, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum }, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "scanTypeConversionMode": 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, "qvbrQualityLevelFineTune": number, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "saliencyAwareEncoding": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum, "hrdBufferFinalFillPercentage": integer, "bandwidthReductionFilter": { "strength": enum, "sharpening": enum }, "endOfStreamMarkers": enum }, "h265Settings": { "interlaceMode": enum, "scanTypeConversionMode": 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, "qvbrQualityLevelFineTune": number, "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, "hrdBufferFinalFillPercentage": integer, "endOfStreamMarkers": enum, "bandwidthReductionFilter": { "strength": enum, "sharpening": enum } }, "mpeg2Settings": { "interlaceMode": enum, "scanTypeConversionMode": 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, "hrdBufferFinalFillPercentage": integer }, "proresSettings": { "interlaceMode": enum, "scanTypeConversionMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "chromaSampling": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum }, "uncompressedSettings": { "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "interlaceMode": enum, "scanTypeConversionMode": enum, "telecine": enum, "slowPal": enum, "fourcc": enum }, "vc3Settings": { "vc3Class": enum, "interlaceMode": enum, "scanTypeConversionMode": enum, "framerateConversionAlgorithm": enum, "telecine": enum, "slowPal": enum, "framerateControl": enum, "framerateDenominator": integer, "framerateNumerator": integer }, "vp8Settings": { "qualityTuningLevel": enum, "rateControlMode": enum, "gopSize": number, "maxBitrate": integer, "bitrate": integer, "hrdBufferSize": integer, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "parControl": enum, "parNumerator": integer, "parDenominator": integer }, "vp9Settings": { "qualityTuningLevel": enum, "rateControlMode": enum, "gopSize": number, "maxBitrate": integer, "bitrate": integer, "hrdBufferSize": integer, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "parControl": enum, "parNumerator": integer, "parDenominator": integer }, "xavcSettings": { "profile": enum, "xavcHdIntraCbgProfileSettings": { "xavcClass": enum }, "xavc4kIntraCbgProfileSettings": { "xavcClass": enum }, "xavc4kIntraVbrProfileSettings": { "xavcClass": enum }, "xavcHdProfileSettings": { "bitrateClass": enum, "slices": integer, "hrdBufferSize": integer, "qualityTuningLevel": enum, "interlaceMode": enum, "telecine": enum, "gopClosedCadence": integer, "gopBReference": enum, "flickerAdaptiveQuantization": enum }, "xavc4kProfileSettings": { "bitrateClass": enum, "slices": integer, "hrdBufferSize": integer, "codecProfile": enum, "qualityTuningLevel": enum, "gopClosedCadence": integer, "gopBReference": enum, "flickerAdaptiveQuantization": enum }, "softness": integer, "framerateDenominator": integer, "slowPal": enum, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "entropyEncoding": enum, "framerateControl": enum, "framerateNumerator": integer, "adaptiveQuantization": enum, "framerateConversionAlgorithm": 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, "truePeakLimiterThreshold": number }, "audioChannelTaggingSettings": { "channelTag": enum, "channelTags": [ 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, "dynamicRangeCompressionLine": enum, "dynamicRangeCompressionRf": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "eac3AtmosSettings": { "surroundExMode": enum, "loRoSurroundMixLevel": number, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "loRoCenterMixLevel": number, "codingMode": enum, "bitstreamMode": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "downmixControl": enum, "dynamicRangeControl": enum, "meteringMode": enum, "dialogueIntelligence": enum, "speechThreshold": integer }, "flacSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "mp3Settings": { "bitrate": integer, "channels": integer, "rateControlMode": enum, "sampleRate": integer, "vbrQuality": integer }, "opusSettings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "vorbisSettings": { "channels": integer, "sampleRate": integer, "vbrQuality": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ], "inputChannelsFineTune": [ number ] } ] }, "channelsIn": integer, "channelsOut": integer, "audioDescriptionAudioChannel": integer, "audioDescriptionDataChannel": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "outputSettings": { "hlsSettings": { "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": enum, "descriptiveVideoServiceFlag": enum, "iFrameOnlyManifest": enum, "segmentModifier": "string", "audioOnlyContainer": enum } }, "extension": "string", "nameModifier": "string", "captionDescriptions": [ { "captionSelectorName": "string", "destinationSettings": { "destinationType": enum, "burninDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fallbackFont": enum, "fontFileRegular": "string", "fontFileBold": "string", "fontFileItalic": "string", "fontFileBoldItalic": "string", "fontColor": enum, "hexFontColor": "string", "applyFontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer, "stylePassthrough": enum }, "dvbSubDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fallbackFont": enum, "fontFileRegular": "string", "fontFileBold": "string", "fontFileItalic": "string", "fontFileBoldItalic": "string", "fontColor": enum, "hexFontColor": "string", "applyFontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer, "subtitlingType": enum, "ddsHandling": enum, "ddsXCoordinate": integer, "ddsYCoordinate": integer, "width": integer, "height": integer, "stylePassthrough": enum }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string", "pageTypes": [ enum ] }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "imscDestinationSettings": { "stylePassthrough": enum, "accessibility": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": integer, "destination708ServiceNumber": integer }, "webvttDestinationSettings": { "stylePassthrough": enum, "accessibility": enum }, "srtDestinationSettings": { "stylePassthrough": enum } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } ], "outputGroupSettings": { "type": enum, "hlsGroupSettings": { "targetDurationCompatibilityMode": enum, "manifestDurationFormat": enum, "segmentLength": integer, "segmentLengthControl": enum, "timedMetadataId3Period": integer, "captionLanguageSetting": enum, "captionLanguageMappings": [ { "captionChannel": integer, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ], "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "encryption": { "encryptionMethod": enum, "constantInitializationVector": "string", "initializationVectorInManifest": enum, "offlineEncrypted": enum, "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } }, "staticKeyProvider": { "staticKeyValue": "string", "keyFormat": "string", "keyFormatVersions": "string", "url": "string" }, "type": enum }, "timedMetadataId3Frame": enum, "baseUrl": "string", "codecSpecification": enum, "outputSelection": enum, "programDateTimePeriod": integer, "segmentsPerSubdirectory": integer, "minSegmentLength": integer, "minFinalSegmentLength": number, "directoryStructure": enum, "programDateTime": enum, "adMarkers": [ enum ], "segmentControl": enum, "timestampDeltaMilliseconds": integer, "manifestCompression": enum, "clientCache": enum, "audioOnlyHeader": enum, "streamInfResolution": enum, "imageBasedTrickPlay": enum, "progressiveWriteHlsManifest": enum, "imageBasedTrickPlaySettings": { "thumbnailHeight": integer, "thumbnailWidth": integer, "tileHeight": integer, "tileWidth": integer, "intervalCadence": enum, "thumbnailInterval": number }, "captionSegmentLengthControl": enum }, "dashIsoGroupSettings": { "audioChannelConfigSchemeIdUri": enum, "segmentLength": integer, "minFinalSegmentLength": number, "segmentLengthControl": enum, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "encryption": { "playbackDeviceCompatibility": enum, "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } } }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": enum, "ptsOffsetHandlingForBFrames": enum, "mpdManifestBandwidthType": enum, "mpdProfile": enum, "hbbtvCompliance": enum, "writeSegmentTimelineInRepresentation": enum, "imageBasedTrickPlay": enum, "dashIFrameTrickPlayNameModifier": "string", "imageBasedTrickPlaySettings": { "thumbnailHeight": integer, "thumbnailWidth": integer, "tileHeight": integer, "tileWidth": integer, "intervalCadence": enum, "thumbnailInterval": number }, "videoCompositionOffsets": enum, "dashManifestStyle": enum }, "fileGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } } }, "msSmoothGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "fragmentLength": integer, "fragmentLengthControl": enum, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } } }, "manifestEncoding": enum, "audioDeduplication": enum }, "cmafGroupSettings": { "targetDurationCompatibilityMode": enum, "writeHlsManifest": enum, "writeDashManifest": enum, "segmentLength": integer, "segmentLengthControl": enum, "minFinalSegmentLength": number, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "encryption": { "encryptionMethod": enum, "constantInitializationVector": "string", "initializationVectorInManifest": enum, "spekeKeyProvider": { "resourceId": "string", "hlsSignaledSystemIds": [ "string" ], "dashSignaledSystemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } }, "staticKeyProvider": { "staticKeyValue": "string", "keyFormat": "string", "keyFormatVersions": "string", "url": "string" }, "type": enum }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": enum, "ptsOffsetHandlingForBFrames": enum, "mpdManifestBandwidthType": enum, "mpdProfile": enum, "writeSegmentTimelineInRepresentation": enum, "manifestDurationFormat": enum, "streamInfResolution": enum, "clientCache": enum, "manifestCompression": enum, "codecSpecification": enum, "imageBasedTrickPlay": enum, "dashIFrameTrickPlayNameModifier": "string", "imageBasedTrickPlaySettings": { "thumbnailHeight": integer, "thumbnailWidth": integer, "tileHeight": integer, "tileWidth": integer, "intervalCadence": enum, "thumbnailInterval": number }, "videoCompositionOffsets": enum, "dashManifestStyle": enum } }, "automatedEncodingSettings": { "abrSettings": { "maxRenditions": integer, "maxAbrBitrate": integer, "minAbrBitrate": integer, "rules": [ { "type": enum, "minTopRenditionSize": { "width": integer, "height": integer }, "minBottomRenditionSize": { "width": integer, "height": integer }, "forceIncludeRenditions": [ { "width": integer, "height": integer } ], "allowedRenditions": [ { "width": integer, "height": integer, "required": enum } ] } ] } } } ], "adAvailOffset": integer, "availBlanking": { "availBlankingImage": "string" }, "followSource": integer, "timedMetadataInsertion": { "id3Insertions": [ { "timecode": "string", "id3": "string" } ] }, "nielsenConfiguration": { "breakoutCode": integer, "distributorId": "string" }, "motionImageInserter": { "insertionMode": enum, "input": "string", "offset": { "imageX": integer, "imageY": integer }, "startTime": "string", "playback": enum, "framerate": { "framerateNumerator": integer, "framerateDenominator": integer } }, "esam": { "signalProcessingNotification": { "sccXml": "string" }, "manifestConfirmConditionNotification": { "mccXml": "string" }, "responseSignalPreroll": integer }, "nielsenNonLinearWatermark": { "sourceId": integer, "cbetSourceId": "string", "activeWatermarkProcess": enum, "assetId": "string", "assetName": "string", "episodeId": "string", "ticServerUrl": "string", "metadataDestination": "string", "uniqueTicPerAudioTrack": enum, "adiFilename": "string", "sourceWatermarkStatus": enum }, "kantarWatermark": { "credentialsSecretName": "string", "channelName": "string", "contentReference": "string", "kantarServerUrl": "string", "kantarLicenseId": integer, "logDestination": "string", "fileOffset": number, "metadata3": "string", "metadata4": "string", "metadata5": "string", "metadata6": "string", "metadata7": "string", "metadata8": "string" }, "extendedDataServices": { "vchipAction": enum, "copyProtectionAction": enum }, "colorConversion3DLUTSettings": [ { "inputMasteringLuminance": integer, "inputColorSpace": enum, "outputMasteringLuminance": integer, "outputColorSpace": enum, "fileInput": "string" } ], "inputs": [ { "inputClippings": [ { "endTimecode": "string", "startTimecode": "string" } ], "audioSelectors": { }, "audioSelectorGroups": { }, "programNumber": integer, "videoSelector": { "colorSpace": enum, "sampleRange": enum, "rotate": enum, "pid": integer, "programNumber": integer, "embeddedTimecodeOverride": enum, "alphaBehavior": enum, "colorSpaceUsage": enum, "padVideo": enum, "maxLuminance": 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 } }, "filterEnable": enum, "psiControl": enum, "filterStrength": integer, "deblockFilter": enum, "denoiseFilter": enum, "inputScanType": enum, "timecodeSource": enum, "timecodeStart": "string", "captionSelectors": { }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ], "sdrReferenceWhiteLevel": integer }, "dolbyVisionMetadataXml": "string", "crop": { "height": integer, "width": integer, "x": integer, "y": integer }, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "advancedInputFilter": enum, "advancedInputFilterSettings": { "sharpening": enum, "addTexture": enum }, "videoOverlays": [ { "input": { "fileInput": "string", "inputClippings": [ { "endTimecode": "string", "startTimecode": "string" } ], "timecodeSource": enum, "timecodeStart": "string" }, "endTimecode": "string", "startTimecode": "string", "initialPosition": { "xPosition": integer, "yPosition": integer, "width": integer, "height": integer, "unit": enum }, "playback": enum, "transitions": [ { "endTimecode": "string", "startTimecode": "string", "endPosition": { "xPosition": integer, "yPosition": integer, "width": integer, "height": integer, "unit": enum } } ] } ], "fileInput": "string", "videoGenerator": { "duration": integer, "framerateNumerator": integer, "framerateDenominator": integer, "sampleRate": integer, "channels": integer }, "decryptionSettings": { "decryptionMode": enum, "encryptedDecryptionKey": "string", "initializationVector": "string", "kmsKeyRegion": "string" }, "supplementalImps": [ "string" ] } ] }, "userMetadata": { }, "billingTagsSource": enum, "tags": { }, "accelerationSettings": { "mode": enum }, "statusUpdateInterval": enum, "priority": integer, "simulateReservedQueue": enum, "hopDestinations": [ { "waitMinutes": integer, "queue": "string", "priority": integer } ] }
Response bodies
{ "jobs": [ { "arn": "string", "id": "string", "createdAt": "string", "jobTemplate": "string", "jobEngineVersionRequested": "string", "jobEngineVersionUsed": "string", "queue": "string", "userMetadata": { }, "role": "string", "settings": { "timecodeConfig": { "anchor": "string", "source": enum, "start": "string", "timestampOffset": "string" }, "outputGroups": [ { "customName": "string", "name": "string", "outputs": [ { "containerSettings": { "container": enum, "m3u8Settings": { "audioFramesPerPes": integer, "pcrControl": enum, "dataPTSControl": enum, "maxPcrInterval": integer, "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, "ptsOffsetMode": enum, "ptsOffset": integer, "audioPids": [ integer ], "audioDuration": enum }, "f4vSettings": { "moovPlacement": enum }, "m2tsSettings": { "audioBufferModel": enum, "minEbpInterval": integer, "esRateInPes": enum, "patInterval": integer, "dvbNitSettings": { "nitInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "scte35Source": enum, "scte35Pid": integer, "scte35Esam": { "scte35EsamPid": integer }, "klvMetadata": enum, "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, "dataPTSControl": enum, "segmentationMarkers": enum, "ebpAudioInterval": enum, "forceTsVideoEbpOrder": enum, "programNumber": integer, "pcrPid": integer, "bufferModel": enum, "dvbTeletextPid": integer, "fragmentTime": number, "ebpPlacement": enum, "nullPacketBitrate": number, "audioDuration": enum, "ptsOffsetMode": enum, "ptsOffset": integer, "preventBufferUnderflow": enum }, "movSettings": { "clapAtom": enum, "cslgAtom": enum, "paddingControl": enum, "reference": enum, "mpeg2FourCCControl": enum }, "mp4Settings": { "cslgAtom": enum, "cttsVersion": integer, "freeSpaceBox": enum, "mp4MajorBrand": "string", "moovPlacement": enum, "audioDuration": enum }, "mpdSettings": { "accessibilityCaptionHints": enum, "captionContainerType": enum, "scte35Source": enum, "scte35Esam": enum, "audioDuration": enum, "timedMetadata": enum, "timedMetadataBoxVersion": enum, "timedMetadataSchemeIdUri": "string", "timedMetadataValue": "string", "manifestMetadataSignaling": enum, "klvMetadata": enum }, "cmfcSettings": { "scte35Source": enum, "scte35Esam": enum, "audioDuration": enum, "iFrameOnlyManifest": enum, "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": enum, "descriptiveVideoServiceFlag": enum, "timedMetadata": enum, "timedMetadataBoxVersion": enum, "timedMetadataSchemeIdUri": "string", "timedMetadataValue": "string", "manifestMetadataSignaling": enum, "klvMetadata": enum }, "mxfSettings": { "afdSignaling": enum, "profile": enum, "xavcProfileSettings": { "durationMode": enum, "maxAncDataSize": integer } } }, "preset": "string", "videoDescription": { "fixedAfd": integer, "width": integer, "scalingBehavior": enum, "crop": { "height": integer, "width": integer, "x": integer, "y": integer }, "height": integer, "videoPreprocessors": { "colorCorrector": { "brightness": integer, "colorSpaceConversion": enum, "sampleRangeConversion": enum, "clipLimits": { "minimumYUV": integer, "maximumYUV": integer, "minimumRGBTolerance": integer, "maximumRGBTolerance": integer }, "sdrReferenceWhiteLevel": integer, "contrast": integer, "hue": integer, "saturation": integer, "maxLuminance": 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 }, "hdrToSdrToneMapper": enum }, "deinterlacer": { "algorithm": enum, "mode": enum, "control": enum }, "dolbyVision": { "profile": enum, "l6Mode": enum, "l6Metadata": { "maxCll": integer, "maxFall": integer }, "mapping": enum }, "hdr10Plus": { "masteringMonitorNits": integer, "targetMonitorNits": integer }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ], "sdrReferenceWhiteLevel": integer }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer }, "temporalFilterSettings": { "strength": integer, "speed": integer, "aggressiveMode": integer, "postTemporalSharpening": enum, "postTemporalSharpeningStrength": enum } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" }, "partnerWatermarking": { "nexguardFileMarkerSettings": { "license": "string", "preset": "string", "payload": integer, "strength": enum } } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "av1Settings": { "gopSize": number, "numberBFramesBetweenReferenceFrames": integer, "slices": integer, "bitDepth": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "qvbrQualityLevelFineTune": number }, "maxBitrate": integer, "adaptiveQuantization": enum, "spatialAdaptiveQuantization": enum, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "filmGrainSynthesis": enum }, "avcIntraSettings": { "avcIntraClass": enum, "avcIntraUhdSettings": { "qualityTuningLevel": enum }, "interlaceMode": enum, "scanTypeConversionMode": enum, "framerateDenominator": integer, "slowPal": enum, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum }, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "scanTypeConversionMode": 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, "qvbrQualityLevelFineTune": number, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "saliencyAwareEncoding": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum, "hrdBufferFinalFillPercentage": integer, "bandwidthReductionFilter": { "strength": enum, "sharpening": enum }, "endOfStreamMarkers": enum }, "h265Settings": { "interlaceMode": enum, "scanTypeConversionMode": 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, "qvbrQualityLevelFineTune": number, "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, "hrdBufferFinalFillPercentage": integer, "endOfStreamMarkers": enum, "bandwidthReductionFilter": { "strength": enum, "sharpening": enum } }, "mpeg2Settings": { "interlaceMode": enum, "scanTypeConversionMode": 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, "hrdBufferFinalFillPercentage": integer }, "proresSettings": { "interlaceMode": enum, "scanTypeConversionMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "chromaSampling": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum }, "uncompressedSettings": { "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "interlaceMode": enum, "scanTypeConversionMode": enum, "telecine": enum, "slowPal": enum, "fourcc": enum }, "vc3Settings": { "vc3Class": enum, "interlaceMode": enum, "scanTypeConversionMode": enum, "framerateConversionAlgorithm": enum, "telecine": enum, "slowPal": enum, "framerateControl": enum, "framerateDenominator": integer, "framerateNumerator": integer }, "vp8Settings": { "qualityTuningLevel": enum, "rateControlMode": enum, "gopSize": number, "maxBitrate": integer, "bitrate": integer, "hrdBufferSize": integer, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "parControl": enum, "parNumerator": integer, "parDenominator": integer }, "vp9Settings": { "qualityTuningLevel": enum, "rateControlMode": enum, "gopSize": number, "maxBitrate": integer, "bitrate": integer, "hrdBufferSize": integer, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "parControl": enum, "parNumerator": integer, "parDenominator": integer }, "xavcSettings": { "profile": enum, "xavcHdIntraCbgProfileSettings": { "xavcClass": enum }, "xavc4kIntraCbgProfileSettings": { "xavcClass": enum }, "xavc4kIntraVbrProfileSettings": { "xavcClass": enum }, "xavcHdProfileSettings": { "bitrateClass": enum, "slices": integer, "hrdBufferSize": integer, "qualityTuningLevel": enum, "interlaceMode": enum, "telecine": enum, "gopClosedCadence": integer, "gopBReference": enum, "flickerAdaptiveQuantization": enum }, "xavc4kProfileSettings": { "bitrateClass": enum, "slices": integer, "hrdBufferSize": integer, "codecProfile": enum, "qualityTuningLevel": enum, "gopClosedCadence": integer, "gopBReference": enum, "flickerAdaptiveQuantization": enum }, "softness": integer, "framerateDenominator": integer, "slowPal": enum, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "entropyEncoding": enum, "framerateControl": enum, "framerateNumerator": integer, "adaptiveQuantization": enum, "framerateConversionAlgorithm": 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, "truePeakLimiterThreshold": number }, "audioChannelTaggingSettings": { "channelTag": enum, "channelTags": [ 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, "dynamicRangeCompressionLine": enum, "dynamicRangeCompressionRf": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "eac3AtmosSettings": { "surroundExMode": enum, "loRoSurroundMixLevel": number, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "loRoCenterMixLevel": number, "codingMode": enum, "bitstreamMode": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "downmixControl": enum, "dynamicRangeControl": enum, "meteringMode": enum, "dialogueIntelligence": enum, "speechThreshold": integer }, "flacSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "mp3Settings": { "bitrate": integer, "channels": integer, "rateControlMode": enum, "sampleRate": integer, "vbrQuality": integer }, "opusSettings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "vorbisSettings": { "channels": integer, "sampleRate": integer, "vbrQuality": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ], "inputChannelsFineTune": [ number ] } ] }, "channelsIn": integer, "channelsOut": integer, "audioDescriptionAudioChannel": integer, "audioDescriptionDataChannel": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "outputSettings": { "hlsSettings": { "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": enum, "descriptiveVideoServiceFlag": enum, "iFrameOnlyManifest": enum, "segmentModifier": "string", "audioOnlyContainer": enum } }, "extension": "string", "nameModifier": "string", "captionDescriptions": [ { "captionSelectorName": "string", "destinationSettings": { "destinationType": enum, "burninDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fallbackFont": enum, "fontFileRegular": "string", "fontFileBold": "string", "fontFileItalic": "string", "fontFileBoldItalic": "string", "fontColor": enum, "hexFontColor": "string", "applyFontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer, "stylePassthrough": enum }, "dvbSubDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fallbackFont": enum, "fontFileRegular": "string", "fontFileBold": "string", "fontFileItalic": "string", "fontFileBoldItalic": "string", "fontColor": enum, "hexFontColor": "string", "applyFontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer, "subtitlingType": enum, "ddsHandling": enum, "ddsXCoordinate": integer, "ddsYCoordinate": integer, "width": integer, "height": integer, "stylePassthrough": enum }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string", "pageTypes": [ enum ] }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "imscDestinationSettings": { "stylePassthrough": enum, "accessibility": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": integer, "destination708ServiceNumber": integer }, "webvttDestinationSettings": { "stylePassthrough": enum, "accessibility": enum }, "srtDestinationSettings": { "stylePassthrough": enum } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } ], "outputGroupSettings": { "type": enum, "hlsGroupSettings": { "targetDurationCompatibilityMode": enum, "manifestDurationFormat": enum, "segmentLength": integer, "segmentLengthControl": enum, "timedMetadataId3Period": integer, "captionLanguageSetting": enum, "captionLanguageMappings": [ { "captionChannel": integer, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ], "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "encryption": { "encryptionMethod": enum, "constantInitializationVector": "string", "initializationVectorInManifest": enum, "offlineEncrypted": enum, "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } }, "staticKeyProvider": { "staticKeyValue": "string", "keyFormat": "string", "keyFormatVersions": "string", "url": "string" }, "type": enum }, "timedMetadataId3Frame": enum, "baseUrl": "string", "codecSpecification": enum, "outputSelection": enum, "programDateTimePeriod": integer, "segmentsPerSubdirectory": integer, "minSegmentLength": integer, "minFinalSegmentLength": number, "directoryStructure": enum, "programDateTime": enum, "adMarkers": [ enum ], "segmentControl": enum, "timestampDeltaMilliseconds": integer, "manifestCompression": enum, "clientCache": enum, "audioOnlyHeader": enum, "streamInfResolution": enum, "imageBasedTrickPlay": enum, "progressiveWriteHlsManifest": enum, "imageBasedTrickPlaySettings": { "thumbnailHeight": integer, "thumbnailWidth": integer, "tileHeight": integer, "tileWidth": integer, "intervalCadence": enum, "thumbnailInterval": number }, "captionSegmentLengthControl": enum }, "dashIsoGroupSettings": { "audioChannelConfigSchemeIdUri": enum, "segmentLength": integer, "minFinalSegmentLength": number, "segmentLengthControl": enum, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "encryption": { "playbackDeviceCompatibility": enum, "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } } }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": enum, "ptsOffsetHandlingForBFrames": enum, "mpdManifestBandwidthType": enum, "mpdProfile": enum, "hbbtvCompliance": enum, "writeSegmentTimelineInRepresentation": enum, "imageBasedTrickPlay": enum, "dashIFrameTrickPlayNameModifier": "string", "imageBasedTrickPlaySettings": { "thumbnailHeight": integer, "thumbnailWidth": integer, "tileHeight": integer, "tileWidth": integer, "intervalCadence": enum, "thumbnailInterval": number }, "videoCompositionOffsets": enum, "dashManifestStyle": enum }, "fileGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } } }, "msSmoothGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "fragmentLength": integer, "fragmentLengthControl": enum, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } } }, "manifestEncoding": enum, "audioDeduplication": enum }, "cmafGroupSettings": { "targetDurationCompatibilityMode": enum, "writeHlsManifest": enum, "writeDashManifest": enum, "segmentLength": integer, "segmentLengthControl": enum, "minFinalSegmentLength": number, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "encryption": { "encryptionMethod": enum, "constantInitializationVector": "string", "initializationVectorInManifest": enum, "spekeKeyProvider": { "resourceId": "string", "hlsSignaledSystemIds": [ "string" ], "dashSignaledSystemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } }, "staticKeyProvider": { "staticKeyValue": "string", "keyFormat": "string", "keyFormatVersions": "string", "url": "string" }, "type": enum }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": enum, "ptsOffsetHandlingForBFrames": enum, "mpdManifestBandwidthType": enum, "mpdProfile": enum, "writeSegmentTimelineInRepresentation": enum, "manifestDurationFormat": enum, "streamInfResolution": enum, "clientCache": enum, "manifestCompression": enum, "codecSpecification": enum, "imageBasedTrickPlay": enum, "dashIFrameTrickPlayNameModifier": "string", "imageBasedTrickPlaySettings": { "thumbnailHeight": integer, "thumbnailWidth": integer, "tileHeight": integer, "tileWidth": integer, "intervalCadence": enum, "thumbnailInterval": number }, "videoCompositionOffsets": enum, "dashManifestStyle": enum } }, "automatedEncodingSettings": { "abrSettings": { "maxRenditions": integer, "maxAbrBitrate": integer, "minAbrBitrate": integer, "rules": [ { "type": enum, "minTopRenditionSize": { "width": integer, "height": integer }, "minBottomRenditionSize": { "width": integer, "height": integer }, "forceIncludeRenditions": [ { "width": integer, "height": integer } ], "allowedRenditions": [ { "width": integer, "height": integer, "required": enum } ] } ] } } } ], "adAvailOffset": integer, "availBlanking": { "availBlankingImage": "string" }, "followSource": integer, "timedMetadataInsertion": { "id3Insertions": [ { "timecode": "string", "id3": "string" } ] }, "nielsenConfiguration": { "breakoutCode": integer, "distributorId": "string" }, "motionImageInserter": { "insertionMode": enum, "input": "string", "offset": { "imageX": integer, "imageY": integer }, "startTime": "string", "playback": enum, "framerate": { "framerateNumerator": integer, "framerateDenominator": integer } }, "esam": { "signalProcessingNotification": { "sccXml": "string" }, "manifestConfirmConditionNotification": { "mccXml": "string" }, "responseSignalPreroll": integer }, "nielsenNonLinearWatermark": { "sourceId": integer, "cbetSourceId": "string", "activeWatermarkProcess": enum, "assetId": "string", "assetName": "string", "episodeId": "string", "ticServerUrl": "string", "metadataDestination": "string", "uniqueTicPerAudioTrack": enum, "adiFilename": "string", "sourceWatermarkStatus": enum }, "kantarWatermark": { "credentialsSecretName": "string", "channelName": "string", "contentReference": "string", "kantarServerUrl": "string", "kantarLicenseId": integer, "logDestination": "string", "fileOffset": number, "metadata3": "string", "metadata4": "string", "metadata5": "string", "metadata6": "string", "metadata7": "string", "metadata8": "string" }, "extendedDataServices": { "vchipAction": enum, "copyProtectionAction": enum }, "colorConversion3DLUTSettings": [ { "inputMasteringLuminance": integer, "inputColorSpace": enum, "outputMasteringLuminance": integer, "outputColorSpace": enum, "fileInput": "string" } ], "inputs": [ { "inputClippings": [ { "endTimecode": "string", "startTimecode": "string" } ], "audioSelectors": { }, "audioSelectorGroups": { }, "programNumber": integer, "videoSelector": { "colorSpace": enum, "sampleRange": enum, "rotate": enum, "pid": integer, "programNumber": integer, "embeddedTimecodeOverride": enum, "alphaBehavior": enum, "colorSpaceUsage": enum, "padVideo": enum, "maxLuminance": 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 } }, "filterEnable": enum, "psiControl": enum, "filterStrength": integer, "deblockFilter": enum, "denoiseFilter": enum, "inputScanType": enum, "timecodeSource": enum, "timecodeStart": "string", "captionSelectors": { }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ], "sdrReferenceWhiteLevel": integer }, "dolbyVisionMetadataXml": "string", "crop": { "height": integer, "width": integer, "x": integer, "y": integer }, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "advancedInputFilter": enum, "advancedInputFilterSettings": { "sharpening": enum, "addTexture": enum }, "videoOverlays": [ { "input": { "fileInput": "string", "inputClippings": [ { "endTimecode": "string", "startTimecode": "string" } ], "timecodeSource": enum, "timecodeStart": "string" }, "endTimecode": "string", "startTimecode": "string", "initialPosition": { "xPosition": integer, "yPosition": integer, "width": integer, "height": integer, "unit": enum }, "playback": enum, "transitions": [ { "endTimecode": "string", "startTimecode": "string", "endPosition": { "xPosition": integer, "yPosition": integer, "width": integer, "height": integer, "unit": enum } } ] } ], "fileInput": "string", "videoGenerator": { "duration": integer, "framerateNumerator": integer, "framerateDenominator": integer, "sampleRate": integer, "channels": integer }, "decryptionSettings": { "decryptionMode": enum, "encryptedDecryptionKey": "string", "initializationVector": "string", "kmsKeyRegion": "string" }, "supplementalImps": [ "string" ] } ] }, "status": enum, "errorCode": integer, "errorMessage": "string", "timing": { "submitTime": "string", "startTime": "string", "finishTime": "string" }, "outputGroupDetails": [ { "outputDetails": [ { "durationInMs": integer, "videoDetails": { "widthInPx": integer, "heightInPx": integer } } ] } ], "billingTagsSource": enum, "accelerationSettings": { "mode": enum }, "statusUpdateInterval": enum, "jobPercentComplete": integer, "currentPhase": enum, "retryCount": integer, "priority": integer, "simulateReservedQueue": enum, "accelerationStatus": enum, "messages": { "info": [ "string" ], "warning": [ "string" ] }, "hopDestinations": [ { "waitMinutes": integer, "queue": "string", "priority": integer } ], "queueTransitions": [ { "timestamp": "string", "sourceQueue": "string", "destinationQueue": "string" } ], "clientRequestToken": "string", "warnings": [ { "code": integer, "count": integer } ] } ], "nextToken": "string" }
{ "job": { "arn": "string", "id": "string", "createdAt": "string", "jobTemplate": "string", "jobEngineVersionRequested": "string", "jobEngineVersionUsed": "string", "queue": "string", "userMetadata": { }, "role": "string", "settings": { "timecodeConfig": { "anchor": "string", "source": enum, "start": "string", "timestampOffset": "string" }, "outputGroups": [ { "customName": "string", "name": "string", "outputs": [ { "containerSettings": { "container": enum, "m3u8Settings": { "audioFramesPerPes": integer, "pcrControl": enum, "dataPTSControl": enum, "maxPcrInterval": integer, "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, "ptsOffsetMode": enum, "ptsOffset": integer, "audioPids": [ integer ], "audioDuration": enum }, "f4vSettings": { "moovPlacement": enum }, "m2tsSettings": { "audioBufferModel": enum, "minEbpInterval": integer, "esRateInPes": enum, "patInterval": integer, "dvbNitSettings": { "nitInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "scte35Source": enum, "scte35Pid": integer, "scte35Esam": { "scte35EsamPid": integer }, "klvMetadata": enum, "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, "dataPTSControl": enum, "segmentationMarkers": enum, "ebpAudioInterval": enum, "forceTsVideoEbpOrder": enum, "programNumber": integer, "pcrPid": integer, "bufferModel": enum, "dvbTeletextPid": integer, "fragmentTime": number, "ebpPlacement": enum, "nullPacketBitrate": number, "audioDuration": enum, "ptsOffsetMode": enum, "ptsOffset": integer, "preventBufferUnderflow": enum }, "movSettings": { "clapAtom": enum, "cslgAtom": enum, "paddingControl": enum, "reference": enum, "mpeg2FourCCControl": enum }, "mp4Settings": { "cslgAtom": enum, "cttsVersion": integer, "freeSpaceBox": enum, "mp4MajorBrand": "string", "moovPlacement": enum, "audioDuration": enum }, "mpdSettings": { "accessibilityCaptionHints": enum, "captionContainerType": enum, "scte35Source": enum, "scte35Esam": enum, "audioDuration": enum, "timedMetadata": enum, "timedMetadataBoxVersion": enum, "timedMetadataSchemeIdUri": "string", "timedMetadataValue": "string", "manifestMetadataSignaling": enum, "klvMetadata": enum }, "cmfcSettings": { "scte35Source": enum, "scte35Esam": enum, "audioDuration": enum, "iFrameOnlyManifest": enum, "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": enum, "descriptiveVideoServiceFlag": enum, "timedMetadata": enum, "timedMetadataBoxVersion": enum, "timedMetadataSchemeIdUri": "string", "timedMetadataValue": "string", "manifestMetadataSignaling": enum, "klvMetadata": enum }, "mxfSettings": { "afdSignaling": enum, "profile": enum, "xavcProfileSettings": { "durationMode": enum, "maxAncDataSize": integer } } }, "preset": "string", "videoDescription": { "fixedAfd": integer, "width": integer, "scalingBehavior": enum, "crop": { "height": integer, "width": integer, "x": integer, "y": integer }, "height": integer, "videoPreprocessors": { "colorCorrector": { "brightness": integer, "colorSpaceConversion": enum, "sampleRangeConversion": enum, "clipLimits": { "minimumYUV": integer, "maximumYUV": integer, "minimumRGBTolerance": integer, "maximumRGBTolerance": integer }, "sdrReferenceWhiteLevel": integer, "contrast": integer, "hue": integer, "saturation": integer, "maxLuminance": 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 }, "hdrToSdrToneMapper": enum }, "deinterlacer": { "algorithm": enum, "mode": enum, "control": enum }, "dolbyVision": { "profile": enum, "l6Mode": enum, "l6Metadata": { "maxCll": integer, "maxFall": integer }, "mapping": enum }, "hdr10Plus": { "masteringMonitorNits": integer, "targetMonitorNits": integer }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ], "sdrReferenceWhiteLevel": integer }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer }, "temporalFilterSettings": { "strength": integer, "speed": integer, "aggressiveMode": integer, "postTemporalSharpening": enum, "postTemporalSharpeningStrength": enum } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" }, "partnerWatermarking": { "nexguardFileMarkerSettings": { "license": "string", "preset": "string", "payload": integer, "strength": enum } } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "av1Settings": { "gopSize": number, "numberBFramesBetweenReferenceFrames": integer, "slices": integer, "bitDepth": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "qvbrQualityLevelFineTune": number }, "maxBitrate": integer, "adaptiveQuantization": enum, "spatialAdaptiveQuantization": enum, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "filmGrainSynthesis": enum }, "avcIntraSettings": { "avcIntraClass": enum, "avcIntraUhdSettings": { "qualityTuningLevel": enum }, "interlaceMode": enum, "scanTypeConversionMode": enum, "framerateDenominator": integer, "slowPal": enum, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum }, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "scanTypeConversionMode": 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, "qvbrQualityLevelFineTune": number, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "saliencyAwareEncoding": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum, "hrdBufferFinalFillPercentage": integer, "bandwidthReductionFilter": { "strength": enum, "sharpening": enum }, "endOfStreamMarkers": enum }, "h265Settings": { "interlaceMode": enum, "scanTypeConversionMode": 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, "qvbrQualityLevelFineTune": number, "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, "hrdBufferFinalFillPercentage": integer, "endOfStreamMarkers": enum, "bandwidthReductionFilter": { "strength": enum, "sharpening": enum } }, "mpeg2Settings": { "interlaceMode": enum, "scanTypeConversionMode": 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, "hrdBufferFinalFillPercentage": integer }, "proresSettings": { "interlaceMode": enum, "scanTypeConversionMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "chromaSampling": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum }, "uncompressedSettings": { "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "interlaceMode": enum, "scanTypeConversionMode": enum, "telecine": enum, "slowPal": enum, "fourcc": enum }, "vc3Settings": { "vc3Class": enum, "interlaceMode": enum, "scanTypeConversionMode": enum, "framerateConversionAlgorithm": enum, "telecine": enum, "slowPal": enum, "framerateControl": enum, "framerateDenominator": integer, "framerateNumerator": integer }, "vp8Settings": { "qualityTuningLevel": enum, "rateControlMode": enum, "gopSize": number, "maxBitrate": integer, "bitrate": integer, "hrdBufferSize": integer, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "parControl": enum, "parNumerator": integer, "parDenominator": integer }, "vp9Settings": { "qualityTuningLevel": enum, "rateControlMode": enum, "gopSize": number, "maxBitrate": integer, "bitrate": integer, "hrdBufferSize": integer, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "parControl": enum, "parNumerator": integer, "parDenominator": integer }, "xavcSettings": { "profile": enum, "xavcHdIntraCbgProfileSettings": { "xavcClass": enum }, "xavc4kIntraCbgProfileSettings": { "xavcClass": enum }, "xavc4kIntraVbrProfileSettings": { "xavcClass": enum }, "xavcHdProfileSettings": { "bitrateClass": enum, "slices": integer, "hrdBufferSize": integer, "qualityTuningLevel": enum, "interlaceMode": enum, "telecine": enum, "gopClosedCadence": integer, "gopBReference": enum, "flickerAdaptiveQuantization": enum }, "xavc4kProfileSettings": { "bitrateClass": enum, "slices": integer, "hrdBufferSize": integer, "codecProfile": enum, "qualityTuningLevel": enum, "gopClosedCadence": integer, "gopBReference": enum, "flickerAdaptiveQuantization": enum }, "softness": integer, "framerateDenominator": integer, "slowPal": enum, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "entropyEncoding": enum, "framerateControl": enum, "framerateNumerator": integer, "adaptiveQuantization": enum, "framerateConversionAlgorithm": 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, "truePeakLimiterThreshold": number }, "audioChannelTaggingSettings": { "channelTag": enum, "channelTags": [ 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, "dynamicRangeCompressionLine": enum, "dynamicRangeCompressionRf": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "eac3AtmosSettings": { "surroundExMode": enum, "loRoSurroundMixLevel": number, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "loRoCenterMixLevel": number, "codingMode": enum, "bitstreamMode": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "downmixControl": enum, "dynamicRangeControl": enum, "meteringMode": enum, "dialogueIntelligence": enum, "speechThreshold": integer }, "flacSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "mp3Settings": { "bitrate": integer, "channels": integer, "rateControlMode": enum, "sampleRate": integer, "vbrQuality": integer }, "opusSettings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "vorbisSettings": { "channels": integer, "sampleRate": integer, "vbrQuality": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ], "inputChannelsFineTune": [ number ] } ] }, "channelsIn": integer, "channelsOut": integer, "audioDescriptionAudioChannel": integer, "audioDescriptionDataChannel": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "outputSettings": { "hlsSettings": { "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": enum, "descriptiveVideoServiceFlag": enum, "iFrameOnlyManifest": enum, "segmentModifier": "string", "audioOnlyContainer": enum } }, "extension": "string", "nameModifier": "string", "captionDescriptions": [ { "captionSelectorName": "string", "destinationSettings": { "destinationType": enum, "burninDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fallbackFont": enum, "fontFileRegular": "string", "fontFileBold": "string", "fontFileItalic": "string", "fontFileBoldItalic": "string", "fontColor": enum, "hexFontColor": "string", "applyFontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer, "stylePassthrough": enum }, "dvbSubDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fallbackFont": enum, "fontFileRegular": "string", "fontFileBold": "string", "fontFileItalic": "string", "fontFileBoldItalic": "string", "fontColor": enum, "hexFontColor": "string", "applyFontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer, "subtitlingType": enum, "ddsHandling": enum, "ddsXCoordinate": integer, "ddsYCoordinate": integer, "width": integer, "height": integer, "stylePassthrough": enum }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string", "pageTypes": [ enum ] }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "imscDestinationSettings": { "stylePassthrough": enum, "accessibility": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": integer, "destination708ServiceNumber": integer }, "webvttDestinationSettings": { "stylePassthrough": enum, "accessibility": enum }, "srtDestinationSettings": { "stylePassthrough": enum } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } ], "outputGroupSettings": { "type": enum, "hlsGroupSettings": { "targetDurationCompatibilityMode": enum, "manifestDurationFormat": enum, "segmentLength": integer, "segmentLengthControl": enum, "timedMetadataId3Period": integer, "captionLanguageSetting": enum, "captionLanguageMappings": [ { "captionChannel": integer, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ], "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "encryption": { "encryptionMethod": enum, "constantInitializationVector": "string", "initializationVectorInManifest": enum, "offlineEncrypted": enum, "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } }, "staticKeyProvider": { "staticKeyValue": "string", "keyFormat": "string", "keyFormatVersions": "string", "url": "string" }, "type": enum }, "timedMetadataId3Frame": enum, "baseUrl": "string", "codecSpecification": enum, "outputSelection": enum, "programDateTimePeriod": integer, "segmentsPerSubdirectory": integer, "minSegmentLength": integer, "minFinalSegmentLength": number, "directoryStructure": enum, "programDateTime": enum, "adMarkers": [ enum ], "segmentControl": enum, "timestampDeltaMilliseconds": integer, "manifestCompression": enum, "clientCache": enum, "audioOnlyHeader": enum, "streamInfResolution": enum, "imageBasedTrickPlay": enum, "progressiveWriteHlsManifest": enum, "imageBasedTrickPlaySettings": { "thumbnailHeight": integer, "thumbnailWidth": integer, "tileHeight": integer, "tileWidth": integer, "intervalCadence": enum, "thumbnailInterval": number }, "captionSegmentLengthControl": enum }, "dashIsoGroupSettings": { "audioChannelConfigSchemeIdUri": enum, "segmentLength": integer, "minFinalSegmentLength": number, "segmentLengthControl": enum, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "encryption": { "playbackDeviceCompatibility": enum, "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } } }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": enum, "ptsOffsetHandlingForBFrames": enum, "mpdManifestBandwidthType": enum, "mpdProfile": enum, "hbbtvCompliance": enum, "writeSegmentTimelineInRepresentation": enum, "imageBasedTrickPlay": enum, "dashIFrameTrickPlayNameModifier": "string", "imageBasedTrickPlaySettings": { "thumbnailHeight": integer, "thumbnailWidth": integer, "tileHeight": integer, "tileWidth": integer, "intervalCadence": enum, "thumbnailInterval": number }, "videoCompositionOffsets": enum, "dashManifestStyle": enum }, "fileGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } } }, "msSmoothGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "fragmentLength": integer, "fragmentLengthControl": enum, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } } }, "manifestEncoding": enum, "audioDeduplication": enum }, "cmafGroupSettings": { "targetDurationCompatibilityMode": enum, "writeHlsManifest": enum, "writeDashManifest": enum, "segmentLength": integer, "segmentLengthControl": enum, "minFinalSegmentLength": number, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string", "kmsEncryptionContext": "string" }, "accessControl": { "cannedAcl": enum }, "storageClass": enum } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "encryption": { "encryptionMethod": enum, "constantInitializationVector": "string", "initializationVectorInManifest": enum, "spekeKeyProvider": { "resourceId": "string", "hlsSignaledSystemIds": [ "string" ], "dashSignaledSystemIds": [ "string" ], "url": "string", "certificateArn": "string", "encryptionContractConfiguration": { "spekeVideoPreset": enum, "spekeAudioPreset": enum } }, "staticKeyProvider": { "staticKeyValue": "string", "keyFormat": "string", "keyFormatVersions": "string", "url": "string" }, "type": enum }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": enum, "ptsOffsetHandlingForBFrames": enum, "mpdManifestBandwidthType": enum, "mpdProfile": enum, "writeSegmentTimelineInRepresentation": enum, "manifestDurationFormat": enum, "streamInfResolution": enum, "clientCache": enum, "manifestCompression": enum, "codecSpecification": enum, "imageBasedTrickPlay": enum, "dashIFrameTrickPlayNameModifier": "string", "imageBasedTrickPlaySettings": { "thumbnailHeight": integer, "thumbnailWidth": integer, "tileHeight": integer, "tileWidth": integer, "intervalCadence": enum, "thumbnailInterval": number }, "videoCompositionOffsets": enum, "dashManifestStyle": enum } }, "automatedEncodingSettings": { "abrSettings": { "maxRenditions": integer, "maxAbrBitrate": integer, "minAbrBitrate": integer, "rules": [ { "type": enum, "minTopRenditionSize": { "width": integer, "height": integer }, "minBottomRenditionSize": { "width": integer, "height": integer }, "forceIncludeRenditions": [ { "width": integer, "height": integer } ], "allowedRenditions": [ { "width": integer, "height": integer, "required": enum } ] } ] } } } ], "adAvailOffset": integer, "availBlanking": { "availBlankingImage": "string" }, "followSource": integer, "timedMetadataInsertion": { "id3Insertions": [ { "timecode": "string", "id3": "string" } ] }, "nielsenConfiguration": { "breakoutCode": integer, "distributorId": "string" }, "motionImageInserter": { "insertionMode": enum, "input": "string", "offset": { "imageX": integer, "imageY": integer }, "startTime": "string", "playback": enum, "framerate": { "framerateNumerator": integer, "framerateDenominator": integer } }, "esam": { "signalProcessingNotification": { "sccXml": "string" }, "manifestConfirmConditionNotification": { "mccXml": "string" }, "responseSignalPreroll": integer }, "nielsenNonLinearWatermark": { "sourceId": integer, "cbetSourceId": "string", "activeWatermarkProcess": enum, "assetId": "string", "assetName": "string", "episodeId": "string", "ticServerUrl": "string", "metadataDestination": "string", "uniqueTicPerAudioTrack": enum, "adiFilename": "string", "sourceWatermarkStatus": enum }, "kantarWatermark": { "credentialsSecretName": "string", "channelName": "string", "contentReference": "string", "kantarServerUrl": "string", "kantarLicenseId": integer, "logDestination": "string", "fileOffset": number, "metadata3": "string", "metadata4": "string", "metadata5": "string", "metadata6": "string", "metadata7": "string", "metadata8": "string" }, "extendedDataServices": { "vchipAction": enum, "copyProtectionAction": enum }, "colorConversion3DLUTSettings": [ { "inputMasteringLuminance": integer, "inputColorSpace": enum, "outputMasteringLuminance": integer, "outputColorSpace": enum, "fileInput": "string" } ], "inputs": [ { "inputClippings": [ { "endTimecode": "string", "startTimecode": "string" } ], "audioSelectors": { }, "audioSelectorGroups": { }, "programNumber": integer, "videoSelector": { "colorSpace": enum, "sampleRange": enum, "rotate": enum, "pid": integer, "programNumber": integer, "embeddedTimecodeOverride": enum, "alphaBehavior": enum, "colorSpaceUsage": enum, "padVideo": enum, "maxLuminance": 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 } }, "filterEnable": enum, "psiControl": enum, "filterStrength": integer, "deblockFilter": enum, "denoiseFilter": enum, "inputScanType": enum, "timecodeSource": enum, "timecodeStart": "string", "captionSelectors": { }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ], "sdrReferenceWhiteLevel": integer }, "dolbyVisionMetadataXml": "string", "crop": { "height": integer, "width": integer, "x": integer, "y": integer }, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "advancedInputFilter": enum, "advancedInputFilterSettings": { "sharpening": enum, "addTexture": enum }, "videoOverlays": [ { "input": { "fileInput": "string", "inputClippings": [ { "endTimecode": "string", "startTimecode": "string" } ], "timecodeSource": enum, "timecodeStart": "string" }, "endTimecode": "string", "startTimecode": "string", "initialPosition": { "xPosition": integer, "yPosition": integer, "width": integer, "height": integer, "unit": enum }, "playback": enum, "transitions": [ { "endTimecode": "string", "startTimecode": "string", "endPosition": { "xPosition": integer, "yPosition": integer, "width": integer, "height": integer, "unit": enum } } ] } ], "fileInput": "string", "videoGenerator": { "duration": integer, "framerateNumerator": integer, "framerateDenominator": integer, "sampleRate": integer, "channels": integer }, "decryptionSettings": { "decryptionMode": enum, "encryptedDecryptionKey": "string", "initializationVector": "string", "kmsKeyRegion": "string" }, "supplementalImps": [ "string" ] } ] }, "status": enum, "errorCode": integer, "errorMessage": "string", "timing": { "submitTime": "string", "startTime": "string", "finishTime": "string" }, "outputGroupDetails": [ { "outputDetails": [ { "durationInMs": integer, "videoDetails": { "widthInPx": integer, "heightInPx": integer } } ] } ], "billingTagsSource": enum, "accelerationSettings": { "mode": enum }, "statusUpdateInterval": enum, "jobPercentComplete": integer, "currentPhase": enum, "retryCount": integer, "priority": integer, "simulateReservedQueue": enum, "accelerationStatus": enum, "messages": { "info": [ "string" ], "warning": [ "string" ] }, "hopDestinations": [ { "waitMinutes": integer, "queue": "string", "priority": integer } ], "queueTransitions": [ { "timestamp": "string", "sourceQueue": "string", "destinationQueue": "string" } ], "clientRequestToken": "string", "warnings": [ { "code": integer, "count": integer } ] } }
{ "message": "string" }
Properties
AacAudioDescriptionBroadcasterMix
Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType.
BROADCASTER_MIXED_AD
NORMAL
AacCodecProfile
Specify the AAC profile. For the widest player compatibility and where higher bitrates are acceptable: Keep the default profile, LC (AAC-LC) For improved audio performance at lower bitrates: Choose HEV1 or HEV2. HEV1 (AAC-HE v1) adds spectral band replication to improve speech audio at low bitrates. HEV2 (AAC-HE v2) adds parametric stereo, which optimizes for encoding stereo audio at very low bitrates.
LC
HEV1
HEV2
AacCodingMode
The Coding mode that you specify determines the number of audio channels and the audio channel layout metadata in your AAC output. Valid coding modes depend on the Rate control mode and Profile that you select. The following list shows the number of audio channels and channel layout for each coding mode. * 1.0 Audio Description (Receiver Mix): One channel, C. Includes audio description data from your stereo input. For more information see ETSI TS 101 154 Annex E. * 1.0 Mono: One channel, C. * 2.0 Stereo: Two channels, L, R. * 5.1 Surround: Six channels, C, L, R, Ls, Rs, LFE.
AD_RECEIVER_MIX
CODING_MODE_1_0
CODING_MODE_1_1
CODING_MODE_2_0
CODING_MODE_5_1
AacRateControlMode
Specify the AAC rate control mode. For a constant bitrate: Choose CBR. Your AAC output bitrate will be equal to the value that you choose for Bitrate. For a variable bitrate: Choose VBR. Your AAC output bitrate will vary according to your audio content and the value that you choose for Bitrate quality.
CBR
VBR
AacRawFormat
Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose "No container" for the output container.
LATM_LOAS
NONE
AacSettings
Required when you set Codec 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 to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality. In CBR mode, you use the setting Bitrate. Defaults and valid values depend on the rate control mode.
Property | Type | Required | Description |
---|---|---|---|
audioDescriptionBroadcasterMix | False | Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType. | |
bitrate | integer Minimum: 6000 Maximum: 1024000 | False | Specify the average bitrate in bits per second. The set of valid values for this setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000. The value you set is also constrained by the values that you choose for Profile, Bitrate control mode, and Sample rate. Default values depend on Bitrate control mode and Profile. |
codecProfile | False | Specify the AAC profile. For the widest player compatibility and where higher bitrates are acceptable: Keep the default profile, LC (AAC-LC) For improved audio performance at lower bitrates: Choose HEV1 or HEV2. HEV1 (AAC-HE v1) adds spectral band replication to improve speech audio at low bitrates. HEV2 (AAC-HE v2) adds parametric stereo, which optimizes for encoding stereo audio at very low bitrates. | |
codingMode | False | The Coding mode that you specify determines the number of audio channels and the audio channel layout metadata in your AAC output. Valid coding modes depend on the Rate control mode and Profile that you select. The following list shows the number of audio channels and channel layout for each coding mode. * 1.0 Audio Description (Receiver Mix): One channel, C. Includes audio description data from your stereo input. For more information see ETSI TS 101 154 Annex E. * 1.0 Mono: One channel, C. * 2.0 Stereo: Two channels, L, R. * 5.1 Surround: Six channels, C, L, R, Ls, Rs, LFE. | |
rateControlMode | False | Specify the AAC rate control mode. For a constant bitrate: Choose CBR. Your AAC output bitrate will be equal to the value that you choose for Bitrate. For a variable bitrate: Choose VBR. Your AAC output bitrate will vary according to your audio content and the value that you choose for Bitrate quality. | |
rawFormat | False | Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose "No container" for the output container. | |
sampleRate | integer Minimum: 8000 Maximum: 96000 | False | Specify the AAC sample rate in samples per second (Hz). Valid sample rates depend on the AAC profile and Coding mode that you select. For a list of supported sample rates, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/aac-support.html |
specification | False | Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. | |
vbrQuality | False | Specify the quality of your variable bitrate (VBR) AAC audio. For a list of approximate VBR bitrates, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/aac-support.html#aac_vbr |
AacSpecification
Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
MPEG2
MPEG4
AacVbrQuality
Specify the quality of your variable bitrate (VBR) AAC audio. For a list of approximate VBR bitrates, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/aac-support.html#aac_vbr
LOW
MEDIUM_LOW
MEDIUM_HIGH
HIGH
Ac3BitstreamMode
Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).
COMPLETE_MAIN
COMMENTARY
DIALOGUE
EMERGENCY
HEARING_IMPAIRED
MUSIC_AND_EFFECTS
VISUALLY_IMPAIRED
VOICE_OVER
Ac3CodingMode
Dolby Digital coding mode. Determines number of channels.
CODING_MODE_1_0
CODING_MODE_1_1
CODING_MODE_2_0
CODING_MODE_3_2_LFE
Ac3DynamicRangeCompressionLine
Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the line operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.
FILM_STANDARD
FILM_LIGHT
MUSIC_STANDARD
MUSIC_LIGHT
SPEECH
NONE
Ac3DynamicRangeCompressionProfile
When you want to add Dolby dynamic range compression (DRC) signaling to your output stream, we recommend that you use the mode-specific settings instead of Dynamic range compression profile. The mode-specific settings are Dynamic range compression profile, line mode and Dynamic range compression profile, RF mode. Note that when you specify values for all three settings, MediaConvert ignores the value of this setting in favor of the mode-specific settings. If you do use this setting instead of the mode-specific settings, choose None to leave out DRC signaling. Keep the default Film standard to set the profile to Dolby's film standard profile for all operating modes.
FILM_STANDARD
NONE
Ac3DynamicRangeCompressionRf
Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the RF operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.
FILM_STANDARD
FILM_LIGHT
MUSIC_STANDARD
MUSIC_LIGHT
SPEECH
NONE
Ac3LfeFilter
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.
ENABLED
DISABLED
Ac3MetadataControl
When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
FOLLOW_INPUT
USE_CONFIGURED
Ac3Settings
Required when you set Codec to the value AC3.
Property | Type | Required | Description |
---|---|---|---|
bitrate | integer Minimum: 64000 Maximum: 640000 | False | Specify the average bitrate in bits per second. The bitrate that you specify must be a multiple of 8000 within the allowed minimum and maximum values. Leave blank to use the default bitrate for the coding mode you select according ETSI TS 102 366. Valid bitrates for coding mode 1/0: Default: 96000. Minimum: 64000. Maximum: 128000. Valid bitrates for coding mode 1/1: Default: 192000. Minimum: 128000. Maximum: 384000. Valid bitrates for coding mode 2/0: Default: 192000. Minimum: 128000. Maximum: 384000. Valid bitrates for coding mode 3/2 with FLE: Default: 384000. Minimum: 384000. Maximum: 640000. |
bitstreamMode | False | Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E). | |
codingMode | False | Dolby Digital coding mode. Determines number of channels. | |
dialnorm | integer Minimum: 1 Maximum: 31 | False | Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through. |
dynamicRangeCompressionLine | False | Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the line operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. | |
dynamicRangeCompressionProfile | False | When you want to add Dolby dynamic range compression (DRC) signaling to your output stream, we recommend that you use the mode-specific settings instead of Dynamic range compression profile. The mode-specific settings are Dynamic range compression profile, line mode and Dynamic range compression profile, RF mode. Note that when you specify values for all three settings, MediaConvert ignores the value of this setting in favor of the mode-specific settings. If you do use this setting instead of the mode-specific settings, choose None to leave out DRC signaling. Keep the default Film standard to set the profile to Dolby's film standard profile for all operating modes. | |
dynamicRangeCompressionRf | False | Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the RF operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. | |
lfeFilter | False | Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode. | |
metadataControl | False | When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | |
sampleRate | integer Minimum: 48000 Maximum: 48000 | False | This value is always 48000. It represents the sample rate in Hz. |
AccelerationMode
Specify whether the service runs your job with accelerated transcoding. Choose DISABLED if you don't want accelerated transcoding. Choose ENABLED if you want your job to run with accelerated transcoding and to fail if your input files or your job settings aren't compatible with accelerated transcoding. Choose PREFERRED if you want your job to run with accelerated transcoding if the job is compatible with the feature and to run at standard speed if it's not.
DISABLED
ENABLED
PREFERRED
AccelerationSettings
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
Property | Type | Required | Description |
---|---|---|---|
mode | True | Specify the conditions when the service will run your job with accelerated transcoding. |
AccelerationStatus
Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.
NOT_APPLICABLE
IN_PROGRESS
ACCELERATED
NOT_ACCELERATED
AdvancedInputFilter
Use to remove noise, blocking, blurriness, or ringing from your input as a pre-filter step before encoding. The Advanced input filter removes more types of compression artifacts and is an improvement when compared to basic Deblock and Denoise filters. To remove video compression artifacts from your input and improve the video quality: Choose Enabled. Additionally, this filter can help increase the video quality of your output relative to its bitrate, since noisy inputs are more complex and require more bits to encode. To help restore loss of detail after applying the filter, you can optionally add texture or sharpening as an additional step. Jobs that use this feature incur pro-tier pricing. To not apply advanced input filtering: Choose Disabled. Note that you can still apply basic filtering with Deblock and Denoise.
ENABLED
DISABLED
AdvancedInputFilterAddTexture
Add texture and detail to areas of your input video content that were lost after applying the Advanced input filter. To adaptively add texture and reduce softness: Choose Enabled. To not add any texture: Keep the default value, Disabled. We recommend that you choose Disabled for input video content that doesn't have texture, including screen recordings, computer graphics, or cartoons.
ENABLED
DISABLED
AdvancedInputFilterSettings
Optional settings for Advanced input filter when you set Advanced input filter to Enabled.
Property | Type | Required | Description |
---|---|---|---|
addTexture | False | Add texture and detail to areas of your input video content that were lost after applying the Advanced input filter. To adaptively add texture and reduce softness: Choose Enabled. To not add any texture: Keep the default value, Disabled. We recommend that you choose Disabled for input video content that doesn't have texture, including screen recordings, computer graphics, or cartoons. | |
sharpening | False | Optionally specify the amount of sharpening to apply when you use the Advanced input filter. Sharpening adds contrast to the edges of your video content and can reduce softness. To apply no sharpening: Keep the default value, Off. To apply a minimal amount of sharpening choose Low, or for the maximum choose High. |
AdvancedInputFilterSharpen
Optionally specify the amount of sharpening to apply when you use the Advanced input filter. Sharpening adds contrast to the edges of your video content and can reduce softness. To apply no sharpening: Keep the default value, Off. To apply a minimal amount of sharpening choose Low, or for the maximum choose High.
OFF
LOW
HIGH
AfdSignaling
This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling 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 to the value AIFF.
Property | Type | Required | Description |
---|---|---|---|
bitDepth | integer Minimum: 16 Maximum: 24 | False | Specify Bit depth, in bits per sample, to choose the encoding quality for this audio track. |
channels | integer Minimum: 1 Maximum: 64 | False | Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64. |
sampleRate | integer Minimum: 8000 Maximum: 192000 | False | Sample rate in Hz. |
AllowedRenditionSize
Use Allowed renditions to specify a list of possible resolutions in your ABR stack. * MediaConvert will create an ABR stack exclusively from the list of resolutions that you specify. * Some resolutions in the Allowed renditions list may not be included, however you can force a resolution to be included by setting Required to ENABLED. * You must specify at least one resolution that is greater than or equal to any resolutions that you specify in Min top rendition size or Min bottom rendition size. * If you specify Allowed renditions, you must not specify a separate rule for Force include renditions.
Property | Type | Required | Description |
---|---|---|---|
height | integer Minimum: 32 Maximum: 8192 | False | Use Height to define the video resolution height, in pixels, for this rule. |
required | False | Set to ENABLED to force a rendition to be included. | |
width | integer Minimum: 32 Maximum: 8192 | False | Use Width to define the video resolution width, in pixels, for this rule. |
AlphaBehavior
Ignore this setting unless this input is a QuickTime animation with an alpha channel. Use this setting to create separate Key and Fill outputs. In each output, specify which part of the input MediaConvert uses. Leave this setting at the default value DISCARD to delete the alpha channel and preserve the video. Set it to REMAP_TO_LUMA to delete the video and map the alpha channel to the luma channel of your outputs.
DISCARD
REMAP_TO_LUMA
AncillaryConvert608To708
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.
UPCONVERT
DISABLED
AncillarySourceSettings
Settings for ancillary captions source.
Property | Type | Required | Description |
---|---|---|---|
convert608To708 | False | Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708. | |
sourceAncillaryChannelNumber | integer Minimum: 1 Maximum: 4 | False | Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough. |
terminateCaptions | False | By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting. |
AncillaryTerminateCaptions
By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.
END_OF_INPUT
DISABLED
AntiAlias
The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.
DISABLED
ENABLED
AudioChannelTag
Specify the QuickTime audio channel layout tags for the audio channels in this audio track. Enter channel layout tags in the same order as your output's audio channel order. For example, if your output audio track has a left and a right channel, enter Left (L) for the first channel and Right (R) for the second. If your output has multiple single-channel audio tracks, enter a single channel layout tag for each track.
L
R
C
LFE
LS
RS
LC
RC
CS
LSD
RSD
TCS
VHL
VHC
VHR
TBL
TBC
TBR
RSL
RSR
LW
RW
LFE2
LT
RT
HI
NAR
M
AudioChannelTaggingSettings
Specify the QuickTime audio channel layout tags for the audio channels in this audio track. When you don't specify a value, MediaConvert labels your track as Center (C) by default. To use Audio layout tagging, your output must be in a QuickTime (MOV) container and your audio codec must be AAC, WAV, or AIFF.
Property | Type | Required | Description |
---|---|---|---|
channelTag | False | Specify the QuickTime audio channel layout tags for the audio channels in this audio track. Enter channel layout tags in the same order as your output's audio channel order. For example, if your output audio track has a left and a right channel, enter Left (L) for the first channel and Right (R) for the second. If your output has multiple single-channel audio tracks, enter a single channel layout tag for each track. | |
channelTags | Array of type AudioChannelTag | False | Specify the QuickTime audio channel layout tags for the audio channels in this audio track. Enter channel layout tags in the same order as your output's audio channel order. For example, if your output audio track has a left and a right channel, enter Left (L) for the first channel and Right (R) for the second. If your output has multiple single-channel audio tracks, enter a single channel layout tag for each track. |
AudioCodec
Choose the audio codec for this output. Note that the option Dolby Digital passthrough applies only to Dolby Digital and Dolby Digital Plus audio inputs. Make sure that you choose a codec that's supported with your output container: https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#reference-codecs-containers-output-audio For audio-only outputs, make sure that both your input audio codec and your output audio codec are supported for audio-only workflows. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers-input.html#reference-codecs-containers-input-audio-only and https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#audio-only-output
AAC
MP2
MP3
WAV
AIFF
AC3
EAC3
EAC3_ATMOS
VORBIS
OPUS
PASSTHROUGH
FLAC
AudioCodecSettings
Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your audio codec.
Property | Type | Required | Description |
---|---|---|---|
aacSettings | False | Required when you set Codec 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 to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality. In CBR mode, you use the setting Bitrate. Defaults and valid values depend on the rate control mode. | |
ac3Settings | False | Required when you set Codec to the value AC3. | |
aiffSettings | False | Required when you set Codec to the value AIFF. | |
codec | False | Choose the audio codec for this output. Note that the option Dolby Digital passthrough applies only to Dolby Digital and Dolby Digital Plus audio inputs. Make sure that you choose a codec that's supported with your output container: https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#reference-codecs-containers-output-audio For audio-only outputs, make sure that both your input audio codec and your output audio codec are supported for audio-only workflows. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers-input.html#reference-codecs-containers-input-audio-only and https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#audio-only-output | |
eac3AtmosSettings | False | Required when you set Codec to the value EAC3_ATMOS. | |
eac3Settings | False | Required when you set Codec to the value EAC3. | |
flacSettings | False | Required when you set Codec, under AudioDescriptions>CodecSettings, to the value FLAC. | |
mp2Settings | False | Required when you set Codec to the value MP2. | |
mp3Settings | False | Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3. | |
opusSettings | False | Required when you set Codec, under AudioDescriptions>CodecSettings, to the value OPUS. | |
vorbisSettings | False | Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis. | |
wavSettings | False | Required when you set Codec to the value WAV. |
AudioDefaultSelection
Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.
DEFAULT
NOT_DEFAULT
AudioDescription
Settings related to one audio tab on the MediaConvert console. In your job JSON, an instance of AudioDescription is equivalent to one audio tab in the console. Usually, one audio tab corresponds to one output audio track. Depending on how you set up your input audio selectors and whether you use audio selector groups, one audio tab can correspond to a group of output audio tracks.
Property | Type | Required | Description |
---|---|---|---|
audioChannelTaggingSettings | False | Specify the QuickTime audio channel layout tags for the audio channels in this audio track. When you don't specify a value, MediaConvert labels your track as Center (C) by default. To use Audio layout tagging, your output must be in a QuickTime (MOV) container and your audio codec must be AAC, WAV, or AIFF. | |
audioNormalizationSettings | False | Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard. | |
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. |
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. |
audioTypeControl | False | When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD. | |
codecSettings | False | Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your audio codec. | |
customLanguageCode | string Pattern: | False | Specify the language for this audio output track. The service puts this language code into your output audio track when you set Language code control to Use configured. The service also uses your specified custom language code when you set Language code control to Follow input, but your input file doesn't specify a language code. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming. |
languageCode | False | Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input. | |
languageCodeControl | False | Specify which source for language code takes precedence for this audio track. When you choose Follow input, the service uses the language code from the input track if it's present. If there's no languge code on the input track, the service uses the code that you specify in the setting Language code. When you choose Use configured, the service uses the language code that you specify. | |
remixSettings | False | Advanced audio remixing settings. | |
streamName | string Pattern: | False | Specify a label for this output audio stream. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting. |
AudioDurationCorrection
Apply audio timing corrections to help synchronize audio and video in your output. To apply timing corrections, your input must meet the following requirements: * Container: MP4, or MOV, with an accurate time-to-sample (STTS) table. * Audio track: AAC. Choose from the following audio timing correction settings: * Disabled (Default): Apply no correction. * Auto: Recommended for most inputs. MediaConvert analyzes the audio timing in your input and determines which correction setting to use, if needed. * Track: Adjust the duration of each audio frame by a constant amount to align the audio track length with STTS duration. Track-level correction does not affect pitch, and is recommended for tonal audio content such as music. * Frame: Adjust the duration of each audio frame by a variable amount to align audio frames with STTS timestamps. No corrections are made to already-aligned frames. Frame-level correction may affect the pitch of corrected frames, and is recommended for atonal audio content such as speech or percussion. * Force: Apply audio duration correction, either Track or Frame depending on your input, regardless of the accuracy of your input's STTS table. Your output audio and video may not be aligned or it may contain audio artifacts.
DISABLED
AUTO
TRACK
FRAME
FORCE
AudioLanguageCodeControl
Specify which source for language code takes precedence for this audio track. When you choose Follow input, the service uses the language code from the input track if it's present. If there's no languge code on the input track, the service uses the code that you specify in the setting Language code. When you choose Use configured, the service uses the language code that you specify.
FOLLOW_INPUT
USE_CONFIGURED
AudioNormalizationAlgorithm
Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.
ITU_BS_1770_1
ITU_BS_1770_2
ITU_BS_1770_3
ITU_BS_1770_4
AudioNormalizationAlgorithmControl
When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.
CORRECT_AUDIO
MEASURE_ONLY
AudioNormalizationLoudnessLogging
If set to LOG, log each output's audio track loudness to a CSV file.
LOG
DONT_LOG
AudioNormalizationPeakCalculation
If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.
TRUE_PEAK
NONE
AudioNormalizationSettings
Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.
Property | Type | Required | Description |
---|---|---|---|
algorithm | False | Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1. | |
algorithmControl | False | When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted. | |
correctionGateLevel | integer Minimum: -70 Maximum: 0 | False | Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected. |
loudnessLogging | False | If set to LOG, log each output's audio track loudness to a CSV file. | |
peakCalculation | False | If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness. | |
targetLkfs | number Format: float Minimum: -59.0 Maximum: 0.0 | False | When you use Audio normalization, optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm. If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS. |
truePeakLimiterThreshold | number Format: float Minimum: -8.0 Maximum: 0.0 | False | Specify the True-peak limiter threshold in decibels relative to full scale (dBFS). The peak inter-audio sample loudness in your output will be limited to the value that you specify, without affecting the overall target LKFS. Enter a value from 0 to -8. Leave blank to use the default value 0. |
AudioSelector
Use Audio selectors to specify a track or set of tracks from the input that you will use in your outputs. You can use multiple Audio selectors per input.
Property | Type | Required | Description |
---|---|---|---|
audioDurationCorrection | False | Apply audio timing corrections to help synchronize audio and video in your output. To apply timing corrections, your input must meet the following requirements: * Container: MP4, or MOV, with an accurate time-to-sample (STTS) table. * Audio track: AAC. Choose from the following audio timing correction settings: * Disabled (Default): Apply no correction. * Auto: Recommended for most inputs. MediaConvert analyzes the audio timing in your input and determines which correction setting to use, if needed. * Track: Adjust the duration of each audio frame by a constant amount to align the audio track length with STTS duration. Track-level correction does not affect pitch, and is recommended for tonal audio content such as music. * Frame: Adjust the duration of each audio frame by a variable amount to align audio frames with STTS timestamps. No corrections are made to already-aligned frames. Frame-level correction may affect the pitch of corrected frames, and is recommended for atonal audio content such as speech or percussion. * Force: Apply audio duration correction, either Track or Frame depending on your input, regardless of the accuracy of your input's STTS table. Your output audio and video may not be aligned or it may contain audio artifacts. | |
customLanguageCode | string Pattern: MinLength: 3 MaxLength: 3 | False | Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code |
defaultSelection | False | Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio. | |
externalAudioFileInput | string Pattern: | False | Specifies audio data from an external file source. |
hlsRenditionGroupSettings | False | Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead. | |
languageCode | False | Selects a specific language code from within an audio source. | |
offset | integer Minimum: -2147483648 Maximum: 2147483647 | False | Specifies a time delta in milliseconds to offset the audio from the input video. |
pids | Array of type integer Minimum: 1 Maximum: 2147483647 | False | Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101). |
programSelection | integer Minimum: 0 Maximum: 8 | False | Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track. |
remixSettings | False | Use these settings to reorder the audio channels of one input to match those of another input. This allows you to combine the two files into a single output, one after the other. | |
selectorType | False | Specifies the type of the audio selector. | |
tracks | Array of type integer Minimum: 1 Maximum: 2147483647 | False | Identify a track from the input audio to include in this selector by entering the track index number. To include several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a comma-separated list. For example, type "1,2,3" to include tracks 1 through 3. |
AudioSelectorGroup
Use audio selector groups to combine multiple sidecar audio inputs so that you can assign them to a single output audio tab. Note that, if you're working with embedded audio, it's simpler to assign multiple input tracks into a single audio selector rather than use an audio selector group.
Property | Type | Required | Description |
---|---|---|---|
audioSelectorNames | Array of type string MinLength: 1 | False | Name of an Audio Selector within the same input to include in the group. Audio selector names are standardized, based on their order within the input (e.g., "Audio Selector 1"). The audio selector name parameter can be repeated to add any number of audio selectors to the group. |
AudioSelectorType
Specifies the type of the audio selector.
PID
TRACK
LANGUAGE_CODE
HLS_RENDITION_GROUP
AudioTypeControl
When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.
FOLLOW_INPUT
USE_CONFIGURED
AutomatedAbrRule
Specify one or more Automated ABR rule types. Note: Force include and Allowed renditions are mutually exclusive.
Property | Type | Required | Description |
---|---|---|---|
allowedRenditions | Array of type AllowedRenditionSize | False | When customer adds the allowed renditions rule for auto ABR ladder, they are required to add at leat one rendition to allowedRenditions list |
forceIncludeRenditions | Array of type ForceIncludeRenditionSize | False | When customer adds the force include renditions rule for auto ABR ladder, they are required to add at leat one rendition to forceIncludeRenditions list |
minBottomRenditionSize | False | Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size. | |
minTopRenditionSize | False | Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution. | |
type | False | Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution. Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size. Use Force include renditions to specify one or more resolutions to include your ABR stack. * (Recommended) To optimize automated ABR, specify as few resolutions as possible. * (Required) The number of resolutions that you specify must be equal to, or less than, the Max renditions setting. * If you specify a Min top rendition size rule, specify at least one resolution that is equal to, or greater than, Min top rendition size. * If you specify a Min bottom rendition size rule, only specify resolutions that are equal to, or greater than, Min bottom rendition size. * If you specify a Force include renditions rule, do not specify a separate rule for Allowed renditions. * Note: The ABR stack may include other resolutions that you do not specify here, depending on the Max renditions setting. Use Allowed renditions to specify a list of possible resolutions in your ABR stack. * (Required) The number of resolutions that you specify must be equal to, or greater than, the Max renditions setting. * MediaConvert will create an ABR stack exclusively from the list of resolutions that you specify. * Some resolutions in the Allowed renditions list may not be included, however you can force a resolution to be included by setting Required to ENABLED. * You must specify at least one resolution that is greater than or equal to any resolutions that you specify in Min top rendition size or Min bottom rendition size. * If you specify Allowed renditions, you must not specify a separate rule for Force include renditions. |
AutomatedAbrSettings
Use automated ABR to have MediaConvert set up the renditions in your ABR package for you automatically, based on characteristics of your input video. This feature optimizes video quality while minimizing the overall size of your ABR package.
Property | Type | Required | Description |
---|---|---|---|
maxAbrBitrate | integer Minimum: 100000 Maximum: 100000000 | False | Specify the maximum average bitrate for MediaConvert to use in your automated ABR stack. If you don't specify a value, MediaConvert uses 8,000,000 (8 mb/s) by default. The average bitrate of your highest-quality rendition will be equal to or below this value, depending on the quality, complexity, and resolution of your content. Note that the instantaneous maximum bitrate may vary above the value that you specify. |
maxRenditions | integer Minimum: 3 Maximum: 15 | False | Optional. The maximum number of renditions that MediaConvert will create in your automated ABR stack. The number of renditions is determined automatically, based on analysis of each job, but will never exceed this limit. When you set this to Auto in the console, which is equivalent to excluding it from your JSON job specification, MediaConvert defaults to a limit of 15. |
minAbrBitrate | integer Minimum: 100000 Maximum: 100000000 | False | Specify the minimum average bitrate for MediaConvert to use in your automated ABR stack. If you don't specify a value, MediaConvert uses 600,000 (600 kb/s) by default. The average bitrate of your lowest-quality rendition will be near this value. Note that the instantaneous minimum bitrate may vary below the value that you specify. |
rules | Array of type AutomatedAbrRule | False | Optional. Use Automated ABR rules to specify restrictions for the rendition sizes MediaConvert will create in your ABR stack. You can use these rules if your ABR workflow has specific rendition size requirements, but you still want MediaConvert to optimize for video quality and overall file size. |
AutomatedEncodingSettings
Use automated encoding to have MediaConvert choose your encoding settings for you, based on characteristics of your input video.
Property | Type | Required | Description |
---|---|---|---|
abrSettings | False | Use automated ABR to have MediaConvert set up the renditions in your ABR package for you automatically, based on characteristics of your input video. This feature optimizes video quality while minimizing the overall size of your ABR package. |
Av1AdaptiveQuantization
Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to Spatial adaptive quantization.
OFF
LOW
MEDIUM
HIGH
HIGHER
MAX
Av1BitDepth
Specify the Bit depth. You can choose 8-bit or 10-bit.
BIT_8
BIT_10
Av1FilmGrainSynthesis
Film grain synthesis replaces film grain present in your content with similar quality synthesized AV1 film grain. We recommend that you choose Enabled to reduce the bandwidth of your QVBR quality level 5, 6, 7, or 8 outputs. For QVBR quality level 9 or 10 outputs we recommend that you keep the default value, Disabled. When you include Film grain synthesis, you cannot include the Noise reducer preprocessor.
DISABLED
ENABLED
Av1FramerateControl
Use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction.
INITIALIZE_FROM_SOURCE
SPECIFIED
Av1FramerateConversionAlgorithm
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.
DUPLICATE_DROP
INTERPOLATE
FRAMEFORMER
Av1QvbrSettings
Settings for quality-defined variable bitrate encoding with the AV1 codec. Use these settings only when you set QVBR for Rate control mode.
Property | Type | Required | Description |
---|---|---|---|
qvbrQualityLevel | integer Minimum: 1 Maximum: 10 | False | Use this setting only when you set Rate control mode to QVBR. Specify the target quality level for this output. MediaConvert determines the right number of bits to use for each part of the video to maintain the video quality that you specify. When you keep the default value, AUTO, MediaConvert picks a quality level for you, based on characteristics of your input video. If you prefer to specify a quality level, specify a number from 1 through 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. Optionally, to specify a value between whole numbers, also provide a value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. |
qvbrQualityLevelFineTune | number Format: float Minimum: 0.0 Maximum: 1.0 | False | Optional. Specify a value here to set the QVBR quality to a level that is between whole numbers. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33. |
Av1RateControlMode
'With AV1 outputs, for rate control mode, MediaConvert supports only quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.'
QVBR
Av1Settings
Required when you set Codec, under VideoDescription>CodecSettings to the value AV1.
Property | Type | Required | Description |
---|---|---|---|
adaptiveQuantization | False | Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to Spatial adaptive quantization. | |
bitDepth | False | Specify the Bit depth. You can choose 8-bit or 10-bit. | |
filmGrainSynthesis | False | Film grain synthesis replaces film grain present in your content with similar quality synthesized AV1 film grain. We recommend that you choose Enabled to reduce the bandwidth of your QVBR quality level 5, 6, 7, or 8 outputs. For QVBR quality level 9 or 10 outputs we recommend that you keep the default value, Disabled. When you include Film grain synthesis, you cannot include the Noise reducer preprocessor. | |
framerateControl | False | Use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. | |
framerateConversionAlgorithm | False | Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. | |
framerateDenominator | integer Minimum: 1 Maximum: 2147483647 | False | When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. |
framerateNumerator | integer Minimum: 1 Maximum: 2147483647 | False | When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. |
gopSize | number Format: float Minimum: 0.0 | False | Specify the GOP length (keyframe interval) in frames. With AV1, MediaConvert doesn't support GOP length in seconds. This value must be greater than zero and preferably equal to 1 + ((numberBFrames + 1) * x), where x is an integer value. |
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. |
numberBFramesBetweenReferenceFrames | integer Minimum: 0 Maximum: 15 | False | Specify from the number of B-frames, in the range of 0-15. For AV1 encoding, we recommend using 7 or 15. Choose a larger number for a lower bitrate and smaller file size; choose a smaller number for better video quality. |
qvbrSettings | False | Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set QVBR for Rate control mode. | |
rateControlMode | False | 'With AV1 outputs, for rate control mode, MediaConvert supports only quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.' | |
slices | integer Minimum: 1 Maximum: 32 | False | Specify the number of slices per picture. This value must be 1, 2, 4, 8, 16, or 32. For progressive pictures, this value must be less than or equal to the number of macroblock rows. For interlaced pictures, this value must be less than or equal to half the number of macroblock rows. |
spatialAdaptiveQuantization | False | Keep the default value, Enabled, to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher. |
Av1SpatialAdaptiveQuantization
Keep the default value, Enabled, to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.
DISABLED
ENABLED
AvailBlanking
Use ad avail blanking settings to specify your output content during SCTE-35 triggered ad avails. You can blank your video or overlay it with an image. MediaConvert also removes any audio and embedded captions during the ad avail. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ad-avail-blanking.html.
Property | Type | Required | Description |
---|---|---|---|
availBlankingImage | string Pattern: MinLength: 14 | False | Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. |
AvcIntraClass
Specify the AVC-Intra class of your output. The AVC-Intra class selection determines the output video bit rate depending on the frame rate of the output. Outputs with higher class values have higher bitrates and improved image quality. Note that for Class 4K/2K, MediaConvert supports only 4:2:2 chroma subsampling.
CLASS_50
CLASS_100
CLASS_200
CLASS_4K_2K
AvcIntraFramerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction.
INITIALIZE_FROM_SOURCE
SPECIFIED
AvcIntraFramerateConversionAlgorithm
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.
DUPLICATE_DROP
INTERPOLATE
FRAMEFORMER
AvcIntraInterlaceMode
Choose the scan line type for the output. Keep the default value, Progressive to create a progressive output, regardless of the scan type of your input. Use Top field first or Bottom field first to create an output that's interlaced with the same field polarity throughout. Use Follow, default top or Follow, default bottom to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.
PROGRESSIVE
TOP_FIELD
BOTTOM_FIELD
FOLLOW_TOP_FIELD
FOLLOW_BOTTOM_FIELD
AvcIntraScanTypeConversionMode
Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing to create a better quality interlaced output. In this case, each progressive frame from the input corresponds to an interlaced field in the output. Keep the default value, Basic interlacing, for all other output frame rates. With basic interlacing, MediaConvert performs any frame rate conversion first and then interlaces the frames. When you choose Optimized interlacing and you set your output frame rate to a value that isn't suitable for optimized interlacing, MediaConvert automatically falls back to basic interlacing. Required settings: To use optimized interlacing, you must set Telecine to None or Soft. You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode to a value other than Progressive.
INTERLACED
INTERLACED_OPTIMIZE
AvcIntraSettings
Required when you choose AVC-Intra for your output video codec. For more information about the AVC-Intra settings, see the relevant specification. For detailed information about SD and HD in AVC-Intra, see https://ieeexplore.ieee.org/document/7290936. For information about 4K/2K in AVC-Intra, see https://pro-av.panasonic.net/en/avc-ultra/AVC-ULTRAoverview.pdf.
Property | Type | Required | Description |
---|---|---|---|
avcIntraClass | False | Specify the AVC-Intra class of your output. The AVC-Intra class selection determines the output video bit rate depending on the frame rate of the output. Outputs with higher class values have higher bitrates and improved image quality. Note that for Class 4K/2K, MediaConvert supports only 4:2:2 chroma subsampling. | |
avcIntraUhdSettings | False | Optional when you set AVC-Intra class to Class 4K/2K. When you set AVC-Intra class to a different value, this object isn't allowed. | |
framerateControl | False | If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. | |
framerateConversionAlgorithm | False | Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. | |
framerateDenominator | integer Minimum: 1 Maximum: 1001 | False | When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. |
framerateNumerator | integer Minimum: 24 Maximum: 60000 | False | When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. |
interlaceMode | False | Choose the scan line type for the output. Keep the default value, Progressive to create a progressive output, regardless of the scan type of your input. Use Top field first or Bottom field first to create an output that's interlaced with the same field polarity throughout. Use Follow, default top or Follow, default bottom to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose. | |
scanTypeConversionMode | False | Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing to create a better quality interlaced output. In this case, each progressive frame from the input corresponds to an interlaced field in the output. Keep the default value, Basic interlacing, for all other output frame rates. With basic interlacing, MediaConvert performs any frame rate conversion first and then interlaces the frames. When you choose Optimized interlacing and you set your output frame rate to a value that isn't suitable for optimized interlacing, MediaConvert automatically falls back to basic interlacing. Required settings: To use optimized interlacing, you must set Telecine to None or Soft. You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode to a value other than Progressive. | |
slowPal | False | Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. | |
telecine | False | When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine to create a smoother picture. When you keep the default value, None, MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture. |
AvcIntraSlowPal
Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25.
DISABLED
ENABLED
AvcIntraTelecine
When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine to create a smoother picture. When you keep the default value, None, MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.
NONE
HARD
AvcIntraUhdQualityTuningLevel
Optional. Use Quality tuning level to choose how many transcoding passes MediaConvert does with your video. When you choose Multi-pass, your video quality is better and your output bitrate is more accurate. That is, the actual bitrate of your output is closer to the target bitrate defined in the specification. When you choose Single-pass, your encoding time is faster. The default behavior is Single-pass.
SINGLE_PASS
MULTI_PASS
AvcIntraUhdSettings
Optional when you set AVC-Intra class to Class 4K/2K. When you set AVC-Intra class to a different value, this object isn't allowed.
Property | Type | Required | Description |
---|---|---|---|
qualityTuningLevel | False | Optional. Use Quality tuning level to choose how many transcoding passes MediaConvert does with your video. When you choose Multi-pass, your video quality is better and your output bitrate is more accurate. That is, the actual bitrate of your output is closer to the target bitrate defined in the specification. When you choose Single-pass, your encoding time is faster. The default behavior is Single-pass. |
BandwidthReductionFilter
The Bandwidth reduction filter increases the video quality of your output relative to its bitrate. Use to lower the bitrate of your constant quality QVBR output, with little or no perceptual decrease in quality. Or, use to increase the video quality of outputs with other rate control modes relative to the bitrate that you specify. Bandwidth reduction increases further when your input is low quality or noisy. Outputs that use this feature incur pro-tier pricing. When you include Bandwidth reduction filter, you cannot include the Noise reducer preprocessor.
Property | Type | Required | Description |
---|---|---|---|
sharpening | False | Optionally specify the level of sharpening to apply when you use the Bandwidth reduction filter. Sharpening adds contrast to the edges of your video content and can reduce softness. Keep the default value Off to apply no sharpening. Set Sharpening strength to Low to apply a minimal amount of sharpening, or High to apply a maximum amount of sharpening. | |
strength | False | Specify the strength of the Bandwidth reduction filter. For most workflows, we recommend that you choose Auto to reduce the bandwidth of your output with little to no perceptual decrease in video quality. For high quality and high bitrate outputs, choose Low. For the most bandwidth reduction, choose High. We recommend that you choose High for low bitrate outputs. Note that High may incur a slight increase in the softness of your output. |
BandwidthReductionFilterSharpening
Optionally specify the level of sharpening to apply when you use the Bandwidth reduction filter. Sharpening adds contrast to the edges of your video content and can reduce softness. Keep the default value Off to apply no sharpening. Set Sharpening strength to Low to apply a minimal amount of sharpening, or High to apply a maximum amount of sharpening.
LOW
MEDIUM
HIGH
OFF
BandwidthReductionFilterStrength
Specify the strength of the Bandwidth reduction filter. For most workflows, we recommend that you choose Auto to reduce the bandwidth of your output with little to no perceptual decrease in video quality. For high quality and high bitrate outputs, choose Low. For the most bandwidth reduction, choose High. We recommend that you choose High for low bitrate outputs. Note that High may incur a slight increase in the softness of your output.
LOW
MEDIUM
HIGH
AUTO
OFF
BillingTagsSource
The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.
QUEUE
PRESET
JOB_TEMPLATE
JOB
BurnInSubtitleStylePassthrough
To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. Note that MediaConvert uses default settings for any missing style or position information in your input captions To ignore the style and position information from your input captions and use default settings: Leave blank or keep the default value, Disabled. Default settings include white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings. You can also override any fonts by manually specifying custom font files.
ENABLED
DISABLED
BurninDestinationSettings
Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html.
Property | Type | Required | Description |
---|---|---|---|
alignment | False | Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign 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. | |
applyFontColor | False | Ignore this setting unless Style passthrough is set to Enabled and Font color set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color for additional font color controls. When you choose White text only, or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text. | |
backgroundColor | False | Specify the color of the rectangle behind the captions. Leave background color blank and set Style passthrough to enabled to use the background color data from your input captions, if present. | |
backgroundOpacity | integer Minimum: 0 Maximum: 255 | False | Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all backgrounds from your output captions. |
fallbackFont | False | Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font to best match, or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input. | |
fontColor | False | Specify the color of the burned-in captions text. Leave Font color blank and set Style passthrough to enabled to use the font color data from your input captions, if present. | |
fontFileBold | string Pattern: | False | Specify a bold TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, an italic, and a bold italic font file. |
fontFileBoldItalic | string | False | Specify a bold italic TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, a bold, and an italic font file. |
fontFileItalic | string Pattern: | False | Specify an italic TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, a bold, and a bold italic font file. |
fontFileRegular | string Pattern: | False | Specify a regular TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a bold, an italic, and a bold italic font file. |
fontOpacity | integer Minimum: 0 Maximum: 255 | False | Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent. |
fontResolution | integer Minimum: 96 Maximum: 600 | False | Specify the Font resolution in DPI (dots per inch). |
fontScript | False | Set Font script to Automatically determined, or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese. | |
fontSize | integer Minimum: 0 Maximum: 96 | False | Specify the Font size in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size. |
hexFontColor | string Pattern: MinLength: 6 MaxLength: 8 | False | Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB. |
outlineColor | False | Specify font outline color. Leave Outline color blank and set Style passthrough to enabled to use the font outline color data from your input captions, if present. | |
outlineSize | integer Minimum: 0 Maximum: 10 | False | Specify the Outline size of the caption text, in pixels. Leave Outline size blank and set Style passthrough to enabled to use the outline size data from your input captions, if present. |
shadowColor | False | Specify the color of the shadow cast by the captions. Leave Shadow color blank and set Style passthrough to enabled to use the shadow color data from your input captions, if present. | |
shadowOpacity | integer Minimum: 0 Maximum: 255 | False | Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to Enabled, leave Shadow opacity blank to pass through the shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all shadows from your output captions. |
shadowXOffset | integer Minimum: -2147483648 Maximum: 2147483647 | False | Specify 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. |
shadowYOffset | integer Minimum: -2147483648 Maximum: 2147483647 | False | Specify 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. Leave Shadow y-offset blank and set Style passthrough to enabled to use the shadow y-offset data from your input captions, if present. |
stylePassthrough | False | To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. Note that MediaConvert uses default settings for any missing style or position information in your input captions To ignore the style and position information from your input captions and use default settings: Leave blank or keep the default value, Disabled. Default settings include white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings. You can also override any fonts by manually specifying custom font files. | |
teletextSpacing | False | Specify whether the text spacing 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 for closed captions. | |
xPosition | integer Minimum: 0 Maximum: 2147483647 | False | Specify the horizontal position of the captions, 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. |
yPosition | integer Minimum: 0 Maximum: 2147483647 | False | Specify the vertical position of the captions, 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. |
BurninSubtitleAlignment
Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign 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.
CENTERED
LEFT
AUTO
BurninSubtitleApplyFontColor
Ignore this setting unless Style passthrough is set to Enabled and Font color set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color for additional font color controls. When you choose White text only, or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.
WHITE_TEXT_ONLY
ALL_TEXT
BurninSubtitleBackgroundColor
Specify the color of the rectangle behind the captions. Leave background color blank and set Style passthrough to enabled to use the background color data from your input captions, if present.
NONE
BLACK
WHITE
AUTO
BurninSubtitleFallbackFont
Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font to best match, or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.
BEST_MATCH
MONOSPACED_SANSSERIF
MONOSPACED_SERIF
PROPORTIONAL_SANSSERIF
PROPORTIONAL_SERIF
BurninSubtitleFontColor
Specify the color of the burned-in captions text. Leave Font color blank and set Style passthrough to enabled to use the font color data from your input captions, if present.
WHITE
BLACK
YELLOW
RED
GREEN
BLUE
HEX
AUTO
BurninSubtitleOutlineColor
Specify font outline color. Leave Outline color blank and set Style passthrough to enabled to use the font outline color data from your input captions, if present.
BLACK
WHITE
YELLOW
RED
GREEN
BLUE
AUTO
BurninSubtitleShadowColor
Specify the color of the shadow cast by the captions. Leave Shadow color blank and set Style passthrough to enabled to use the shadow color data from your input captions, if present.
NONE
BLACK
WHITE
AUTO
BurninSubtitleTeletextSpacing
Specify whether the text spacing 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 for closed captions.
FIXED_GRID
PROPORTIONAL
AUTO
CaptionDescription
This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions.
Property | Type | Required | Description |
---|---|---|---|
captionSelectorName | string MinLength: 1 | False | Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input. |
customLanguageCode | string Pattern: | False | Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming. |
destinationSettings | False | Settings related to one captions tab on the MediaConvert console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html. | |
languageCode | False | Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text. | |
languageDescription | string | False | Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting. |
CaptionDestinationSettings
Settings related to one captions tab on the MediaConvert console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.
Property | Type | Required | Description |
---|---|---|---|
burninDestinationSettings | False | Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. | |
destinationType | False | Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20. | |
dvbSubDestinationSettings | False | Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. | |
embeddedDestinationSettings | False | Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. | |
imscDestinationSettings | False | Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. | |
sccDestinationSettings | False | Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. | |
srtDestinationSettings | False | Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. | |
teletextDestinationSettings | False | Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html. | |
ttmlDestinationSettings | False | Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. | |
webvttDestinationSettings | False | Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. |
CaptionDestinationType
Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20.
BURN_IN
DVB_SUB
EMBEDDED
EMBEDDED_PLUS_SCTE20
IMSC
SCTE20_PLUS_EMBEDDED
SCC
SRT
SMI
TELETEXT
TTML
WEBVTT
CaptionSelector
Use captions selectors to specify the captions data from your input that you use in your outputs. You can use up to 100 captions selectors per input.
Property | Type | Required | Description |
---|---|---|---|
customLanguageCode | string Pattern: MinLength: 3 MaxLength: 3 | False | The specific language to extract from source, using the ISO 639-2 or ISO 639-3 three-letter language code. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions. |
languageCode | False | The specific language to extract from source. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions. | |
sourceSettings | False | If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings. |
CaptionSourceByteRateLimit
Choose whether to limit the byte rate at which your SCC input captions are inserted into your output. To not limit the caption rate: We recommend that you keep the default value, Disabled. MediaConvert inserts captions in your output according to the byte rates listed in the EIA-608 specification, typically 2 or 3 caption bytes per frame depending on your output frame rate. To limit your output caption rate: Choose Enabled. Choose this option if your downstream systems require a maximum of 2 caption bytes per frame. Note that this setting has no effect when your output frame rate is 30 or 60.
ENABLED
DISABLED
CaptionSourceConvertPaintOnToPopOn
Choose the presentation style of your input SCC captions. To use the same presentation style as your input: Keep the default value, Disabled. To convert paint-on captions to pop-on: Choose Enabled. We also recommend that you choose Enabled if you notice additional repeated lines in your output captions.
ENABLED
DISABLED
CaptionSourceFramerate
Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction. For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.
Property | Type | Required | Description |
---|---|---|---|
framerateDenominator | integer Minimum: 1 Maximum: 1001 | False | Specify the denominator of the fraction that represents the frame rate for the setting Caption source frame rate. Use this setting along with the setting Framerate numerator. |
framerateNumerator | integer Minimum: 1 Maximum: 60000 | False | Specify the numerator of the fraction that represents the frame rate for the setting Caption source frame rate. Use this setting along with the setting Framerate denominator. |
CaptionSourceSettings
If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
Property | Type | Required | Description |
---|---|---|---|
ancillarySourceSettings | False | Settings for ancillary captions source. | |
dvbSubSourceSettings | False | DVB Sub Source Settings | |
embeddedSourceSettings | False | Settings for embedded captions Source | |
fileSourceSettings | False | If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings. | |
sourceType | False | Use Source to identify the format of your input captions. The service cannot auto-detect caption format. | |
teletextSourceSettings | False | Settings specific to Teletext caption sources, including Page number. | |
trackSourceSettings | False | Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings. | |
webvttHlsSourceSettings | False | Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings. |
CaptionSourceType
Use Source to identify the format of your input captions. The service cannot auto-detect caption format.
ANCILLARY
DVB_SUB
EMBEDDED
SCTE20
SCC
TTML
STL
SRT
SMI
SMPTE_TT
TELETEXT
NULL_SOURCE
IMSC
WEBVTT
ChannelMapping
Channel mapping contains the group of fields that hold the remixing value for each channel, in dB. Specify remix values to indicate how much of the content from your input audio channel you want in your output audio channels. Each instance of the InputChannels or InputChannelsFineTune array specifies these values for one output channel. Use one instance of this array for each output channel. In the console, each array corresponds to a column in the graphical depiction of the mapping matrix. The rows of the graphical matrix correspond to input channels. Valid 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). Use InputChannels or InputChannelsFineTune to specify your remix values. Don't use both.
Property | Type | Required | Description |
---|---|---|---|
outputChannels | Array of type OutputChannelMapping | False | In your JSON job specification, include one child of OutputChannels for each audio channel that you want in your output. Each child should contain one instance of InputChannels or InputChannelsFineTune. |
ClipLimits
Specify YUV limits and RGB tolerances when you set Sample range conversion to Limited range clip.
Property | Type | Required | Description |
---|---|---|---|
maximumRGBTolerance | integer Minimum: 90 Maximum: 105 | False | Specify the Maximum RGB color sample range tolerance for your output. MediaConvert corrects any YUV values that, when converted to RGB, would be outside the upper tolerance that you specify. Enter an integer from 90 to 105 as an offset percentage to the maximum possible value. Leave blank to use the default value 100. When you specify a value for Maximum RGB tolerance, you must set Sample range conversion to Limited range clip. |
maximumYUV | integer Minimum: 920 Maximum: 1023 | False | Specify the Maximum YUV color sample limit. MediaConvert conforms any pixels in your input above the value that you specify to typical limited range bounds. Enter an integer from 920 to 1023. Leave blank to use the default value 940. The value that you enter applies to 10-bit ranges. For 8-bit ranges, MediaConvert automatically scales this value down. When you specify a value for Maximum YUV, you must set Sample range conversion to Limited range clip. |
minimumRGBTolerance | integer Minimum: -5 Maximum: 10 | False | Specify the Minimum RGB color sample range tolerance for your output. MediaConvert corrects any YUV values that, when converted to RGB, would be outside the lower tolerance that you specify. Enter an integer from -5 to 10 as an offset percentage to the minimum possible value. Leave blank to use the default value 0. When you specify a value for Minimum RGB tolerance, you must set Sample range conversion to Limited range clip. |
minimumYUV | integer Minimum: 0 Maximum: 128 | False | Specify the Minimum YUV color sample limit. MediaConvert conforms any pixels in your input below the value that you specify to typical limited range bounds. Enter an integer from 0 to 128. Leave blank to use the default value 64. The value that you enter applies to 10-bit ranges. For 8-bit ranges, MediaConvert automatically scales this value down. When you specify a value for Minumum YUV, you must set Sample range conversion to Limited range clip. |
CmafAdditionalManifest
Specify the details for each pair of HLS and DASH additional manifests that you want the service to generate for this CMAF output group. Each pair of manifests can reference a different subset of outputs in the group.
Property | Type | Required | Description |
---|---|---|---|
manifestNameModifier | string MinLength: 1 | False | Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your HLS group is film-name.m3u8. If you enter "-no-premium" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.m3u8. For HLS output groups, specify a manifestNameModifier that is different from the nameModifier of the output. The service uses the output name modifier to create unique names for the individual variant manifests. |
selectedOutputs | Array of type string MinLength: 1 | False | Specify the outputs that you want this additional top-level manifest to reference. |
CmafClientCache
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled and control caching in your video distribution set up. For example, use the Cache-Control http header.
DISABLED
ENABLED
CmafCodecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
RFC_6381
RFC_4281
CmafEncryptionSettings
Settings for CMAF encryption
Property | Type | Required | Description |
---|---|---|---|
constantInitializationVector | string Pattern: MinLength: 32 MaxLength: 32 | False | This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default. |
encryptionMethod | False | Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample or AES_CTR. | |
initializationVectorInManifest | False | When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests. | |
spekeKeyProvider | False | If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead. | |
staticKeyProvider | False | Use these settings to set up encryption with a static key provider. | |
type | False | Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. |
CmafEncryptionType
Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample or AES_CTR.
SAMPLE_AES
AES_CTR
CmafGroupSettings
Settings related to your CMAF output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html.
Property | Type | Required | Description |
---|---|---|---|
additionalManifests | Array of type CmafAdditionalManifest | False | By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job. These default manifests reference every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here. For each additional manifest that you specify, the service creates one HLS manifest and one DASH manifest. |
baseUrl | string | False | A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file. |
clientCache | False | Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled and control caching in your video distribution set up. For example, use the Cache-Control http header. | |
codecSpecification | False | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. | |
dashIFrameTrickPlayNameModifier | string MinLength: 1 MaxLength: 256 | False | Specify whether MediaConvert generates I-frame only video segments for DASH trick play, also known as trick mode. When specified, the I-frame only video segments are included within an additional AdaptationSet in your DASH output manifest. To generate I-frame only video segments: Enter a name as a text string, up to 256 character long. This name is appended to the end of this output group's base filename, that you specify as part of your destination URI, and used for the I-frame only video segment files. You may also include format identifiers. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html#using-settings-variables-with-streaming-outputs To not generate I-frame only video segments: Leave blank. |
dashManifestStyle | False | Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To write a SegmentTimeline in each video Representation: Keep the default value, Basic. To write a common SegmentTimeline in the video AdaptationSet: Choose Compact. Note that MediaConvert will still write a SegmentTimeline in any Representation that does not share a common timeline. To write a video AdaptationSet for each different output framerate, and a common SegmentTimeline in each AdaptationSet: Choose Distinct. | |
destination | string Pattern: | False | Use Destination to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. |
destinationSettings | False | Settings associated with the destination. Will vary based on the type of destination | |
encryption | False | DRM settings. | |
fragmentLength | integer Minimum: 1 Maximum: 2147483647 | False | Specify the length, in whole seconds, of the mp4 fragments. When you don't specify a value, MediaConvert defaults to 2. Related setting: Use Fragment length control to specify whether the encoder enforces this value strictly. |
imageBasedTrickPlay | False | Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest, MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest, MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md | |
imageBasedTrickPlaySettings | False | Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED | |
manifestCompression | False | When set to GZIP, compresses HLS playlist. | |
manifestDurationFormat | False | Indicates whether the output manifest should use floating point values for segment duration. | |
minBufferTime | integer Minimum: 0 Maximum: 2147483647 | False | Minimum time of initially buffered media that is needed to ensure smooth playout. |
minFinalSegmentLength | number Format: float Minimum: 0.0 Maximum: 2.147483647E9 | False | Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds. |
mpdManifestBandwidthType | False | Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second. | |
mpdProfile | False | Specify whether your DASH profile is on-demand or main. When you choose Main profile, the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand, the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control to Single file. | |
ptsOffsetHandlingForBFrames | False | Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here. | |
segmentControl | False | When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created. | |
segmentLength | integer Minimum: 1 Maximum: 2147483647 | False | Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 10. Related settings: Use Segment length control to specify whether the encoder enforces this value strictly. Use Segment control to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries. |
segmentLengthControl | False | Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary. | |
streamInfResolution | False | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. | |
targetDurationCompatibilityMode | False | When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration. | |
videoCompositionOffsets | False | Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers. | |
writeDashManifest | False | When set to ENABLED, a DASH MPD manifest will be generated for this output. | |
writeHlsManifest | False | When set to ENABLED, an Apple HLS manifest will be generated for this output. | |
writeSegmentTimelineInRepresentation | False | When you enable Precise segment duration in DASH manifests, your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element. |
CmafImageBasedTrickPlay
Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest, MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest, MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md
NONE
THUMBNAIL
THUMBNAIL_AND_FULLFRAME
ADVANCED
CmafImageBasedTrickPlaySettings
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
Property | Type | Required | Description |
---|---|---|---|
intervalCadence | False | The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval. | |
thumbnailHeight | integer Minimum: 2 Maximum: 4096 | False | Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2. |
thumbnailInterval | number Format: float Minimum: 0.0 Maximum: 2.147483647E9 | False | Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails. |
thumbnailWidth | integer Minimum: 8 Maximum: 4096 | False | Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. |
tileHeight | integer Minimum: 1 Maximum: 2048 | False | Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2. |
tileWidth | integer Minimum: 1 Maximum: 512 | False | Number of thumbnails in each row of a tile image. Set a value between 1 and 512. |
CmafInitializationVectorInManifest
When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.
INCLUDE
EXCLUDE
CmafIntervalCadence
The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.
FOLLOW_IFRAME
FOLLOW_CUSTOM
CmafKeyProviderType
Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.
SPEKE
STATIC_KEY
CmafManifestCompression
When set to GZIP, compresses HLS playlist.
GZIP
NONE
CmafManifestDurationFormat
Indicates whether the output manifest should use floating point values for segment duration.
FLOATING_POINT
INTEGER
CmafMpdManifestBandwidthType
Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second.
AVERAGE
MAX
CmafMpdProfile
Specify whether your DASH profile is on-demand or main. When you choose Main profile, the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand, the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control to Single file.
MAIN_PROFILE
ON_DEMAND_PROFILE
CmafPtsOffsetHandlingForBFrames
Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.
ZERO_BASED
MATCH_INITIAL_PTS
CmafSegmentControl
When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.
SINGLE_FILE
SEGMENTED_FILES
CmafSegmentLengthControl
Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.
EXACT
GOP_MULTIPLE
CmafStreamInfResolution
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
INCLUDE
EXCLUDE
CmafTargetDurationCompatibilityMode
When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.
LEGACY
SPEC_COMPLIANT
CmafVideoCompositionOffsets
Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers.
SIGNED
UNSIGNED
CmafWriteDASHManifest
When set to ENABLED, a DASH MPD manifest will be generated for this output.
DISABLED
ENABLED
CmafWriteHLSManifest
When set to ENABLED, an Apple HLS manifest will be generated for this output.
DISABLED
ENABLED
CmafWriteSegmentTimelineInRepresentation
When you enable Precise segment duration in DASH manifests, your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.
ENABLED
DISABLED
CmfcAudioDuration
Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration. In all other cases, keep the default value, Default codec duration. When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.
DEFAULT_CODEC_DURATION
MATCH_VIDEO_DURATION
CmfcAudioTrackType
Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. Choose Audio-only variant stream (AUDIO_ONLY_VARIANT_STREAM) for any variant that you want to prohibit the client from playing with video. This causes MediaConvert to represent the variant as an EXT-X-STREAM-INF in the HLS manifest. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.
ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT
ALTERNATE_AUDIO_AUTO_SELECT
ALTERNATE_AUDIO_NOT_AUTO_SELECT
AUDIO_ONLY_VARIANT_STREAM
CmfcDescriptiveVideoServiceFlag
Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag, MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag, MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.
DONT_FLAG
FLAG
CmfcIFrameOnlyManifest
Choose Include to have MediaConvert generate an HLS child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude.
INCLUDE
EXCLUDE
CmfcKlvMetadata
To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and writes each instance to a separate event message box in the output, according to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.
PASSTHROUGH
NONE
CmfcManifestMetadataSignaling
To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled. For ID3 event messages, the InbandEventStream element schemeIdUri will be same value that you specify for ID3 metadata scheme ID URI. For SCTE35 event messages, the InbandEventStream element schemeIdUri will be "urn:scte:scte35:2013:bin". To leave these elements out of your output MPD manifest, set Manifest metadata signaling to Disabled. To enable Manifest metadata signaling, you must also set SCTE-35 source to Passthrough, ESAM SCTE-35 to insert, or ID3 metadata to Passthrough.
ENABLED
DISABLED
CmfcScte35Esam
Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML.
INSERT
NONE
CmfcScte35Source
Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None if you don't want those SCTE-35 markers in this output.
PASSTHROUGH
NONE
CmfcSettings
These settings relate to the fragmented MP4 container for the segments in your CMAF outputs.
Property | Type | Required | Description |
---|---|---|---|
audioDuration | False | Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration. In all other cases, keep the default value, Default codec duration. When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec. | |
audioGroupId | string | False | Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets. |
audioRenditionSets | string | False | List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1,audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8 |
audioTrackType | False | Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. Choose Audio-only variant stream (AUDIO_ONLY_VARIANT_STREAM) for any variant that you want to prohibit the client from playing with video. This causes MediaConvert to represent the variant as an EXT-X-STREAM-INF in the HLS manifest. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting. | |
descriptiveVideoServiceFlag | False | Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag, MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag, MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation. | |
iFrameOnlyManifest | False | Choose Include to have MediaConvert generate an HLS child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude. | |
klvMetadata | False | To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and writes each instance to a separate event message box in the output, according to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank. | |
manifestMetadataSignaling | False | To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled. For ID3 event messages, the InbandEventStream element schemeIdUri will be same value that you specify for ID3 metadata scheme ID URI. For SCTE35 event messages, the InbandEventStream element schemeIdUri will be "urn:scte:scte35:2013:bin". To leave these elements out of your output MPD manifest, set Manifest metadata signaling to Disabled. To enable Manifest metadata signaling, you must also set SCTE-35 source to Passthrough, ESAM SCTE-35 to insert, or ID3 metadata to Passthrough. | |
scte35Esam | False | Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML. | |
scte35Source | False | Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None if you don't want those SCTE-35 markers in this output. | |
timedMetadata | False | To include ID3 metadata in this output: Set ID3 metadata to Passthrough. Specify this ID3 metadata in Custom ID3 metadata inserter. MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None or leave blank. | |
timedMetadataBoxVersion | False | Specify the event message box (eMSG) version for ID3 timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.3 Syntax. Leave blank to use the default value Version 0. When you specify Version 1, you must also set ID3 metadata to Passthrough. | |
timedMetadataSchemeIdUri | string MaxLength: 1000 | False | Specify the event message box (eMSG) scheme ID URI for ID3 timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.4 Semantics. Leave blank to use the default value: https://aomedia.org/emsg/ID3 When you specify a value for ID3 metadata scheme ID URI, you must also set ID3 metadata to Passthrough. |
timedMetadataValue | string MaxLength: 1000 | False | Specify the event message box (eMSG) value for ID3 timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.4 Semantics. When you specify a value for ID3 Metadata Value, you must also set ID3 metadata to Passthrough. |
CmfcTimedMetadata
To include ID3 metadata in this output: Set ID3 metadata to Passthrough. Specify this ID3 metadata in Custom ID3 metadata inserter. MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None or leave blank.
PASSTHROUGH
NONE
CmfcTimedMetadataBoxVersion
Specify the event message box (eMSG) version for ID3 timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.3 Syntax. Leave blank to use the default value Version 0. When you specify Version 1, you must also set ID3 metadata to Passthrough.
VERSION_0
VERSION_1
ColorConversion3DLUTSetting
Custom 3D lut settings
Property | Type | Required | Description |
---|---|---|---|
fileInput | string Pattern: MinLength: 14 | False | Specify the input file S3, HTTP, or HTTPS URL for your 3D LUT .cube file. Note that MediaConvert accepts 3D LUT files up to 8MB in size. |
inputColorSpace | False | Specify which inputs use this 3D LUT, according to their color space. | |
inputMasteringLuminance | integer Minimum: 0 Maximum: 2147483647 | False | Specify which inputs use this 3D LUT, according to their luminance. To apply this 3D LUT to HDR10 or P3D65 (HDR) inputs with a specific mastering luminance: Enter an integer from 0 to 2147483647, corresponding to the input's Maximum luminance value. To apply this 3D LUT to any input regardless of its luminance: Leave blank, or enter 0. |
outputColorSpace | False | Specify which outputs use this 3D LUT, according to their color space. | |
outputMasteringLuminance | integer Minimum: 0 Maximum: 2147483647 | False | Specify which outputs use this 3D LUT, according to their luminance. To apply this 3D LUT to HDR10 or P3D65 (HDR) outputs with a specific luminance: Enter an integer from 0 to 2147483647, corresponding to the output's luminance. To apply this 3D LUT to any output regardless of its luminance: Leave blank, or enter 0. |
ColorCorrector
Settings for color correction.
Property | Type | Required | Description |
---|---|---|---|
brightness | integer Minimum: 1 Maximum: 100 | False | Brightness level. |
clipLimits | False | Specify YUV limits and RGB tolerances when you set Sample range conversion to Limited range clip. | |
colorSpaceConversion | False | Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, from SDR to HDR, and from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output. HDR to SDR conversion uses tone mapping to approximate the outcome of manually regrading from HDR to SDR. When you specify an output color space, MediaConvert uses the following color space metadata, which includes color primaries, transfer characteristics, and matrix coefficients: * HDR 10: BT.2020, PQ, BT.2020 non-constant * HLG 2020: BT.2020, HLG, BT.2020 non-constant * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 * P3D65 (SDR): Display P3, sRGB, BT.709 * P3D65 (HDR): Display P3, PQ, BT.709 | |
contrast | integer Minimum: 1 Maximum: 100 | False | Contrast level. |
hdr10Metadata | False | Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion to HDR 10, these settings are required. You must set values for Max frame average light level and Max content light level; these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr. | |
hdrToSdrToneMapper | False | Specify how MediaConvert maps brightness and colors from your HDR input to your SDR output. The mode that you select represents a creative choice, with different tradeoffs in the details and tones of your output. To maintain details in bright or saturated areas of your output: Choose Preserve details. For some sources, your SDR output may look less bright and less saturated when compared to your HDR source. MediaConvert automatically applies this mode for HLG sources, regardless of your choice. For a bright and saturated output: Choose Vibrant. We recommend that you choose this mode when any of your source content is HDR10, and for the best results when it is mastered for 1000 nits. You may notice loss of details in bright or saturated areas of your output. HDR to SDR tone mapping has no effect when your input is SDR. | |
hue | integer Minimum: -180 Maximum: 180 | False | Hue in degrees. |
maxLuminance | integer Minimum: 0 Maximum: 2147483647 | False | Specify the maximum mastering display luminance. Enter an integer from 0 to 2147483647, in units of 0.0001 nits. For example, enter 10000000 for 1000 nits. |
sampleRangeConversion | False | Specify how MediaConvert limits the color sample range for this output. To create a limited range output from a full range input: Choose Limited range squeeze. For full range inputs, MediaConvert performs a linear offset to color samples equally across all pixels and frames. Color samples in 10-bit outputs are limited to 64 through 940, and 8-bit outputs are limited to 16 through 235. Note: For limited range inputs, values for color samples are passed through to your output unchanged. MediaConvert does not limit the sample range. To correct pixels in your input that are out of range or out of gamut: Choose Limited range clip. Use for broadcast applications. MediaConvert conforms any pixels outside of the values that you specify under Minimum YUV and Maximum YUV to limited range bounds. MediaConvert also corrects any YUV values that, when converted to RGB, would be outside the bounds you specify under Minimum RGB tolerance and Maximum RGB tolerance. With either limited range conversion, MediaConvert writes the sample range metadata in the output. | |
saturation | integer Minimum: 1 Maximum: 100 | False | Saturation level. |
sdrReferenceWhiteLevel | integer Minimum: 100 Maximum: 1000 | False | Specify the reference white level, in nits, for all of your SDR inputs. Use to correct brightness levels within HDR10 outputs. The following color metadata must be present in your SDR input: color primaries, transfer characteristics, and matrix coefficients. If your SDR input has missing color metadata, or if you want to correct input color metadata, manually specify a color space in the input video selector. For 1,000 nit peak brightness displays, we recommend that you set SDR reference white level to 203 (according to ITU-R BT.2408). Leave blank to use the default value of 100, or specify an integer from 100 to 1000. |
ColorMetadata
Choose Insert for this setting to include color metadata in this output. Choose Ignore to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
IGNORE
INSERT
ColorSpace
If your input video has accurate color space metadata, or if you don't know about color space: Keep the default value, Follow. MediaConvert will automatically detect your input color space. If your input video has metadata indicating the wrong color space, or has missing metadata: Specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate: Choose Force HDR 10. Specify correct values in the input HDR 10 metadata settings. For more information about HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr. When you specify an input color space, MediaConvert uses the following color space metadata, which includes color primaries, transfer characteristics, and matrix coefficients: * HDR 10: BT.2020, PQ, BT.2020 non-constant * HLG 2020: BT.2020, HLG, BT.2020 non-constant * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 * P3D65 (SDR): Display P3, sRGB, BT.709 * P3D65 (HDR): Display P3, PQ, BT.709
FOLLOW
REC_601
REC_709
HDR10
HLG_2020
P3DCI
P3D65_SDR
P3D65_HDR
ColorSpaceConversion
Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, from SDR to HDR, and from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output. HDR to SDR conversion uses tone mapping to approximate the outcome of manually regrading from HDR to SDR. When you specify an output color space, MediaConvert uses the following color space metadata, which includes color primaries, transfer characteristics, and matrix coefficients: * HDR 10: BT.2020, PQ, BT.2020 non-constant * HLG 2020: BT.2020, HLG, BT.2020 non-constant * P3DCI (Theater): DCIP3, SMPTE 428M, BT.709 * P3D65 (SDR): Display P3, sRGB, BT.709 * P3D65 (HDR): Display P3, PQ, BT.709
NONE
FORCE_601
FORCE_709
FORCE_HDR10
FORCE_HLG_2020
FORCE_P3DCI
FORCE_P3D65_SDR
FORCE_P3D65_HDR
ColorSpaceUsage
There are two sources for color metadata, the input file and the job input settings Color space and HDR master display information settings. The Color space usage setting determines which takes precedence. Choose Force to use color metadata from the input job settings. If you don't specify values for those settings, the service defaults to using metadata from your input. FALLBACK - Choose Fallback to use color metadata from the source when it is present. If there's no color metadata in your input file, the service defaults to using values you specify in the input settings.
FORCE
FALLBACK
ContainerSettings
Container specific settings.
Property | Type | Required | Description |
---|---|---|---|
cmfcSettings | False | These settings relate to the fragmented MP4 container for the segments in your CMAF outputs. | |
container | False | Container for this output. Some containers require a container settings object. If not specified, the default object will be created. | |
f4vSettings | False | Settings for F4v container | |
m2tsSettings | False | MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset. | |
m3u8Settings | False | These settings relate to the MPEG-2 transport stream (MPEG2-TS) container for the MPEG2-TS segments in your HLS outputs. | |
movSettings | False | These settings relate to your QuickTime MOV output container. | |
mp4Settings | False | These settings relate to your MP4 output container. You can create audio only outputs with this container. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/supported-codecs-containers-audio-only.html#output-codecs-and-containers-supported-for-audio-only. | |
mpdSettings | False | These settings relate to the fragmented MP4 container for the segments in your DASH outputs. | |
mxfSettings | False | These settings relate to your MXF output container. |
ContainerType
Container for this output. Some containers require a container settings object. If not specified, the default object will be created.
F4V
ISMV
M2TS
M3U8
CMFC
MOV
MP4
MPD
MXF
OGG
WEBM
RAW
Y4M
CopyProtectionAction
The action to take on copy and redistribution control XDS packets. If you select PASSTHROUGH, packets will not be changed. If you select STRIP, any packets will be removed in output captions.
PASSTHROUGH
STRIP
CreateJobRequest
Send your create job request with your job settings and IAM role. Optionally, include user metadata and the ARN for the queue.
Property | Type | Required | Description |
---|---|---|---|
accelerationSettings | False | Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide. | |
billingTagsSource | False | Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted. | |
clientRequestToken | string | False | Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html. |
hopDestinations | Array of type HopDestination | False | Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide. |
jobEngineVersion | string | False | Use Job engine versions to run jobs for your production workflow on one version, while you test and validate the latest version. To specify a Job engine version: Enter a date in a YYYY-MM-DD format. For a list of valid Job engine versions, submit a ListVersions request. To not specify a Job engine version: Leave blank. |
jobTemplate | string | False | Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually. |
priority | integer Format: int32 Minimum: -50 Maximum: 50 | False | Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0. |
queue | string | False | Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html. |
role | string | True | Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. |
settings | True | JobSettings contains all the transcode settings for a job. | |
simulateReservedQueue | False | Optional. Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default. | |
statusUpdateInterval | False | Optional. Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. | |
tags | object | False | Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations and workflows. |
userMetadata | object | False | Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we recommend that you use standard AWS tags. |
CreateJobResponse
Successful create job requests will return the job JSON.
Property | Type | Required | Description |
---|---|---|---|
job | False | Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html |
DashAdditionalManifest
Specify the details for each additional DASH manifest that you want the service to generate for this output group. Each manifest can reference a different subset of outputs in the group.
Property | Type | Required | Description |
---|---|---|---|
manifestNameModifier | string MinLength: 1 | False | Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your DASH group is film-name.mpd. If you enter "-no-premium" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.mpd. |
selectedOutputs | Array of type string MinLength: 1 | False | Specify the outputs that you want this additional top-level manifest to reference. |
DashIsoEncryptionSettings
Specifies DRM settings for DASH outputs.
Property | Type | Required | Description |
---|---|---|---|
playbackDeviceCompatibility | False | This setting can improve the compatibility of your output with video players on obsolete devices. It applies only to DASH H.264 outputs with DRM encryption. Choose Unencrypted SEI only to correct problems with playback on older devices. Otherwise, keep the default setting CENC v1. If you choose Unencrypted SEI, for that output, the service will exclude the access unit delimiter and will leave the SEI NAL units unencrypted. | |
spekeKeyProvider | False | If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead. |
DashIsoGroupAudioChannelConfigSchemeIdUri
Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) and your downstream workflow requires that your DASH manifest use the Dolby channel configuration tag, rather than the MPEG one. For example, you might need to use this to make dynamic ad insertion work. Specify which audio channel configuration scheme ID URI MediaConvert writes in your DASH manifest. Keep the default value, MPEG channel configuration, to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby channel configuration to have MediaConvert write this instead: tag:dolby.com,2014:dash:audio_channel_configuration:2011.
MPEG_CHANNEL_CONFIGURATION
DOLBY_CHANNEL_CONFIGURATION
DashIsoGroupSettings
Settings related to your DASH output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html.
Property | Type | Required | Description |
---|---|---|---|
additionalManifests | Array of type DashAdditionalManifest | False | By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job. This default manifest references every output in the output group. To create additional DASH manifests that reference a subset of the outputs in the output group, specify a list of them here. |
audioChannelConfigSchemeIdUri | False | Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) and your downstream workflow requires that your DASH manifest use the Dolby channel configuration tag, rather than the MPEG one. For example, you might need to use this to make dynamic ad insertion work. Specify which audio channel configuration scheme ID URI MediaConvert writes in your DASH manifest. Keep the default value, MPEG channel configuration, to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby channel configuration to have MediaConvert write this instead: tag:dolby.com,2014:dash:audio_channel_configuration:2011. | |
baseUrl | string | False | A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file. |
dashIFrameTrickPlayNameModifier | string MinLength: 1 MaxLength: 256 | False | Specify whether MediaConvert generates I-frame only video segments for DASH trick play, also known as trick mode. When specified, the I-frame only video segments are included within an additional AdaptationSet in your DASH output manifest. To generate I-frame only video segments: Enter a name as a text string, up to 256 character long. This name is appended to the end of this output group's base filename, that you specify as part of your destination URI, and used for the I-frame only video segment files. You may also include format identifiers. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html#using-settings-variables-with-streaming-outputs To not generate I-frame only video segments: Leave blank. |
dashManifestStyle | False | Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To write a SegmentTimeline in each video Representation: Keep the default value, Basic. To write a common SegmentTimeline in the video AdaptationSet: Choose Compact. Note that MediaConvert will still write a SegmentTimeline in any Representation that does not share a common timeline. To write a video AdaptationSet for each different output framerate, and a common SegmentTimeline in each AdaptationSet: Choose Distinct. | |
destination | string Pattern: | False | Use Destination to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. |
destinationSettings | False | Settings associated with the destination. Will vary based on the type of destination | |
encryption | False | DRM settings. | |
fragmentLength | integer Minimum: 1 Maximum: 2147483647 | False | Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types. |
hbbtvCompliance | False | Supports HbbTV specification as indicated | |
imageBasedTrickPlay | False | Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md | |
imageBasedTrickPlaySettings | False | Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED | |
minBufferTime | integer Minimum: 0 Maximum: 2147483647 | False | Minimum time of initially buffered media that is needed to ensure smooth playout. |
minFinalSegmentLength | number Format: float Minimum: 0.0 Maximum: 2.147483647E9 | False | Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds. |
mpdManifestBandwidthType | False | Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second. | |
mpdProfile | False | Specify whether your DASH profile is on-demand or main. When you choose Main profile, the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand, the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control to Single file. | |
ptsOffsetHandlingForBFrames | False | Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here. | |
segmentControl | False | When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created. | |
segmentLength | integer Minimum: 1 Maximum: 2147483647 | False | Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 30. Related settings: Use Segment length control to specify whether the encoder enforces this value strictly. Use Segment control to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries. |
segmentLengthControl | False | Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary. | |
videoCompositionOffsets | False | Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers. | |
writeSegmentTimelineInRepresentation | False | If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest. |
DashIsoHbbtvCompliance
Supports HbbTV specification as indicated
HBBTV_1_5
NONE
DashIsoImageBasedTrickPlay
Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md
NONE
THUMBNAIL
THUMBNAIL_AND_FULLFRAME
ADVANCED
DashIsoImageBasedTrickPlaySettings
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
Property | Type | Required | Description |
---|---|---|---|
intervalCadence | False | The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval. | |
thumbnailHeight | integer Minimum: 1 Maximum: 4096 | False | Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2. |
thumbnailInterval | number Format: float Minimum: 0.0 Maximum: 2.147483647E9 | False | Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails. |
thumbnailWidth | integer Minimum: 8 Maximum: 4096 | False | Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. |
tileHeight | integer Minimum: 1 Maximum: 2048 | False | Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2. |
tileWidth | integer Minimum: 1 Maximum: 512 | False | Number of thumbnails in each row of a tile image. Set a value between 1 and 512. |
DashIsoIntervalCadence
The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.
FOLLOW_IFRAME
FOLLOW_CUSTOM
DashIsoMpdManifestBandwidthType
Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second.
AVERAGE
MAX
DashIsoMpdProfile
Specify whether your DASH profile is on-demand or main. When you choose Main profile, the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand, the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control to Single file.
MAIN_PROFILE
ON_DEMAND_PROFILE
DashIsoPlaybackDeviceCompatibility
This setting can improve the compatibility of your output with video players on obsolete devices. It applies only to DASH H.264 outputs with DRM encryption. Choose Unencrypted SEI only to correct problems with playback on older devices. Otherwise, keep the default setting CENC v1. If you choose Unencrypted SEI, for that output, the service will exclude the access unit delimiter and will leave the SEI NAL units unencrypted.
CENC_V1
UNENCRYPTED_SEI
DashIsoPtsOffsetHandlingForBFrames
Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.
ZERO_BASED
MATCH_INITIAL_PTS
DashIsoSegmentControl
When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.
SINGLE_FILE
SEGMENTED_FILES
DashIsoSegmentLengthControl
Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.
EXACT
GOP_MULTIPLE
DashIsoVideoCompositionOffsets
Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers.
SIGNED
UNSIGNED
DashIsoWriteSegmentTimelineInRepresentation
When you enable Precise segment duration in manifests, your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.
ENABLED
DISABLED
DashManifestStyle
Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To write a SegmentTimeline in each video Representation: Keep the default value, Basic. To write a common SegmentTimeline in the video AdaptationSet: Choose Compact. Note that MediaConvert will still write a SegmentTimeline in any Representation that does not share a common timeline. To write a video AdaptationSet for each different output framerate, and a common SegmentTimeline in each AdaptationSet: Choose Distinct.
BASIC
COMPACT
DISTINCT
DecryptionMode
Specify the encryption mode that you used to encrypt your input files.
AES_CTR
AES_CBC
AES_GCM
DeinterlaceAlgorithm
Only applies when you set Deinterlace mode to Deinterlace or Adaptive. Interpolate produces sharper pictures, while blend produces smoother motion. If your source file includes a ticker, such as a scrolling headline at the bottom of the frame: Choose Interpolate ticker or Blend ticker. To apply field doubling: Choose Linear interpolation. Note that Linear interpolation may introduce video artifacts into your output.
INTERPOLATE
INTERPOLATE_TICKER
BLEND
BLEND_TICKER
LINEAR_INTERPOLATION
Deinterlacer
Settings for deinterlacer
Property | Type | Required | Description |
---|---|---|---|
algorithm | False | Only applies when you set Deinterlace mode to Deinterlace or Adaptive. Interpolate produces sharper pictures, while blend produces smoother motion. If your source file includes a ticker, such as a scrolling headline at the bottom of the frame: Choose Interpolate ticker or Blend ticker. To apply field doubling: Choose Linear interpolation. Note that Linear interpolation may introduce video artifacts into your output. | |
control | False | - When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video. | |
mode | False | Use Deinterlacer 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. |
DeinterlacerControl
- When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video.
FORCE_ALL_FRAMES
NORMAL
DeinterlacerMode
Use Deinterlacer 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
DestinationSettings
Settings associated with the destination. Will vary based on the type of destination
Property | Type | Required | Description |
---|---|---|---|
s3Settings | False | Settings associated with S3 destination |
DolbyVision
Create Dolby Vision Profile 5 or Profile 8.1 compatible video output.
Property | Type | Required | Description |
---|---|---|---|
l6Metadata | False | Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the MaxCLL and MaxFALL values in your input with new values. | |
l6Mode | False | Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL and MaxFALL properies. | |
mapping | False | Required when you set Dolby Vision Profile to Profile 8.1. When you set Content mapping to None, content mapping is not applied to the HDR10-compatible signal. Depending on the source peak nit level, clipping might occur on HDR devices without Dolby Vision. When you set Content mapping to HDR10 1000, the transcoder creates a 1,000 nits peak HDR10-compatible signal by applying static content mapping to the source. This mode is speed-optimized for PQ10 sources with metadata that is created from analysis. For graded Dolby Vision content, be aware that creative intent might not be guaranteed with extreme 1,000 nits trims. | |
profile | False | Required when you enable Dolby Vision. Use Profile 5 to include frame-interleaved Dolby Vision metadata in your output. Your input must include Dolby Vision metadata or an HDR10 YUV color space. Use Profile 8.1 to include frame-interleaved Dolby Vision metadata and HDR10 metadata in your output. Your input must include Dolby Vision metadata. |
DolbyVisionLevel6Metadata
Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the MaxCLL and MaxFALL values in your input with new values.
Property | Type | Required | Description |
---|---|---|---|
maxCll | integer Minimum: 0 Maximum: 65535 | False | Maximum Content Light Level. Static HDR metadata that corresponds to the brightest pixel in the entire stream. Measured in nits. |
maxFall | integer Minimum: 0 Maximum: 65535 | False | Maximum Frame-Average Light Level. Static HDR metadata that corresponds to the highest frame-average brightness in the entire stream. Measured in nits. |
DolbyVisionLevel6Mode
Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL and MaxFALL properies.
PASSTHROUGH
RECALCULATE
SPECIFY
DolbyVisionMapping
Required when you set Dolby Vision Profile to Profile 8.1. When you set Content mapping to None, content mapping is not applied to the HDR10-compatible signal. Depending on the source peak nit level, clipping might occur on HDR devices without Dolby Vision. When you set Content mapping to HDR10 1000, the transcoder creates a 1,000 nits peak HDR10-compatible signal by applying static content mapping to the source. This mode is speed-optimized for PQ10 sources with metadata that is created from analysis. For graded Dolby Vision content, be aware that creative intent might not be guaranteed with extreme 1,000 nits trims.
HDR10_NOMAP
HDR10_1000
DolbyVisionProfile
Required when you enable Dolby Vision. Use Profile 5 to include frame-interleaved Dolby Vision metadata in your output. Your input must include Dolby Vision metadata or an HDR10 YUV color space. Use Profile 8.1 to include frame-interleaved Dolby Vision metadata and HDR10 metadata in your output. Your input must include Dolby Vision metadata.
PROFILE_5
PROFILE_8_1
DropFrameTimecode
Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion is enabled.
DISABLED
ENABLED
DvbNitSettings
Use these settings to insert a DVB Network Information Table (NIT) in the transport stream of this output.
Property | Type | Required | Description |
---|---|---|---|
networkId | integer Minimum: 0 Maximum: 65535 | False | The numeric value placed in the Network Information Table (NIT). |
networkName | string MinLength: 1 MaxLength: 256 | False | The network name text placed in the network_name_descriptor inside the Network Information Table. Maximum length is 256 characters. |
nitInterval | integer Minimum: 25 Maximum: 10000 | False | The number of milliseconds between instances of this table in the output transport stream. |
DvbSdtSettings
Use these settings to insert a DVB Service Description Table (SDT) in the transport stream of this output.
Property | Type | Required | Description |
---|---|---|---|
outputSdt | False | Selects method of inserting SDT information into output stream. "Follow input SDT" copies SDT information from input stream to output stream. "Follow input SDT if present" copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. Enter "SDT Manually" means user will enter the SDT information. "No SDT" means output stream will not contain SDT information. | |
sdtInterval | integer Minimum: 25 Maximum: 2000 | False | The number of milliseconds between instances of this table in the output transport stream. |
serviceName | string MinLength: 1 MaxLength: 256 | False | The service name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters. |
serviceProviderName | string MinLength: 1 MaxLength: 256 | False | The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters. |
DvbSubDestinationSettings
Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html.
Property | Type | Required | Description |
---|---|---|---|
alignment | False | Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign 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. Within your job settings, all of your DVB-Sub settings must be identical. | |
applyFontColor | False | Ignore this setting unless Style Passthrough is set to Enabled and Font color set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color for additional font color controls. When you choose White text only, or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text. | |
backgroundColor | False | Specify the color of the rectangle behind the captions. Leave background color blank and set Style passthrough to enabled to use the background color data from your input captions, if present. | |
backgroundOpacity | integer Minimum: 0 Maximum: 255 | False | Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all backgrounds from your output captions. Within your job settings, all of your DVB-Sub settings must be identical. |
ddsHandling | False | Specify how MediaConvert handles the display definition segment (DDS). To exclude the DDS from this set of captions: Keep the default, None. To include the DDS: Choose Specified. When you do, also specify the offset coordinates of the display window with DDS x-coordinate and DDS y-coordinate. To include the DDS, but not include display window data: Choose No display window. When you do, you can write position metadata to the page composition segment (PCS) with DDS x-coordinate and DDS y-coordinate. For video resolutions with a height of 576 pixels or less, MediaConvert doesn't include the DDS, regardless of the value you choose for DDS handling. All burn-in and DVB-Sub font settings must match. | |
ddsXCoordinate | integer Minimum: 0 Maximum: 2147483647 | False | Use this setting, along with DDS y-coordinate, to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the left side of the frame and the left side of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling to a value other than None. MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment. All burn-in and DVB-Sub font settings must match. |
ddsYCoordinate | integer Minimum: 0 Maximum: 2147483647 | False | Use this setting, along with DDS x-coordinate, to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the top of the frame and the top of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling to a value other than None. MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match. |
fallbackFont | False | Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font to best match, or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input. | |
fontColor | False | Specify the color of the captions text. Leave Font color blank and set Style passthrough to enabled to use the font color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical. | |
fontFileBold | string Pattern: | False | Specify a bold TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, an italic, and a bold italic font file. |
fontFileBoldItalic | string Pattern: | False | Specify a bold italic TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, a bold, and an italic font file. |
fontFileItalic | string Pattern: | False | Specify an italic TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, a bold, and a bold italic font file. |
fontFileRegular | string Pattern: | False | Specify a regular TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a bold, an italic, and a bold italic font file. |
fontOpacity | integer Minimum: 0 Maximum: 255 | False | Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent. Within your job settings, all of your DVB-Sub settings must be identical. |
fontResolution | integer Minimum: 96 Maximum: 600 | False | Specify the Font resolution in DPI (dots per inch). Within your job settings, all of your DVB-Sub settings must be identical. |
fontScript | False | Set Font script to Automatically determined, or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese. Within your job settings, all of your DVB-Sub settings must be identical. | |
fontSize | integer Minimum: 0 Maximum: 96 | False | Specify the Font size in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size. Within your job settings, all of your DVB-Sub settings must be identical. |
height | integer Minimum: 1 Maximum: 2147483647 | False | Specify the height, in pixels, of this set of DVB-Sub captions. The default value is 576 pixels. Related setting: When you use this setting, you must set DDS handling to a value other than None. All burn-in and DVB-Sub font settings must match. |
hexFontColor | string Pattern: MinLength: 6 MaxLength: 8 | False | Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB. |
outlineColor | False | Specify font outline color. Leave Outline color blank and set Style passthrough to enabled to use the font outline color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical. | |
outlineSize | integer Minimum: 0 Maximum: 10 | False | Specify the Outline size of the caption text, in pixels. Leave Outline size blank and set Style passthrough to enabled to use the outline size data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical. |
shadowColor | False | Specify the color of the shadow cast by the captions. Leave Shadow color blank and set Style passthrough to enabled to use the shadow color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical. | |
shadowOpacity | integer Minimum: 0 Maximum: 255 | False | Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to Enabled, leave Shadow opacity blank to pass through the shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all shadows from your output captions. Within your job settings, all of your DVB-Sub settings must be identical. |
shadowXOffset | integer Minimum: -2147483648 Maximum: 2147483647 | False | Specify 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. Within your job settings, all of your DVB-Sub settings must be identical. |
shadowYOffset | integer Minimum: -2147483648 Maximum: 2147483647 | False | Specify 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. Leave Shadow y-offset blank and set Style passthrough to enabled to use the shadow y-offset data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical. |
stylePassthrough | False | To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. Note that MediaConvert uses default settings for any missing style or position information in your input captions To ignore the style and position information from your input captions and use default settings: Leave blank or keep the default value, Disabled. Default settings include white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings. You can also override any fonts by manually specifying custom font files. | |
subtitlingType | False | Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue. | |
teletextSpacing | False | Specify whether the Text spacing 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 for closed captions. Within your job settings, all of your DVB-Sub settings must be identical. | |
width | integer Minimum: 1 Maximum: 2147483647 | False | Specify the width, in pixels, of this set of DVB-Sub captions. The default value is 720 pixels. Related setting: When you use this setting, you must set DDS handling to a value other than None. All burn-in and DVB-Sub font settings must match. |
xPosition | integer Minimum: 0 Maximum: 2147483647 | False | Specify the horizontal position of the captions, 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. Within your job settings, all of your DVB-Sub settings must be identical. |
yPosition | integer Minimum: 0 Maximum: 2147483647 | False | Specify the vertical position of the captions, 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. Within your job settings, all of your DVB-Sub settings must be identical. |
DvbSubSourceSettings
DVB Sub Source Settings
Property | Type | Required | Description |
---|---|---|---|
pid | integer Minimum: 1 Maximum: 2147483647 | False | When using DVB-Sub with Burn-in, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors. |
DvbSubSubtitleFallbackFont
Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font to best match, or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.
BEST_MATCH
MONOSPACED_SANSSERIF
MONOSPACED_SERIF
PROPORTIONAL_SANSSERIF
PROPORTIONAL_SERIF
DvbSubtitleAlignment
Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign 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. Within your job settings, all of your DVB-Sub settings must be identical.
CENTERED
LEFT
AUTO
DvbSubtitleApplyFontColor
Ignore this setting unless Style Passthrough is set to Enabled and Font color set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color for additional font color controls. When you choose White text only, or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.
WHITE_TEXT_ONLY
ALL_TEXT
DvbSubtitleBackgroundColor
Specify the color of the rectangle behind the captions. Leave background color blank and set Style passthrough to enabled to use the background color data from your input captions, if present.
NONE
BLACK
WHITE
AUTO
DvbSubtitleFontColor
Specify the color of the captions text. Leave Font color blank and set Style passthrough to enabled to use the font color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.
WHITE
BLACK
YELLOW
RED
GREEN
BLUE
HEX
AUTO
DvbSubtitleOutlineColor
Specify font outline color. Leave Outline color blank and set Style passthrough to enabled to use the font outline color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.
BLACK
WHITE
YELLOW
RED
GREEN
BLUE
AUTO
DvbSubtitleShadowColor
Specify the color of the shadow cast by the captions. Leave Shadow color blank and set Style passthrough to enabled to use the shadow color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.
NONE
BLACK
WHITE
AUTO
DvbSubtitleStylePassthrough
To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. Note that MediaConvert uses default settings for any missing style or position information in your input captions To ignore the style and position information from your input captions and use default settings: Leave blank or keep the default value, Disabled. Default settings include white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings. You can also override any fonts by manually specifying custom font files.
ENABLED
DISABLED
DvbSubtitleTeletextSpacing
Specify whether the Text spacing 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 for closed captions. Within your job settings, all of your DVB-Sub settings must be identical.
FIXED_GRID
PROPORTIONAL
AUTO
DvbSubtitlingType
Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.
HEARING_IMPAIRED
STANDARD
DvbTdtSettings
Use these settings to insert a DVB Time and Date Table (TDT) in the transport stream of this output.
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. |
DvbddsHandling
Specify how MediaConvert handles the display definition segment (DDS). To exclude the DDS from this set of captions: Keep the default, None. To include the DDS: Choose Specified. When you do, also specify the offset coordinates of the display window with DDS x-coordinate and DDS y-coordinate. To include the DDS, but not include display window data: Choose No display window. When you do, you can write position metadata to the page composition segment (PCS) with DDS x-coordinate and DDS y-coordinate. For video resolutions with a height of 576 pixels or less, MediaConvert doesn't include the DDS, regardless of the value you choose for DDS handling. All burn-in and DVB-Sub font settings must match.
NONE
SPECIFIED
NO_DISPLAY_WINDOW
Eac3AtmosBitstreamMode
Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).
COMPLETE_MAIN
Eac3AtmosCodingMode
The coding mode for Dolby Digital Plus JOC (Atmos).
CODING_MODE_AUTO
CODING_MODE_5_1_4
CODING_MODE_7_1_4
CODING_MODE_9_1_6
Eac3AtmosDialogueIntelligence
Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.
ENABLED
DISABLED
Eac3AtmosDownmixControl
Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom to provide downmix values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your downmix values: Left only/Right only surround, Left total/Right total surround, Left total/Right total center, Left only/Right only center, and Stereo downmix. When you keep Custom for Downmix control and you don't specify values for the related settings, MediaConvert uses default values for those settings.
SPECIFIED
INITIALIZE_FROM_SOURCE
Eac3AtmosDynamicRangeCompressionLine
Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the line operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression line. For information about the Dolby DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.
NONE
FILM_STANDARD
FILM_LIGHT
MUSIC_STANDARD
MUSIC_LIGHT
SPEECH
Eac3AtmosDynamicRangeCompressionRf
Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the RF operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression RF. For information about the Dolby DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.
NONE
FILM_STANDARD
FILM_LIGHT
MUSIC_STANDARD
MUSIC_LIGHT
SPEECH
Eac3AtmosDynamicRangeControl
Specify whether MediaConvert should use any dynamic range control metadata from your input file. Keep the default value, Custom, to provide dynamic range control values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your dynamic range control values: Dynamic range compression line and Dynamic range compression RF. When you keep the value Custom for Dynamic range control and you don't specify values for the related settings, MediaConvert uses default values for those settings.
SPECIFIED
INITIALIZE_FROM_SOURCE
Eac3AtmosMeteringMode
Choose how the service meters the loudness of your audio.
LEQ_A
ITU_BS_1770_1
ITU_BS_1770_2
ITU_BS_1770_3
ITU_BS_1770_4
Eac3AtmosSettings
Required when you set Codec to the value EAC3_ATMOS.
Property | Type | Required | Description |
---|---|---|---|
bitrate | integer Minimum: 384000 Maximum: 1024000 | False | Specify the average bitrate for this output in bits per second. Valid values: 384k, 448k, 576k, 640k, 768k, 1024k Default value: 448k Note that MediaConvert supports 384k only with channel-based immersive (CBI) 7.1.4 and 5.1.4 inputs. For CBI 9.1.6 and other input types, MediaConvert automatically increases your output bitrate to 448k. |
bitstreamMode | False | Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E). | |
codingMode | False | The coding mode for Dolby Digital Plus JOC (Atmos). | |
dialogueIntelligence | False | Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis. | |
downmixControl | False | Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom to provide downmix values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your downmix values: Left only/Right only surround, Left total/Right total surround, Left total/Right total center, Left only/Right only center, and Stereo downmix. When you keep Custom for Downmix control and you don't specify values for the related settings, MediaConvert uses default values for those settings. | |
dynamicRangeCompressionLine | False | Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the line operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression line. For information about the Dolby DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. | |
dynamicRangeCompressionRf | False | Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the RF operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression RF. For information about the Dolby DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. | |
dynamicRangeControl | False | Specify whether MediaConvert should use any dynamic range control metadata from your input file. Keep the default value, Custom, to provide dynamic range control values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your dynamic range control values: Dynamic range compression line and Dynamic range compression RF. When you keep the value Custom for Dynamic range control and you don't specify values for the related settings, MediaConvert uses default values for those settings. | |
loRoCenterMixLevel | number Format: float Minimum: -6.0 Maximum: 3.0 | False | Specify a value for the following Dolby Atmos setting: Left only/Right only center mix (Lo/Ro center). MediaConvert uses this value for downmixing. Default value: -3 dB. Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Left only/Right only center. |
loRoSurroundMixLevel | number Format: float Minimum: -60.0 Maximum: -1.5 | False | Specify a value for the following Dolby Atmos setting: Left only/Right only. MediaConvert uses this value for downmixing. Default value: -3 dB. Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Left only/Right only surround. |
ltRtCenterMixLevel | number Format: float Minimum: -6.0 Maximum: 3.0 | False | Specify a value for the following Dolby Atmos setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. Default value: -3 dB Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Left total/Right total center. |
ltRtSurroundMixLevel | number Format: float Minimum: -60.0 Maximum: -1.5 | False | Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. Default value: -3 dB Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, the service ignores Left total/Right total surround. |
meteringMode | False | Choose how the service meters the loudness of your audio. | |
sampleRate | integer Minimum: 48000 Maximum: 48000 | False | This value is always 48000. It represents the sample rate in Hz. |
speechThreshold | integer Minimum: 0 Maximum: 100 | False | Specify the percentage of audio content, from 0% to 100%, that must be speech in order for the encoder to use the measured speech loudness as the overall program loudness. Default value: 15% |
stereoDownmix | False | Choose how the service does stereo downmixing. Default value: Not indicated Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Stereo downmix. | |
surroundExMode | False | Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels. |
Eac3AtmosStereoDownmix
Choose how the service does stereo downmixing. Default value: Not indicated Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Stereo downmix.
NOT_INDICATED
STEREO
SURROUND
DPL2
Eac3AtmosSurroundExMode
Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.
NOT_INDICATED
ENABLED
DISABLED
Eac3AttenuationControl
If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
ATTENUATE_3_DB
NONE
Eac3BitstreamMode
Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).
COMPLETE_MAIN
COMMENTARY
EMERGENCY
HEARING_IMPAIRED
VISUALLY_IMPAIRED
Eac3CodingMode
Dolby Digital Plus coding mode. Determines number of channels.
CODING_MODE_1_0
CODING_MODE_2_0
CODING_MODE_3_2
Eac3DcFilter
Activates a DC highpass filter for all input channels.
ENABLED
DISABLED
Eac3DynamicRangeCompressionLine
Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the line operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.
NONE
FILM_STANDARD
FILM_LIGHT
MUSIC_STANDARD
MUSIC_LIGHT
SPEECH
Eac3DynamicRangeCompressionRf
Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the RF operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.
NONE
FILM_STANDARD
FILM_LIGHT
MUSIC_STANDARD
MUSIC_LIGHT
SPEECH
Eac3LfeControl
When encoding 3/2 audio, controls whether the LFE channel is enabled
LFE
NO_LFE
Eac3LfeFilter
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.
ENABLED
DISABLED
Eac3MetadataControl
When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
FOLLOW_INPUT
USE_CONFIGURED
Eac3PassthroughControl
When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
WHEN_POSSIBLE
NO_PASSTHROUGH
Eac3PhaseControl
Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode.
SHIFT_90_DEGREES
NO_SHIFT
Eac3Settings
Required when you set Codec to the value EAC3.
Property | Type | Required | Description |
---|---|---|---|
attenuationControl | False | If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. | |
bitrate | integer Minimum: 32000 Maximum: 3024000 | False | Specify the average bitrate in bits per second. The bitrate that you specify must be a multiple of 8000 within the allowed minimum and maximum values. Leave blank to use the default bitrate for the coding mode you select according ETSI TS 102 366. Valid bitrates for coding mode 1/0: Default: 96000. Minimum: 32000. Maximum: 3024000. Valid bitrates for coding mode 2/0: Default: 192000. Minimum: 96000. Maximum: 3024000. Valid bitrates for coding mode 3/2: Default: 384000. Minimum: 192000. Maximum: 3024000. |
bitstreamMode | False | Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E). | |
codingMode | False | Dolby Digital Plus coding mode. Determines number of channels. | |
dcFilter | False | Activates a DC highpass filter for all input channels. | |
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. |
dynamicRangeCompressionLine | False | Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the line operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. | |
dynamicRangeCompressionRf | False | Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the RF operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf. | |
lfeControl | False | When encoding 3/2 audio, controls whether the LFE channel is enabled | |
lfeFilter | False | Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode. | |
loRoCenterMixLevel | number Format: float Minimum: -60.0 Maximum: 3.0 | False | Specify a value for the following Dolby Digital Plus setting: Left only/Right only center mix. MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix. Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs for the setting Coding mode. If you choose a different value for Coding mode, the service ignores Left only/Right only center. |
loRoSurroundMixLevel | number Format: float Minimum: -60.0 Maximum: -1.5 | False | Specify a value for the following Dolby Digital Plus setting: Left only/Right only. MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix. Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs for the setting Coding mode. If you choose a different value for Coding mode, the service ignores Left only/Right only surround. |
ltRtCenterMixLevel | number Format: float Minimum: -60.0 Maximum: 3.0 | False | Specify a value for the following Dolby Digital Plus setting: Left total/Right total center mix. MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix. Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs for the setting Coding mode. If you choose a different value for Coding mode, the service ignores Left total/Right total center. |
ltRtSurroundMixLevel | number Format: float Minimum: -60.0 Maximum: -1.5 | False | Specify a value for the following Dolby Digital Plus setting: Left total/Right total surround mix. MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix. Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs for the setting Coding mode. If you choose a different value for Coding mode, the service ignores Left total/Right total surround. |
metadataControl | False | When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | |
passthroughControl | False | When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. | |
phaseControl | False | Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode. | |
sampleRate | integer Minimum: 48000 Maximum: 48000 | False | This value is always 48000. It represents the sample rate in Hz. |
stereoDownmix | False | Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, C, Ls, Rs for the setting Coding mode. If you choose a different value for Coding mode, the service ignores Stereo downmix. | |
surroundExMode | False | When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. | |
surroundMode | False | When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. |
Eac3StereoDownmix
Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, C, Ls, Rs for the setting Coding mode. If you choose a different value for Coding mode, the service ignores Stereo downmix.
NOT_INDICATED
LO_RO
LT_RT
DPL2
Eac3SurroundExMode
When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
NOT_INDICATED
ENABLED
DISABLED
Eac3SurroundMode
When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
NOT_INDICATED
ENABLED
DISABLED
EmbeddedConvert608To708
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.
UPCONVERT
DISABLED
EmbeddedDestinationSettings
Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html.
Property | Type | Required | Description |
---|---|---|---|
destination608ChannelNumber | integer Minimum: 1 Maximum: 4 | False | Ignore this setting unless your input captions are SCC format and your output captions are embedded in the video stream. Specify a CC number for each captions channel in this output. If you have two channels, choose CC numbers that aren't in the same field. For example, choose 1 and 3. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. |
destination708ServiceNumber | integer Minimum: 1 Maximum: 6 | False | Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a different number for each channel. To use this setting, also set Force 608 to 708 upconvert to Upconvert in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, MediaConvert uses the number that you specify for CC channel number for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. |
EmbeddedSourceSettings
Settings for embedded captions Source
Property | Type | Required | Description |
---|---|---|---|
convert608To708 | False | Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708. | |
source608ChannelNumber | integer Minimum: 1 Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. |
source608TrackNumber | integer Minimum: 1 Maximum: 1 | False | Specifies the video track index used for extracting captions. The system only supports one input video track, so this should always be set to '1'. |
terminateCaptions | False | By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting. |
EmbeddedTerminateCaptions
By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.
END_OF_INPUT
DISABLED
EmbeddedTimecodeOverride
Set Embedded timecode override to Use MDPM when your AVCHD input contains timecode tag data in the Modified Digital Video Pack Metadata. When you do, we recommend you also set Timecode source to Embedded. Leave Embedded timecode override blank, or set to None, when your input does not contain MDPM timecode.
NONE
USE_MDPM
EncryptionContractConfiguration
Specify the SPEKE version, either v1.0 or v2.0, that MediaConvert uses when encrypting your output. For more information, see: https://docs.aws.amazon.com/speke/latest/documentation/speke-api-specification.html To use SPEKE v1.0: Leave blank. To use SPEKE v2.0: Specify a SPEKE v2.0 video preset and a SPEKE v2.0 audio preset.
Property | Type | Required | Description |
---|---|---|---|
spekeAudioPreset | False | Specify which SPEKE version 2.0 audio preset MediaConvert uses to request content keys from your SPEKE server. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/drm-content-speke-v2-presets.html To encrypt to your audio outputs, choose from the following: Audio preset 1, Audio preset 2, or Audio preset 3. To encrypt your audio outputs, using the same content key for both your audio and video outputs: Choose Shared. When you do, you must also set SPEKE v2.0 video preset to Shared. To not encrypt your audio outputs: Choose Unencrypted. When you do, to encrypt your video outputs, you must also specify a SPEKE v2.0 video preset (other than Shared or Unencrypted). | |
spekeVideoPreset | False | Specify which SPEKE version 2.0 video preset MediaConvert uses to request content keys from your SPEKE server. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/drm-content-speke-v2-presets.html To encrypt to your video outputs, choose from the following: Video preset 1, Video preset 2, Video preset 3, Video preset 4, Video preset 5, Video preset 6, Video preset 7, or Video preset 8. To encrypt your video outputs, using the same content key for both your video and audio outputs: Choose Shared. When you do, you must also set SPEKE v2.0 audio preset to Shared. To not encrypt your video outputs: Choose Unencrypted. When you do, to encrypt your audio outputs, you must also specify a SPEKE v2.0 audio preset (other than Shared or Unencrypted). |
EsamManifestConfirmConditionNotification
ESAM ManifestConfirmConditionNotification defined by OC-SP-ESAM-API-I03-131025.
Property | Type | Required | Description |
---|---|---|---|
mccXml | string Pattern: | False | Provide your ESAM ManifestConfirmConditionNotification XML document inside your JSON job settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the Manifest Conditioning instructions in the message that you supply. |
EsamSettings
Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
Property | Type | Required | Description |
---|---|---|---|
manifestConfirmConditionNotification | False | Specifies an ESAM ManifestConfirmConditionNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the manifest conditioning instructions that you provide in the setting MCC XML. | |
responseSignalPreroll | integer Minimum: 0 Maximum: 30000 | False | Specifies the stream distance, in milliseconds, between the SCTE 35 messages that the transcoder places and the splice points that they refer to. If the time between the start of the asset and the SCTE-35 message is less than this value, then the transcoder places the SCTE-35 marker at the beginning of the stream. |
signalProcessingNotification | False | Specifies an ESAM SignalProcessingNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the signal processing instructions that you provide in the setting SCC XML. |
EsamSignalProcessingNotification
ESAM SignalProcessingNotification data defined by OC-SP-ESAM-API-I03-131025.
Property | Type | Required | Description |
---|---|---|---|
sccXml | string Pattern: | False | Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the signal processing instructions in the message that you supply. For your MPEG2-TS file outputs, if you want the service to place SCTE-35 markers at the insertion points you specify in the XML document, you must also enable SCTE-35 ESAM. Note that you can either specify an ESAM XML document or enable SCTE-35 passthrough. You can't do both. |
ExceptionBody
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
ExtendedDataServices
If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory.
Property | Type | Required | Description |
---|---|---|---|
copyProtectionAction | False | The action to take on copy and redistribution control XDS packets. If you select PASSTHROUGH, packets will not be changed. If you select STRIP, any packets will be removed in output captions. | |
vchipAction | False | The action to take on content advisory XDS packets. If you select PASSTHROUGH, packets will not be changed. If you select STRIP, any packets will be removed in output captions. |
F4vMoovPlacement
To place the MOOV atom at the beginning of your output, which is useful for progressive downloading: Leave blank or choose Progressive download. To place the MOOV at the end of your output: Choose Normal.
PROGRESSIVE_DOWNLOAD
NORMAL
F4vSettings
Settings for F4v container
Property | Type | Required | Description |
---|---|---|---|
moovPlacement | False | To place the MOOV atom at the beginning of your output, which is useful for progressive downloading: Leave blank or choose Progressive download. To place the MOOV at the end of your output: Choose Normal. |
FileGroupSettings
Settings related to your File output group. MediaConvert uses this group of settings to generate a single standalone file, rather than a streaming package.
Property | Type | Required | Description |
---|---|---|---|
destination | string Pattern: | False | Use Destination to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. |
destinationSettings | False | Settings associated with the destination. Will vary based on the type of destination |
FileSourceConvert608To708
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.
UPCONVERT
DISABLED
FileSourceSettings
If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.
Property | Type | Required | Description |
---|---|---|---|
byteRateLimit | False | Choose whether to limit the byte rate at which your SCC input captions are inserted into your output. To not limit the caption rate: We recommend that you keep the default value, Disabled. MediaConvert inserts captions in your output according to the byte rates listed in the EIA-608 specification, typically 2 or 3 caption bytes per frame depending on your output frame rate. To limit your output caption rate: Choose Enabled. Choose this option if your downstream systems require a maximum of 2 caption bytes per frame. Note that this setting has no effect when your output frame rate is 30 or 60. | |
convert608To708 | False | Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708. | |
convertPaintToPop | False | Choose the presentation style of your input SCC captions. To use the same presentation style as your input: Keep the default value, Disabled. To convert paint-on captions to pop-on: Choose Enabled. We also recommend that you choose Enabled if you notice additional repeated lines in your output captions. | |
framerate | False | Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction. For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps. | |
sourceFile | string Pattern: MinLength: 14 | False | External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', 'smi', 'webvtt', and 'vtt'. |
timeDelta | integer Minimum: -2147483648 Maximum: 2147483647 | False | Optional. Use this setting when you need to adjust the sync between your sidecar captions and your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/time-delta-use-cases.html. Enter a positive or negative number to modify the times in the captions file. For example, type 15 to add 15 seconds to all the times in the captions file. Type -5 to subtract 5 seconds from the times in the captions file. You can optionally specify your time delta in milliseconds instead of seconds. When you do so, set the related setting, Time delta units to Milliseconds. Note that, when you specify a time delta for timecode-based caption sources, such as SCC and STL, and your time delta isn't a multiple of the input frame rate, MediaConvert snaps the captions to the nearest frame. For example, when your input video frame rate is 25 fps and you specify 1010ms for time delta, MediaConvert delays your captions by 1000 ms. |
timeDeltaUnits | False | When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units, MediaConvert uses seconds by default. |
FileSourceTimeDeltaUnits
When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units, MediaConvert uses seconds by default.
SECONDS
MILLISECONDS
FlacSettings
Required when you set Codec, under AudioDescriptions>CodecSettings, to the value FLAC.
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: 8 | False | Specify the number of channels in this output audio track. Choosing Mono on the console gives you 1 output channel; choosing Stereo gives you 2. In the API, valid values are between 1 and 8. |
sampleRate | integer Minimum: 22050 Maximum: 48000 | False | Sample rate in Hz. |
FontScript
Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset.
AUTOMATIC
HANS
HANT
ForceIncludeRenditionSize
Use Force include renditions to specify one or more resolutions to include your ABR stack. * (Recommended) To optimize automated ABR, specify as few resolutions as possible. * (Required) The number of resolutions that you specify must be equal to, or less than, the Max renditions setting. * If you specify a Min top rendition size rule, specify at least one resolution that is equal to, or greater than, Min top rendition size. * If you specify a Min bottom rendition size rule, only specify resolutions that are equal to, or greater than, Min bottom rendition size. * If you specify a Force include renditions rule, do not specify a separate rule for Allowed renditions. * Note: The ABR stack may include other resolutions that you do not specify here, depending on the Max renditions setting.
Property | Type | Required | Description |
---|---|---|---|
height | integer Minimum: 32 Maximum: 8192 | False | Use Height to define the video resolution height, in pixels, for this rule. |
width | integer Minimum: 32 Maximum: 8192 | False | Use Width to define the video resolution width, in pixels, for this rule. |
FrameCaptureSettings
Required when you set Codec to the value FRAME_CAPTURE.
Property | Type | Required | Description |
---|---|---|---|
framerateDenominator | integer Minimum: 1 Maximum: 2147483647 | False | Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture. |
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. |
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. |
H264AdaptiveQuantization
Keep the default value, Auto, for this setting to have MediaConvert automatically apply the best types of quantization for your video content. When you want to apply your quantization settings manually, you must set H264AdaptiveQuantization to a value other than Auto. Use this setting to specify the strength of any adaptive quantization filters that you enable. If you don't want MediaConvert to do any adaptive quantization in this transcode, set Adaptive quantization to Off. Related settings: The value that you choose here applies to the following settings: H264FlickerAdaptiveQuantization, H264SpatialAdaptiveQuantization, and H264TemporalAdaptiveQuantization.
OFF
AUTO
LOW
MEDIUM
HIGH
HIGHER
MAX
H264CodecLevel
Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto.
AUTO
LEVEL_1
LEVEL_1_1
LEVEL_1_2
LEVEL_1_3
LEVEL_2
LEVEL_2_1
LEVEL_2_2
LEVEL_3
LEVEL_3_1
LEVEL_3_2
LEVEL_4
LEVEL_4_1
LEVEL_4_2
LEVEL_5
LEVEL_5_1
LEVEL_5_2
H264CodecProfile
H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.
BASELINE
HIGH
HIGH_10BIT
HIGH_422
HIGH_422_10BIT
MAIN
H264DynamicSubGop
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames.
ADAPTIVE
STATIC
H264EndOfStreamMarkers
Optionally include or suppress markers at the end of your output that signal the end of the video stream. To include end of stream markers: Leave blank or keep the default value, Include. To not include end of stream markers: Choose Suppress. This is useful when your output will be inserted into another stream.
INCLUDE
SUPPRESS
H264EntropyEncoding
Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC.
CABAC
CAVLC
H264FieldEncoding
The video encoding method for your MPEG-4 AVC output. Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force field to disable PAFF encoding and create separate interlaced fields. Choose MBAFF to disable PAFF and have MediaConvert use MBAFF encoding for interlaced outputs.
PAFF
FORCE_FIELD
MBAFF
H264FlickerAdaptiveQuantization
Only use this setting when you change the default value, AUTO, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264FlickerAdaptiveQuantization is Disabled. Change this value to Enabled to reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. To manually enable or disable H264FlickerAdaptiveQuantization, you must set Adaptive quantization to a value other than AUTO.
DISABLED
ENABLED
H264FramerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction.
INITIALIZE_FROM_SOURCE
SPECIFIED
H264FramerateConversionAlgorithm
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.
DUPLICATE_DROP
INTERPOLATE
FRAMEFORMER
H264GopBReference
Specify whether to allow B-frames to be referenced by other frame types. To use reference B-frames when your GOP structure has 1 or more B-frames: Leave blank or keep the default value Enabled. We recommend that you choose Enabled to help improve the video quality of your output relative to its bitrate. To not use reference B-frames: Choose Disabled.
DISABLED
ENABLED
H264GopSizeUnits
Specify how the transcoder determines GOP size for this output. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, choose Auto and and leave GOP size blank. By default, if you don't specify GOP mode control, MediaConvert will use automatic behavior. If your output group specifies HLS, DASH, or CMAF, set GOP mode control to Auto and leave GOP size blank in each output in your output group. To explicitly specify the GOP length, choose Specified, frames or Specified, seconds and then provide the GOP length in the related setting GOP size.
FRAMES
SECONDS
AUTO
H264InterlaceMode
Choose the scan line type for the output. Keep the default value, Progressive to create a progressive output, regardless of the scan type of your input. Use Top field first or Bottom field first to create an output that's interlaced with the same field polarity throughout. Use Follow, default top or Follow, default bottom to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.
PROGRESSIVE
TOP_FIELD
BOTTOM_FIELD
FOLLOW_TOP_FIELD
FOLLOW_BOTTOM_FIELD
H264ParControl
Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source, uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.
INITIALIZE_FROM_SOURCE
SPECIFIED
H264QualityTuningLevel
The Quality tuning level you choose represents a trade-off between the encoding speed of your job and the output video quality. For the fastest encoding speed at the cost of video quality: Choose Single pass. For a good balance between encoding speed and video quality: Leave blank or keep the default value Single pass HQ. For the best video quality, at the cost of encoding speed: Choose Multi pass HQ. MediaConvert performs an analysis pass on your input followed by an encoding pass. Outputs that use this feature incur pro-tier pricing.
SINGLE_PASS
SINGLE_PASS_HQ
MULTI_PASS_HQ
H264QvbrSettings
Settings for quality-defined variable bitrate encoding with the H.264 codec. Use these settings only when you set QVBR for Rate control mode.
Property | Type | Required | Description |
---|---|---|---|
maxAverageBitrate | integer Minimum: 1000 Maximum: 1152000000 | False | Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value that you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output. |
qvbrQualityLevel | integer Minimum: 1 Maximum: 10 | False | Use this setting only when you set Rate control mode to QVBR. Specify the target quality level for this output. MediaConvert determines the right number of bits to use for each part of the video to maintain the video quality that you specify. When you keep the default value, AUTO, MediaConvert picks a quality level for you, based on characteristics of your input video. If you prefer to specify a quality level, specify a number from 1 through 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. Optionally, to specify a value between whole numbers, also provide a value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. |
qvbrQualityLevelFineTune | number Format: float Minimum: 0.0 Maximum: 1.0 | False | Optional. Specify a value here to set the QVBR quality to a level that is between whole numbers. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33. |
H264RateControlMode
Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).
VBR
CBR
QVBR
H264RepeatPps
Places a PPS header on each encoded picture, even if repeated.
DISABLED
ENABLED
H264SaliencyAwareEncoding
Specify whether to apply Saliency aware encoding to your output. Use to improve the perceptual video quality of your output by allocating more encoding bits to the prominent or noticeable parts of your content. To apply saliency aware encoding, when possible: We recommend that you choose Preferred. The effects of Saliency aware encoding are best seen in lower bitrate outputs. When you choose Preferred, note that Saliency aware encoding will only apply to outputs that are 720p or higher in resolution. To not apply saliency aware encoding, prioritizing encoding speed over perceptual video quality: Choose Disabled.
DISABLED
PREFERRED
H264ScanTypeConversionMode
Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing to create a better quality interlaced output. In this case, each progressive frame from the input corresponds to an interlaced field in the output. Keep the default value, Basic interlacing, for all other output frame rates. With basic interlacing, MediaConvert performs any frame rate conversion first and then interlaces the frames. When you choose Optimized interlacing and you set your output frame rate to a value that isn't suitable for optimized interlacing, MediaConvert automatically falls back to basic interlacing. Required settings: To use optimized interlacing, you must set Telecine to None or Soft. You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode to a value other than Progressive.
INTERLACED
INTERLACED_OPTIMIZE
H264SceneChangeDetect
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.
DISABLED
ENABLED
TRANSITION_DETECTION
H264Settings
Required when you set Codec to the value H_264.
Property | Type | Required | Description |
---|---|---|---|
adaptiveQuantization | False | Keep the default value, Auto, for this setting to have MediaConvert automatically apply the best types of quantization for your video content. When you want to apply your quantization settings manually, you must set H264AdaptiveQuantization to a value other than Auto. Use this setting to specify the strength of any adaptive quantization filters that you enable. If you don't want MediaConvert to do any adaptive quantization in this transcode, set Adaptive quantization to Off. Related settings: The value that you choose here applies to the following settings: H264FlickerAdaptiveQuantization, H264SpatialAdaptiveQuantization, and H264TemporalAdaptiveQuantization. | |
bandwidthReductionFilter | False | The Bandwidth reduction filter increases the video quality of your output relative to its bitrate. Use to lower the bitrate of your constant quality QVBR output, with little or no perceptual decrease in quality. Or, use to increase the video quality of outputs with other rate control modes relative to the bitrate that you specify. Bandwidth reduction increases further when your input is low quality or noisy. Outputs that use this feature incur pro-tier pricing. When you include Bandwidth reduction filter, you cannot include the Noise reducer preprocessor. | |
bitrate | integer Minimum: 1000 Maximum: 1152000000 | False | Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000. |
codecLevel | False | Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto. | |
codecProfile | False | H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License. | |
dynamicSubGop | False | Specify whether to allow the number of B-frames in your output GOP structure to vary or not depending on your input video content. To improve the subjective video quality of your output that has high-motion content: Leave blank or keep the default value Adaptive. MediaConvert will use fewer B-frames for high-motion video content than low-motion content. The maximum number of B- frames is limited by the value that you choose for B-frames between reference frames. To use the same number B-frames for all types of content: Choose Static. | |
endOfStreamMarkers | False | Optionally include or suppress markers at the end of your output that signal the end of the video stream. To include end of stream markers: Leave blank or keep the default value, Include. To not include end of stream markers: Choose Suppress. This is useful when your output will be inserted into another stream. | |
entropyEncoding | False | Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC. | |
fieldEncoding | False | The video encoding method for your MPEG-4 AVC output. Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force field to disable PAFF encoding and create separate interlaced fields. Choose MBAFF to disable PAFF and have MediaConvert use MBAFF encoding for interlaced outputs. | |
flickerAdaptiveQuantization | False | Only use this setting when you change the default value, AUTO, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264FlickerAdaptiveQuantization is Disabled. Change this value to Enabled to reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. To manually enable or disable H264FlickerAdaptiveQuantization, you must set Adaptive quantization to a value other than AUTO. | |
framerateControl | False | If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. | |
framerateConversionAlgorithm | False | Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. | |
framerateDenominator | integer Minimum: 1 Maximum: 2147483647 | False | When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. |
framerateNumerator | integer Minimum: 1 Maximum: 2147483647 | False | When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. |
gopBReference | False | Specify whether to allow B-frames to be referenced by other frame types. To use reference B-frames when your GOP structure has 1 or more B-frames: Leave blank or keep the default value Enabled. We recommend that you choose Enabled to help improve the video quality of your output relative to its bitrate. To not use reference B-frames: Choose Disabled. | |
gopClosedCadence | integer Minimum: 0 Maximum: 2147483647 | False | Specify the relative frequency of open to closed GOPs in this output. For example, if you want to allow four open GOPs and then require a closed GOP, set this value to 5. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. In the console, do this by keeping the default empty value. If you do explicitly specify a value, for segmented outputs, don't set this value to 0. |
gopSize | number Format: float Minimum: 0.0 | False | Use this setting only when you set GOP mode control to Specified, frames or Specified, seconds. Specify the GOP length using a whole number of frames or a decimal value of seconds. MediaConvert will interpret this value as frames or seconds depending on the value you choose for GOP mode control. If you want to allow MediaConvert to automatically determine GOP size, leave GOP size blank and set GOP mode control to Auto. If your output group specifies HLS, DASH, or CMAF, leave GOP size blank and set GOP mode control to Auto in each output in your output group. |
gopSizeUnits | False | Specify how the transcoder determines GOP size for this output. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, choose Auto and and leave GOP size blank. By default, if you don't specify GOP mode control, MediaConvert will use automatic behavior. If your output group specifies HLS, DASH, or CMAF, set GOP mode control to Auto and leave GOP size blank in each output in your output group. To explicitly specify the GOP length, choose Specified, frames or Specified, seconds and then provide the GOP length in the related setting GOP size. | |
hrdBufferFinalFillPercentage | integer Minimum: 0 Maximum: 100 | False | If your downstream systems have strict buffer requirements: Specify the minimum percentage of the HRD buffer that's available at the end of each encoded video segment. For the best video quality: Set to 0 or leave blank to automatically determine the final buffer fill percentage. |
hrdBufferInitialFillPercentage | integer Minimum: 0 Maximum: 100 | False | Percentage of the buffer that should initially be filled (HRD buffer model). |
hrdBufferSize | integer Minimum: 0 Maximum: 1152000000 | False | Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. |
interlaceMode | False | Choose the scan line type for the output. Keep the default value, Progressive to create a progressive output, regardless of the scan type of your input. Use Top field first or Bottom field first to create an output that's interlaced with the same field polarity throughout. Use Follow, default top or Follow, default bottom to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose. | |
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. |
minIInterval | integer Minimum: 0 Maximum: 30 | False | Specify the minimum number of frames allowed between two IDR-frames in your output. This includes frames created at the start of a GOP or a scene change. Use Min I-Interval to improve video compression by varying GOP size when two IDR-frames would be created near each other. For example, if a regular cadence-driven IDR-frame would fall within 5 frames of a scene-change IDR-frame, and you set Min I-interval to 5, then the encoder would only write an IDR-frame for the scene-change. In this way, one GOP is shortened or extended. If a cadence-driven IDR-frame would be further than 5 frames from a scene-change IDR-frame, then the encoder leaves all IDR-frames in place. To use an automatically determined interval: We recommend that you keep this value blank. This allows for MediaConvert to use an optimal setting according to the characteristics of your input video, and results in better video compression. To manually specify an interval: Enter a value from 1 to 30. Use when your downstream systems have specific GOP size requirements. To disable GOP size variance: Enter 0. MediaConvert will only create IDR-frames at the start of your output's cadence-driven GOP. Use when your downstream systems require a regular GOP size. |
numberBFramesBetweenReferenceFrames | integer Minimum: 0 Maximum: 7 | False | Specify the number of B-frames between reference frames in this output. For the best video quality: Leave blank. MediaConvert automatically determines the number of B-frames to use based on the characteristics of your input video. To manually specify the number of B-frames between reference frames: Enter an integer from 0 to 7. |
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. |
parControl | False | Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source, uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings. | |
parDenominator | integer Minimum: 1 Maximum: 2147483647 | False | Required when you set Pixel aspect ratio to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33. |
parNumerator | integer Minimum: 1 Maximum: 2147483647 | False | Required when you set Pixel aspect ratio to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40. |
qualityTuningLevel | False | The Quality tuning level you choose represents a trade-off between the encoding speed of your job and the output video quality. For the fastest encoding speed at the cost of video quality: Choose Single pass. For a good balance between encoding speed and video quality: Leave blank or keep the default value Single pass HQ. For the best video quality, at the cost of encoding speed: Choose Multi pass HQ. MediaConvert performs an analysis pass on your input followed by an encoding pass. Outputs that use this feature incur pro-tier pricing. | |
qvbrSettings | False | Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set QVBR for Rate control mode. | |
rateControlMode | False | Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR). | |
repeatPps | False | Places a PPS header on each encoded picture, even if repeated. | |
saliencyAwareEncoding | False | Specify whether to apply Saliency aware encoding to your output. Use to improve the perceptual video quality of your output by allocating more encoding bits to the prominent or noticeable parts of your content. To apply saliency aware encoding, when possible: We recommend that you choose Preferred. The effects of Saliency aware encoding are best seen in lower bitrate outputs. When you choose Preferred, note that Saliency aware encoding will only apply to outputs that are 720p or higher in resolution. To not apply saliency aware encoding, prioritizing encoding speed over perceptual video quality: Choose Disabled. | |
scanTypeConversionMode | False | Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing to create a better quality interlaced output. In this case, each progressive frame from the input corresponds to an interlaced field in the output. Keep the default value, Basic interlacing, for all other output frame rates. With basic interlacing, MediaConvert performs any frame rate conversion first and then interlaces the frames. When you choose Optimized interlacing and you set your output frame rate to a value that isn't suitable for optimized interlacing, MediaConvert automatically falls back to basic interlacing. Required settings: To use optimized interlacing, you must set Telecine to None or Soft. You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode to a value other than Progressive. | |
sceneChangeDetect | False | Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. | |
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. |
slowPal | False | Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. | |
softness | integer Minimum: 0 Maximum: 128 | False | Ignore this setting unless you need to comply with a specification that requires a specific value. If you don't have a specification requirement, we recommend that you adjust the softness of your output by using a lower value for the setting Sharpness or by enabling a noise reducer filter. The Softness setting specifies the quantization matrices that the encoder uses. Keep the default value, 0, for flat quantization. Choose the value 1 or 16 to use the default JVT softening quantization matricies from the H.264 specification. Choose a value from 17 to 128 to use planar interpolation. Increasing values from 17 to 128 result in increasing reduction of high-frequency data. The value 128 results in the softest video. |
spatialAdaptiveQuantization | False | Only use this setting when you change the default value, Auto, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264SpatialAdaptiveQuantization is Enabled. Keep this default value to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to set H264SpatialAdaptiveQuantization to Disabled. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher. To manually enable or disable H264SpatialAdaptiveQuantization, you must set Adaptive quantization to a value other than AUTO. | |
syntax | False | Produces a bitstream compliant with SMPTE RP-2027. | |
telecine | False | When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or soft telecine to create a smoother picture. Hard telecine produces a 29.97i output. Soft telecine produces an output with a 23.976 output that signals to the video player device to do the conversion during play back. When you keep the default value, None, MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture. | |
temporalAdaptiveQuantization | False | Only use this setting when you change the default value, AUTO, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264TemporalAdaptiveQuantization is Enabled. Keep this default value to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to set H264TemporalAdaptiveQuantization to Disabled. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization. To manually enable or disable H264TemporalAdaptiveQuantization, you must set Adaptive quantization to a value other than AUTO. | |
unregisteredSeiTimecode | False | Inserts timecode for each frame as 4 bytes of an unregistered SEI message. |
H264SlowPal
Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25.
DISABLED
ENABLED
H264SpatialAdaptiveQuantization
Only use this setting when you change the default value, Auto, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264SpatialAdaptiveQuantization is Enabled. Keep this default value to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to set H264SpatialAdaptiveQuantization to Disabled. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher. To manually enable or disable H264SpatialAdaptiveQuantization, you must set Adaptive quantization to a value other than AUTO.
DISABLED
ENABLED
H264Syntax
Produces a bitstream compliant with SMPTE RP-2027.
DEFAULT
RP2027
H264Telecine
When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or soft telecine to create a smoother picture. Hard telecine produces a 29.97i output. Soft telecine produces an output with a 23.976 output that signals to the video player device to do the conversion during play back. When you keep the default value, None, MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.
NONE
SOFT
HARD
H264TemporalAdaptiveQuantization
Only use this setting when you change the default value, AUTO, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264TemporalAdaptiveQuantization is Enabled. Keep this default value to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to set H264TemporalAdaptiveQuantization to Disabled. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization. To manually enable or disable H264TemporalAdaptiveQuantization, you must set Adaptive quantization to a value other than AUTO.
DISABLED
ENABLED
H264UnregisteredSeiTimecode
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.
DISABLED
ENABLED
H265AdaptiveQuantization
When you set Adaptive Quantization to Auto, or leave blank, MediaConvert automatically applies quantization to improve the video quality of your output. Set Adaptive Quantization to Low, Medium, High, Higher, or Max to manually control the strength of the quantization filter. When you do, you can specify a value for Spatial Adaptive Quantization, Temporal Adaptive Quantization, and Flicker Adaptive Quantization, to further control the quantization filter. Set Adaptive Quantization to Off to apply no quantization to your output.
OFF
LOW
MEDIUM
HIGH
HIGHER
MAX
AUTO
H265AlternateTransferFunctionSei
Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF).
DISABLED
ENABLED
H265CodecLevel
H.265 Level.
AUTO
LEVEL_1
LEVEL_2
LEVEL_2_1
LEVEL_3
LEVEL_3_1
LEVEL_4
LEVEL_4_1
LEVEL_5
LEVEL_5_1
LEVEL_5_2
LEVEL_6
LEVEL_6_1
LEVEL_6_2
H265CodecProfile
Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so "Main/High" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License.
MAIN_MAIN
MAIN_HIGH
MAIN10_MAIN
MAIN10_HIGH
MAIN_422_8BIT_MAIN
MAIN_422_8BIT_HIGH
MAIN_422_10BIT_MAIN
MAIN_422_10BIT_HIGH
H265DynamicSubGop
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames.
ADAPTIVE
STATIC
H265EndOfStreamMarkers
Optionally include or suppress markers at the end of your output that signal the end of the video stream. To include end of stream markers: Leave blank or keep the default value, Include. To not include end of stream markers: Choose Suppress. This is useful when your output will be inserted into another stream.
INCLUDE
SUPPRESS
H265FlickerAdaptiveQuantization
Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set adaptiveQuantization to a value other than Off.
DISABLED
ENABLED
H265FramerateControl
Use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction.
INITIALIZE_FROM_SOURCE
SPECIFIED
H265FramerateConversionAlgorithm
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.
DUPLICATE_DROP
INTERPOLATE
FRAMEFORMER
H265GopBReference
Specify whether to allow B-frames to be referenced by other frame types. To use reference B-frames when your GOP structure has 1 or more B-frames: Leave blank or keep the default value Enabled. We recommend that you choose Enabled to help improve the video quality of your output relative to its bitrate. To not use reference B-frames: Choose Disabled.
DISABLED
ENABLED
H265GopSizeUnits
Specify how the transcoder determines GOP size for this output. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, choose Auto and and leave GOP size blank. By default, if you don't specify GOP mode control, MediaConvert will use automatic behavior. If your output group specifies HLS, DASH, or CMAF, set GOP mode control to Auto and leave GOP size blank in each output in your output group. To explicitly specify the GOP length, choose Specified, frames or Specified, seconds and then provide the GOP length in the related setting GOP size.
FRAMES
SECONDS
AUTO
H265InterlaceMode
Choose the scan line type for the output. Keep the default value, Progressive to create a progressive output, regardless of the scan type of your input. Use Top field first or Bottom field first to create an output that's interlaced with the same field polarity throughout. Use Follow, default top or Follow, default bottom to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.
PROGRESSIVE
TOP_FIELD
BOTTOM_FIELD
FOLLOW_TOP_FIELD
FOLLOW_BOTTOM_FIELD
H265ParControl
Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source, uses the PAR from your input video for your output. To specify a different PAR, choose any value other than Follow source. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.
INITIALIZE_FROM_SOURCE
SPECIFIED
H265QualityTuningLevel
Optional. Use Quality tuning level to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.
SINGLE_PASS
SINGLE_PASS_HQ
MULTI_PASS_HQ
H265QvbrSettings
Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set QVBR for Rate control mode.
Property | Type | Required | Description |
---|---|---|---|
maxAverageBitrate | integer Minimum: 1000 Maximum: 1466400000 | False | Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value that you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output. |
qvbrQualityLevel | integer Minimum: 1 Maximum: 10 | False | Use this setting only when you set Rate control mode to QVBR. Specify the target quality level for this output. MediaConvert determines the right number of bits to use for each part of the video to maintain the video quality that you specify. When you keep the default value, AUTO, MediaConvert picks a quality level for you, based on characteristics of your input video. If you prefer to specify a quality level, specify a number from 1 through 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. Optionally, to specify a value between whole numbers, also provide a value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. |
qvbrQualityLevelFineTune | number Format: float Minimum: 0.0 Maximum: 1.0 | False | Optional. Specify a value here to set the QVBR quality to a level that is between whole numbers. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33. |
H265RateControlMode
Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).
VBR
CBR
QVBR
H265SampleAdaptiveOffsetFilterMode
Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content
DEFAULT
ADAPTIVE
OFF
H265ScanTypeConversionMode
Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing to create a better quality interlaced output. In this case, each progressive frame from the input corresponds to an interlaced field in the output. Keep the default value, Basic interlacing, for all other output frame rates. With basic interlacing, MediaConvert performs any frame rate conversion first and then interlaces the frames. When you choose Optimized interlacing and you set your output frame rate to a value that isn't suitable for optimized interlacing, MediaConvert automatically falls back to basic interlacing. Required settings: To use optimized interlacing, you must set Telecine to None or Soft. You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode to a value other than Progressive.
INTERLACED
INTERLACED_OPTIMIZE
H265SceneChangeDetect
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.
DISABLED
ENABLED
TRANSITION_DETECTION
H265Settings
Settings for H265 codec
Property | Type | Required | Description |
---|---|---|---|
adaptiveQuantization | False | When you set Adaptive Quantization to Auto, or leave blank, MediaConvert automatically applies quantization to improve the video quality of your output. Set Adaptive Quantization to Low, Medium, High, Higher, or Max to manually control the strength of the quantization filter. When you do, you can specify a value for Spatial Adaptive Quantization, Temporal Adaptive Quantization, and Flicker Adaptive Quantization, to further control the quantization filter. Set Adaptive Quantization to Off to apply no quantization to your output. | |
alternateTransferFunctionSei | False | Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF). | |
bandwidthReductionFilter | False | The Bandwidth reduction filter increases the video quality of your output relative to its bitrate. Use to lower the bitrate of your constant quality QVBR output, with little or no perceptual decrease in quality. Or, use to increase the video quality of outputs with other rate control modes relative to the bitrate that you specify. Bandwidth reduction increases further when your input is low quality or noisy. Outputs that use this feature incur pro-tier pricing. When you include Bandwidth reduction filter, you cannot include the Noise reducer preprocessor. | |
bitrate | integer Minimum: 1000 Maximum: 1466400000 | False | Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000. |
codecLevel | False | H.265 Level. | |
codecProfile | False | Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so "Main/High" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License. | |
dynamicSubGop | False | Specify whether to allow the number of B-frames in your output GOP structure to vary or not depending on your input video content. To improve the subjective video quality of your output that has high-motion content: Leave blank or keep the default value Adaptive. MediaConvert will use fewer B-frames for high-motion video content than low-motion content. The maximum number of B- frames is limited by the value that you choose for B-frames between reference frames. To use the same number B-frames for all types of content: Choose Static. | |
endOfStreamMarkers | False | Optionally include or suppress markers at the end of your output that signal the end of the video stream. To include end of stream markers: Leave blank or keep the default value, Include. To not include end of stream markers: Choose Suppress. This is useful when your output will be inserted into another stream. | |
flickerAdaptiveQuantization | False | Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set adaptiveQuantization to a value other than Off. | |
framerateControl | False | Use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. | |
framerateConversionAlgorithm | False | Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. | |
framerateDenominator | integer Minimum: 1 Maximum: 2147483647 | False | When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. |
framerateNumerator | integer Minimum: 1 Maximum: 2147483647 | False | When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976. |
gopBReference | False | Specify whether to allow B-frames to be referenced by other frame types. To use reference B-frames when your GOP structure has 1 or more B-frames: Leave blank or keep the default value Enabled. We recommend that you choose Enabled to help improve the video quality of your output relative to its bitrate. To not use reference B-frames: Choose Disabled. | |
gopClosedCadence | integer Minimum: 0 Maximum: 2147483647 | False | Specify the relative frequency of open to closed GOPs in this output. For example, if you want to allow four open GOPs and then require a closed GOP, set this value to 5. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, do this by keeping the default empty value. If you do explicitly specify a value, for segmented outputs, don't set this value to 0. |
gopSize | number Format: float Minimum: 0.0 | False | Use this setting only when you set GOP mode control to Specified, frames or Specified, seconds. Specify the GOP length using a whole number of frames or a decimal value of seconds. MediaConvert will interpret this value as frames or seconds depending on the value you choose for GOP mode control. If you want to allow MediaConvert to automatically determine GOP size, leave GOP size blank and set GOP mode control to Auto. If your output group specifies HLS, DASH, or CMAF, leave GOP size blank and set GOP mode control to Auto in each output in your output group. |
gopSizeUnits | False | Specify how the transcoder determines GOP size for this output. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, choose Auto and and leave GOP size blank. By default, if you don't specify GOP mode control, MediaConvert will use automatic behavior. If your output group specifies HLS, DASH, or CMAF, set GOP mode control to Auto and leave GOP size blank in each output in your output group. To explicitly specify the GOP length, choose Specified, frames or Specified, seconds and then provide the GOP length in the related setting GOP size. | |
hrdBufferFinalFillPercentage | integer Minimum: 0 Maximum: 100 | False | If your downstream systems have strict buffer requirements: Specify the minimum percentage of the HRD buffer that's available at the end of each encoded video segment. For the best video quality: Set to 0 or leave blank to automatically determine the final buffer fill percentage. |
hrdBufferInitialFillPercentage | integer Minimum: 0 Maximum: 100 | False | Percentage of the buffer that should initially be filled (HRD buffer model). |
hrdBufferSize | integer Minimum: 0 Maximum: 1466400000 | False | Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. |
interlaceMode | False | Choose the scan line type for the output. Keep the default value, Progressive to create a progressive output, regardless of the scan type of your input. Use Top field first or Bottom field first to create an output that's interlaced with the same field polarity throughout. Use Follow, default top or Follow, default bottom to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose. | |
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. |
minIInterval | integer Minimum: 0 Maximum: 30 | False | Specify the minimum number of frames allowed between two IDR-frames in your output. This includes frames created at the start of a GOP or a scene change. Use Min I-Interval to improve video compression by varying GOP size when two IDR-frames would be created near each other. For example, if a regular cadence-driven IDR-frame would fall within 5 frames of a scene-change IDR-frame, and you set Min I-interval to 5, then the encoder would only write an IDR-frame for the scene-change. In this way, one GOP is shortened or extended. If a cadence-driven IDR-frame would be further than 5 frames from a scene-change IDR-frame, then the encoder leaves all IDR-frames in place. To use an automatically determined interval: We recommend that you keep this value blank. This allows for MediaConvert to use an optimal setting according to the characteristics of your input video, and results in better video compression. To manually specify an interval: Enter a value from 1 to 30. Use when your downstream systems have specific GOP size requirements. To disable GOP size variance: Enter 0. MediaConvert will only create IDR-frames at the start of your output's cadence-driven GOP. Use when your downstream systems require a regular GOP size. |
numberBFramesBetweenReferenceFrames | integer Minimum: 0 Maximum: 7 | False | Specify the number of B-frames between reference frames in this output. For the best video quality: Leave blank. MediaConvert automatically determines the number of B-frames to use based on the characteristics of your input video. To manually specify the number of B-frames between reference frames: Enter an integer from 0 to 7. |
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. |
parControl | False | Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source, uses the PAR from your input video for your output. To specify a different PAR, choose any value other than Follow source. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings. | |
parDenominator | integer Minimum: 1 Maximum: 2147483647 | False | Required when you set Pixel aspect ratio to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33. |
parNumerator | integer Minimum: 1 Maximum: 2147483647 | False | Required when you set Pixel aspect ratio to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40. |
qualityTuningLevel | False | Optional. Use Quality tuning level to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding. | |
qvbrSettings | False | Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set QVBR for Rate control mode. | |
rateControlMode | False | Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR). | |
sampleAdaptiveOffsetFilterMode | False | Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content | |
scanTypeConversionMode | False | Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing to create a better quality interlaced output. In this case, each progressive frame from the input corresponds to an interlaced field in the output. Keep the default value, Basic interlacing, for all other output frame rates. With basic interlacing, MediaConvert performs any frame rate conversion first and then interlaces the frames. When you choose Optimized interlacing and you set your output frame rate to a value that isn't suitable for optimized interlacing, MediaConvert automatically falls back to basic interlacing. Required settings: To use optimized interlacing, you must set Telecine to None or Soft. You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode to a value other than Progressive. | |
sceneChangeDetect | False | Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. | |
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. |
slowPal | False | Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. | |
spatialAdaptiveQuantization | False | Keep the default value, Enabled, to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher. | |
telecine | False | This field applies only if the Streams > Advanced > Framerate field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field and the Streams > Advanced > Interlaced Mode field 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. | |
temporalAdaptiveQuantization | False | Keep the default value, Enabled, to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization. | |
temporalIds | False | Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame rate output. | |
tiles | False | Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures. | |
unregisteredSeiTimecode | False | Inserts timecode for each frame as 4 bytes of an unregistered SEI message. | |
writeMp4PackagingType | False | If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting only with CMAF or DASH outputs, or with standalone file outputs in an MPEG-4 container (MP4 outputs). Choose HVC1 to mark your output as HVC1. This makes your output compliant with the following specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. For MP4 outputs, when you choose HVC1, your output video might not work properly with some downstream systems and video players. The service defaults to marking your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples. |
H265SlowPal
Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25.
DISABLED
ENABLED
H265SpatialAdaptiveQuantization
Keep the default value, Enabled, to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.
DISABLED
ENABLED
H265Telecine
This field applies only if the Streams > Advanced > Framerate field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field and the Streams > Advanced > Interlaced Mode field 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
Keep the default value, Enabled, to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization.
DISABLED
ENABLED
H265TemporalIds
Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame rate output.
DISABLED
ENABLED
H265Tiles
Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures.
DISABLED
ENABLED
H265UnregisteredSeiTimecode
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.
DISABLED
ENABLED
H265WriteMp4PackagingType
If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting only with CMAF or DASH outputs, or with standalone file outputs in an MPEG-4 container (MP4 outputs). Choose HVC1 to mark your output as HVC1. This makes your output compliant with the following specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. For MP4 outputs, when you choose HVC1, your output video might not work properly with some downstream systems and video players. The service defaults to marking your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples.
HVC1
HEV1
HDRToSDRToneMapper
Specify how MediaConvert maps brightness and colors from your HDR input to your SDR output. The mode that you select represents a creative choice, with different tradeoffs in the details and tones of your output. To maintain details in bright or saturated areas of your output: Choose Preserve details. For some sources, your SDR output may look less bright and less saturated when compared to your HDR source. MediaConvert automatically applies this mode for HLG sources, regardless of your choice. For a bright and saturated output: Choose Vibrant. We recommend that you choose this mode when any of your source content is HDR10, and for the best results when it is mastered for 1000 nits. You may notice loss of details in bright or saturated areas of your output. HDR to SDR tone mapping has no effect when your input is SDR.
PRESERVE_DETAILS
VIBRANT
Hdr10Metadata
Use these settings to specify static color calibration metadata, as defined by SMPTE ST 2086. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator.
Property | Type | Required | Description |
---|---|---|---|
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. |
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. |
maxContentLightLevel | integer Minimum: 0 Maximum: 65535 | False | Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content. |
maxFrameAverageLightLevel | integer Minimum: 0 Maximum: 65535 | False | Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content. |
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 |
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. |
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. |
Hdr10Plus
Setting for HDR10+ metadata insertion
Property | Type | Required | Description |
---|---|---|---|
masteringMonitorNits | integer Minimum: 0 Maximum: 4000 | False | Specify the HDR10+ mastering display normalized peak luminance, in nits. This is the normalized actual peak luminance of the mastering display, as defined by ST 2094-40. |
targetMonitorNits | integer Minimum: 0 Maximum: 4000 | False | Specify the HDR10+ target display nominal peak luminance, in nits. This is the nominal maximum luminance of the target display as defined by ST 2094-40. |
HlsAdMarkers
Ad marker for Apple HLS manifest.
ELEMENTAL
ELEMENTAL_SCTE35
HlsAdditionalManifest
Specify the details for each additional HLS manifest that you want the service to generate for this output group. Each manifest can reference a different subset of outputs in the group.
Property | Type | Required | Description |
---|---|---|---|
manifestNameModifier | string MinLength: 1 | False | Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your HLS group is film-name.m3u8. If you enter "-no-premium" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.m3u8. For HLS output groups, specify a manifestNameModifier that is different from the nameModifier of the output. The service uses the output name modifier to create unique names for the individual variant manifests. |
selectedOutputs | Array of type string MinLength: 1 | False | Specify the outputs that you want this additional top-level manifest to reference. |
HlsAudioOnlyContainer
Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic to create a raw audio-only file with no container. Regardless of the value that you specify here, if this output has video, the service will place outputs into an MPEG2-TS container.
AUTOMATIC
M2TS
HlsAudioOnlyHeader
Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include, to output audio-only headers. Choose Exclude to remove the audio-only headers from your audio segments.
INCLUDE
EXCLUDE
HlsAudioTrackType
Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO
ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT
ALTERNATE_AUDIO_AUTO_SELECT
ALTERNATE_AUDIO_NOT_AUTO_SELECT
AUDIO_ONLY_VARIANT_STREAM
HlsCaptionLanguageMapping
Caption Language Mapping
Property | Type | Required | Description |
---|---|---|---|
captionChannel | integer Minimum: -2147483648 Maximum: 2147483647 | False | Caption channel. |
customLanguageCode | string Pattern: MinLength: 3 MaxLength: 3 | False | Specify the language for this captions channel, using the ISO 639-2 or ISO 639-3 three-letter language code |
languageCode | False | Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php. | |
languageDescription | string | False | Caption language description. |
HlsCaptionLanguageSetting
Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.
INSERT
OMIT
NONE
HlsCaptionSegmentLengthControl
Set Caption segment length control to Match video to create caption segments that align with the video segments from the first video output in this output group. For example, if the video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments to create caption segments that are 300 seconds long.
LARGE_SEGMENTS
MATCH_VIDEO
HlsClientCache
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled and control caching in your video distribution set up. For example, use the Cache-Control http header.
DISABLED
ENABLED
HlsCodecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
RFC_6381
RFC_4281
HlsDescriptiveVideoServiceFlag
Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag, MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag, MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.
DONT_FLAG
FLAG
HlsDirectoryStructure
Indicates whether segments should be placed in subdirectories.
SINGLE_DIRECTORY
SUBDIRECTORY_PER_STREAM
HlsEncryptionSettings
Settings for HLS encryption
Property | Type | Required | Description |
---|---|---|---|
constantInitializationVector | string Pattern: MinLength: 32 MaxLength: 32 | False | This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default. |
encryptionMethod | False | Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption. | |
initializationVectorInManifest | False | The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest. | |
offlineEncrypted | False | Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection. | |
spekeKeyProvider | False | If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead. | |
staticKeyProvider | False | Use these settings to set up encryption with a static key provider. | |
type | False | Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. |
HlsEncryptionType
Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.
AES128
SAMPLE_AES
HlsGroupSettings
Settings related to your HLS output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html.
Property | Type | Required | Description |
---|---|---|---|
additionalManifests | Array of type HlsAdditionalManifest | False | By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here. |
adMarkers | Array of type HlsAdMarkers | False | Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves. |
audioOnlyHeader | False | Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include, to output audio-only headers. Choose Exclude to remove the audio-only headers from your audio segments. | |
baseUrl | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. |
captionLanguageMappings | Array of type HlsCaptionLanguageMapping | False | Language to be used on Caption outputs |
captionLanguageSetting | False | Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest. | |
captionSegmentLengthControl | False | Set Caption segment length control to Match video to create caption segments that align with the video segments from the first video output in this output group. For example, if the video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments to create caption segments that are 300 seconds long. | |
clientCache | False | Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled and control caching in your video distribution set up. For example, use the Cache-Control http header. | |
codecSpecification | False | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. | |
destination | string Pattern: | False | Use Destination to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. |
destinationSettings | False | Settings associated with the destination. Will vary based on the type of destination | |
directoryStructure | False | Indicates whether segments should be placed in subdirectories. | |
encryption | False | DRM settings. | |
imageBasedTrickPlay | False | Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md | |
imageBasedTrickPlaySettings | False | Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED | |
manifestCompression | False | When set to GZIP, compresses HLS playlist. | |
manifestDurationFormat | False | Indicates whether the output manifest should use floating point values for segment duration. | |
minFinalSegmentLength | number Format: float Minimum: 0.0 Maximum: 2.147483647E9 | False | Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds. |
minSegmentLength | integer Minimum: 0 Maximum: 2147483647 | False | When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed. |
outputSelection | False | Indicates whether the .m3u8 manifest file should be generated for this HLS output group. | |
programDateTime | False | Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset. | |
programDateTimePeriod | integer Minimum: 0 Maximum: 3600 | False | Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. |
progressiveWriteHlsManifest | False | Specify whether MediaConvert generates HLS manifests while your job is running or when your job is complete. To generate HLS manifests while your job is running: Choose Enabled. Use if you want to play back your content as soon as it's available. MediaConvert writes the parent and child manifests after the first three media segments are written to your destination S3 bucket. It then writes new updated manifests after each additional segment is written. The parent manifest includes the latest BANDWIDTH and AVERAGE-BANDWIDTH attributes, and child manifests include the latest available media segment. When your job completes, the final child playlists include an EXT-X-ENDLIST tag. To generate HLS manifests only when your job completes: Choose Disabled. | |
segmentControl | False | When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback. | |
segmentLength | integer Minimum: 1 Maximum: 2147483647 | False | Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 10. Related settings: Use Segment length control to specify whether the encoder enforces this value strictly. Use Segment control to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries. |
segmentLengthControl | False | Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary. | |
segmentsPerSubdirectory | integer Minimum: 1 Maximum: 2147483647 | False | Specify the number of segments to write to a subdirectory before starting a new one. You must also set Directory structure to Subdirectory per stream for this setting to have an effect. |
streamInfResolution | False | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. | |
targetDurationCompatibilityMode | False | When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration. | |
timedMetadataId3Frame | False | Specify the type of the ID3 frame to use for ID3 timestamps in your output. To include ID3 timestamps: Specify PRIV or TDRL and set ID3 metadata to Passthrough. To exclude ID3 timestamps: Set ID3 timestamp frame type to None. | |
timedMetadataId3Period | integer Minimum: -2147483648 Maximum: 2147483647 | False | Specify the interval in seconds to write ID3 timestamps in your output. The first timestamp starts at the output timecode and date, and increases incrementally with each ID3 timestamp. To use the default interval of 10 seconds: Leave blank. To include this metadata in your output: Set ID3 timestamp frame type to PRIV or TDRL, and set ID3 metadata to Passthrough. |
timestampDeltaMilliseconds | integer Minimum: -2147483648 Maximum: 2147483647 | False | Provides an extra millisecond delta offset to fine tune the timestamps. |
HlsIFrameOnlyManifest
Choose Include to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude.
INCLUDE
EXCLUDE
HlsImageBasedTrickPlay
Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md
NONE
THUMBNAIL
THUMBNAIL_AND_FULLFRAME
ADVANCED
HlsImageBasedTrickPlaySettings
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
Property | Type | Required | Description |
---|---|---|---|
intervalCadence | False | The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval. | |
thumbnailHeight | integer Minimum: 2 Maximum: 4096 | False | Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2. |
thumbnailInterval | number Format: float Minimum: 0.0 Maximum: 2.147483647E9 | False | Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails. |
thumbnailWidth | integer Minimum: 8 Maximum: 4096 | False | Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8. |
tileHeight | integer Minimum: 1 Maximum: 2048 | False | Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2. |
tileWidth | integer Minimum: 1 Maximum: 512 | False | Number of thumbnails in each row of a tile image. Set a value between 1 and 512. |
HlsInitializationVectorInManifest
The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.
INCLUDE
EXCLUDE
HlsIntervalCadence
The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.
FOLLOW_IFRAME
FOLLOW_CUSTOM
HlsKeyProviderType
Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.
SPEKE
STATIC_KEY
HlsManifestCompression
When set to GZIP, compresses HLS playlist.
GZIP
NONE
HlsManifestDurationFormat
Indicates whether the output manifest should use floating point values for segment duration.
FLOATING_POINT
INTEGER
HlsOfflineEncrypted
Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.
ENABLED
DISABLED
HlsOutputSelection
Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
MANIFESTS_AND_SEGMENTS
SEGMENTS_ONLY
HlsProgramDateTime
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.
INCLUDE
EXCLUDE
HlsProgressiveWriteHlsManifest
Specify whether MediaConvert generates HLS manifests while your job is running or when your job is complete. To generate HLS manifests while your job is running: Choose Enabled. Use if you want to play back your content as soon as it's available. MediaConvert writes the parent and child manifests after the first three media segments are written to your destination S3 bucket. It then writes new updated manifests after each additional segment is written. The parent manifest includes the latest BANDWIDTH and AVERAGE-BANDWIDTH attributes, and child manifests include the latest available media segment. When your job completes, the final child playlists include an EXT-X-ENDLIST tag. To generate HLS manifests only when your job completes: Choose Disabled.
ENABLED
DISABLED
HlsRenditionGroupSettings
Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead.
Property | Type | Required | Description |
---|---|---|---|
renditionGroupId | string | False | Optional. Specify alternative group ID |
renditionLanguageCode | False | Optional. Specify ISO 639-2 or ISO 639-3 code in the language property | |
renditionName | string | False | Optional. Specify media name |
HlsSegmentControl
When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.
SINGLE_FILE
SEGMENTED_FILES
HlsSegmentLengthControl
Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.
EXACT
GOP_MULTIPLE
HlsSettings
Settings for HLS output groups
Property | Type | Required | Description |
---|---|---|---|
audioGroupId | string | False | Specifies the group to which the audio rendition belongs. |
audioOnlyContainer | False | Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container. | |
audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. |
audioTrackType | False | Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO | |
descriptiveVideoServiceFlag | False | Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag, MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag, MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation. | |
iFrameOnlyManifest | False | Choose Include to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude. | |
segmentModifier | string | False | Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html |
HlsStreamInfResolution
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
INCLUDE
EXCLUDE
HlsTargetDurationCompatibilityMode
When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (< 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.
LEGACY
SPEC_COMPLIANT
HlsTimedMetadataId3Frame
Specify the type of the ID3 frame to use for ID3 timestamps in your output. To include ID3 timestamps: Specify PRIV or TDRL and set ID3 metadata to Passthrough. To exclude ID3 timestamps: Set ID3 timestamp frame type to None.
NONE
PRIV
TDRL
HopDestination
Optional. Configuration for a destination queue to which the job can hop once a customer-defined minimum wait time has passed.
Property | Type | Required | Description |
---|---|---|---|
priority | integer Format: int32 Minimum: -50 Maximum: 50 | False | Optional. When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don't specify, the relative priority will remain the same as in the previous queue. |
queue | string | False | Optional unless the job is submitted on the default queue. When you set up a job to use queue hopping, you can specify a destination queue. This queue cannot be the original queue to which the job is submitted. If the original queue isn't the default queue and you don't specify the destination queue, the job will move to the default queue. |
waitMinutes | integer | False | Required for setting up a job to use queue hopping. Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 4320 minutes, inclusive. |
Id3Insertion
To insert ID3 tags in your output, specify two values. Use ID3 tag to specify the base 64 encoded string and use Timecode to specify the time when the tag should be inserted. To insert multiple ID3 tags in your output, create multiple instances of ID3 insertion.
Property | Type | Required | Description |
---|---|---|---|
id3 | string Pattern: | False | Use ID3 tag to provide a fully formed ID3 tag in base64-encode format. |
timecode | string Format: timecode Pattern: | False | Provide a Timecode in HH:MM:SS:FF or HH:MM:SS;FF format. |
ImageInserter
Use the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input or output individually. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/graphic-overlay.html. 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. |
sdrReferenceWhiteLevel | integer Minimum: 100 Maximum: 1000 | False | Specify the reference white level, in nits, for all of your image inserter images. Use to correct brightness levels within HDR10 outputs. For 1,000 nit peak brightness displays, we recommend that you set SDR reference white level to 203 (according to ITU-R BT.2408). Leave blank to use the default value of 100, or specify an integer from 100 to 1000. |
ImscAccessibilitySubs
If the IMSC captions track is intended to provide accessibility for people who are deaf or hard of hearing: Set Accessibility subtitles to Enabled. When you do, MediaConvert adds accessibility attributes to your output HLS or DASH manifest. For HLS manifests, MediaConvert adds the following accessibility attributes under EXT-X-MEDIA for this track: CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". For DASH manifests, MediaConvert adds the following in the adaptation set for this track: <Accessibility schemeIdUri="urn:mpeg:dash:role:2011" value="caption"/>. If the captions track is not intended to provide such accessibility: Keep the default value, Disabled. When you do, for DASH manifests, MediaConvert instead adds the following in the adaptation set for this track: <Role schemeIDUri="urn:mpeg:dash:role:2011" value="subtitle"/>.
DISABLED
ENABLED
ImscDestinationSettings
Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html.
Property | Type | Required | Description |
---|---|---|---|
accessibility | False | If the IMSC captions track is intended to provide accessibility for people who are deaf or hard of hearing: Set Accessibility subtitles to Enabled. When you do, MediaConvert adds accessibility attributes to your output HLS or DASH manifest. For HLS manifests, MediaConvert adds the following accessibility attributes under EXT-X-MEDIA for this track: CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". For DASH manifests, MediaConvert adds the following in the adaptation set for this track: <Accessibility schemeIdUri="urn:mpeg:dash:role:2011" value="caption"/>. If the captions track is not intended to provide such accessibility: Keep the default value, Disabled. When you do, for DASH manifests, MediaConvert instead adds the following in the adaptation set for this track: <Role schemeIDUri="urn:mpeg:dash:role:2011" value="subtitle"/>. | |
stylePassthrough | False | Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions. |
ImscStylePassthrough
Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions.
ENABLED
DISABLED
Input
Use inputs to define the source files used in your transcoding job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/specify-input-settings.html. You can use multiple video inputs to do input stitching. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/assembling-multiple-inputs-and-input-clips.html
Property | Type | Required | Description |
---|---|---|---|
advancedInputFilter | False | Use to remove noise, blocking, blurriness, or ringing from your input as a pre-filter step before encoding. The Advanced input filter removes more types of compression artifacts and is an improvement when compared to basic Deblock and Denoise filters. To remove video compression artifacts from your input and improve the video quality: Choose Enabled. Additionally, this filter can help increase the video quality of your output relative to its bitrate, since noisy inputs are more complex and require more bits to encode. To help restore loss of detail after applying the filter, you can optionally add texture or sharpening as an additional step. Jobs that use this feature incur pro-tier pricing. To not apply advanced input filtering: Choose Disabled. Note that you can still apply basic filtering with Deblock and Denoise. | |
advancedInputFilterSettings | False | Optional settings for Advanced input filter when you set Advanced input filter to Enabled. | |
audioSelectorGroups | object | False | Use audio selector groups to combine multiple sidecar audio inputs so that you can assign them to a single output audio tab. Note that, if you're working with embedded audio, it's simpler to assign multiple input tracks into a single audio selector rather than use an audio selector group. |
audioSelectors | object | False | Use Audio selectors to specify a track or set of tracks from the input that you will use in your outputs. You can use multiple Audio selectors per input. |
captionSelectors | object | False | Use captions selectors to specify the captions data from your input that you use in your outputs. You can use up to 100 captions selectors per input. |
crop | False | Use Cropping selection to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection. | |
deblockFilter | False | Enable Deblock to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs. | |
decryptionSettings | False | Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content. | |
denoiseFilter | False | Enable Denoise to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs. | |
dolbyVisionMetadataXml | string Pattern: MinLength: 14 | False | Use this setting only when your video source has Dolby Vision studio mastering metadata that is carried in a separate XML file. Specify the Amazon S3 location for the metadata XML file. MediaConvert uses this file to provide global and frame-level metadata for Dolby Vision preprocessing. When you specify a file here and your input also has interleaved global and frame level metadata, MediaConvert ignores the interleaved metadata and uses only the the metadata from this external XML file. Note that your IAM service role must grant MediaConvert read permissions to this file. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. |
fileInput | string Pattern: | False | Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, "s3://bucket/vf/cpl.xml". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* to specify any supplemental IMPs that contain assets referenced by the CPL. |
filterEnable | False | Specify whether to apply input filtering to improve the video quality of your input. To apply filtering depending on your input type and quality: Choose Auto. To apply no filtering: Choose Disable. To apply filtering regardless of your input type and quality: Choose Force. When you do, you must also specify a value for Filter strength. | |
filterStrength | integer Minimum: 0 Maximum: 5 | False | Specify the strength of the input filter. To apply an automatic amount of filtering based the compression artifacts measured in your input: We recommend that you leave Filter strength blank and set Filter enable to Auto. To manually apply filtering: Enter a value from 1 to 5, where 1 is the least amount of filtering and 5 is the most. The value that you enter applies to the strength of the Deblock or Denoise filters, or to the strength of the Advanced input filter. |
imageInserter | False | Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input individually. This setting is disabled by default. | |
inputClippings | Array of type InputClipping | False | Contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them. |
inputScanType | False | When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn't automatically detect PsF. Therefore, flagging your input as PsF results in better preservation of video quality when you do deinterlacing and frame rate conversion. If you don't specify, the default value is Auto. Auto is the correct setting for all inputs that are not PsF. Don't set this value to PsF when your input is interlaced. Doing so creates horizontal interlacing artifacts. | |
position | False | Use Selection placement to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement. If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD to Respond. If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior. | |
programNumber | integer Minimum: 1 Maximum: 2147483647 | False | Use Program to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default. |
psiControl | False | Set PSI control for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data. | |
supplementalImps | Array of type string Pattern: | False | Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you're using for your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the ASSETMAP.xml files. For example ["s3://bucket/ov/", "s3://bucket/vf2/ASSETMAP.xml"]. You don't need to specify the IMP that contains your input CPL, because the service automatically detects it. |
timecodeSource | False | Use this Timecode source setting, located under the input settings, to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded to use the timecodes in your input video. Choose Start at zero to start the first frame at zero. Choose Specified start to start the first frame at the timecode that you specify in the setting Start timecode. If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode. | |
timecodeStart | string Pattern: MinLength: 11 MaxLength: 11 | False | Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings, to Specified start. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode. |
videoGenerator | False | When you include Video generator, MediaConvert creates a video input with black frames. Use this setting if you do not have a video input or if you want to add black video frames before, or after, other inputs. You can specify Video generator, or you can specify an Input file, but you cannot specify both. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-generator.html | |
videoOverlays | Array of type VideoOverlay | False | Contains an array of video overlays. |
videoSelector | False | Input video selectors contain the video settings for the input. Each of your inputs can have up to one video selector. |
InputClipping
To transcode only portions of your input, include one input clip for each part of your input that you want in your output. All input clips that you specify will be included in every output of the job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/assembling-multiple-inputs-and-input-clips.html.
Property | Type | Required | Description |
---|---|---|---|
endTimecode | string Format: timecode Pattern: | False | Set End timecode to the end of the portion of the input you are clipping. The frame corresponding to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for timecode source under input settings. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end six minutes into the video, use 01:06:00:00. |
startTimecode | string Format: timecode Pattern: | False | Set Start timecode to the beginning of the portion of the input you are clipping. The frame corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:05:00:00. |
InputDeblockFilter
Enable Deblock to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.
ENABLED
DISABLED
InputDecryptionSettings
Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content.
Property | Type | Required | Description |
---|---|---|---|
decryptionMode | False | Specify the encryption mode that you used to encrypt your input files. | |
encryptedDecryptionKey | string Pattern: MinLength: 24 MaxLength: 512 | False | Warning! Don't provide your encryption key in plaintext. Your job settings could be intercepted, making your encrypted content vulnerable. Specify the encrypted version of the data key that you used to encrypt your content. The data key must be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or 256 bits. |
initializationVector | string Pattern: MinLength: 16 MaxLength: 24 | False | Specify the initialization vector that you used when you encrypted your content before uploading it to Amazon S3. You can use a 16-byte initialization vector with any encryption mode. Or, you can use a 12-byte initialization vector with GCM or CTR. MediaConvert accepts only initialization vectors that are base64-encoded. |
kmsKeyRegion | string Pattern: MinLength: 9 MaxLength: 19 | False | Specify the AWS Region for AWS Key Management Service (KMS) that you used to encrypt your data key, if that Region is different from the one you are using for AWS Elemental MediaConvert. |
InputDenoiseFilter
Enable Denoise to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.
ENABLED
DISABLED
InputFilterEnable
Specify whether to apply input filtering to improve the video quality of your input. To apply filtering depending on your input type and quality: Choose Auto. To apply no filtering: Choose Disable. To apply filtering regardless of your input type and quality: Choose Force. When you do, you must also specify a value for Filter strength.
AUTO
DISABLE
FORCE
InputPsiControl
Set PSI control for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.
IGNORE_PSI
USE_PSI
InputRotate
Use Rotate to specify how the service rotates your video. You can choose automatic rotation or specify a rotation. You can specify a clockwise rotation of 0, 90, 180, or 270 degrees. If your input video container is .mov or .mp4 and your input has rotation metadata, you can choose Automatic to have the service rotate your video according to the rotation specified in the metadata. The rotation must be within one degree of 90, 180, or 270 degrees. If the rotation metadata specifies any other rotation, the service will default to no rotation. By default, the service does no rotation, even if your input video has rotation metadata. The service doesn't pass through rotation metadata.
DEGREE_0
DEGREES_90
DEGREES_180
DEGREES_270
AUTO
InputSampleRange
If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow, for this setting. When you do, the service automatically detects your input sample range. If your input video has metadata indicating the wrong sample range, specify the accurate sample range here. When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for transcoding and also writes it to the output metadata.
FOLLOW
FULL_RANGE
LIMITED_RANGE
InputScanType
When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn't automatically detect PsF. Therefore, flagging your input as PsF results in better preservation of video quality when you do deinterlacing and frame rate conversion. If you don't specify, the default value is Auto. Auto is the correct setting for all inputs that are not PsF. Don't set this value to PsF when your input is interlaced. Doing so creates horizontal interlacing artifacts.
AUTO
PSF
InputTimecodeSource
Use this Timecode source setting, located under the input settings, to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded to use the timecodes in your input video. Choose Start at zero to start the first frame at zero. Choose Specified start to start the first frame at the timecode that you specify in the setting Start timecode. If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.
EMBEDDED
ZEROBASED
SPECIFIEDSTART
InputVideoGenerator
When you include Video generator, MediaConvert creates a video input with black frames. Use this setting if you do not have a video input or if you want to add black video frames before, or after, other inputs. You can specify Video generator, or you can specify an Input file, but you cannot specify both. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-generator.html
Property | Type | Required | Description |
---|---|---|---|
channels | integer Minimum: 1 Maximum: 32 | False | Specify the number of audio channels to include in your video generator input. MediaConvert creates these audio channels as silent audio within a single audio track. Enter an integer from 1 to 32. |
duration | integer Minimum: 50 Maximum: 86400000 | False | Specify the duration, in milliseconds, for your video generator input. Enter an integer from 50 to 86400000. |
framerateDenominator | integer Minimum: 1 Maximum: 1001 | False | Specify the denominator of the fraction that represents the frame rate for your video generator input. When you do, you must also specify a value for Frame rate numerator. MediaConvert uses a default frame rate of 29.97 when you leave Frame rate numerator and Frame rate denominator blank. |
framerateNumerator | integer Minimum: 1 Maximum: 60000 | False | Specify the numerator of the fraction that represents the frame rate for your video generator input. When you do, you must also specify a value for Frame rate denominator. MediaConvert uses a default frame rate of 29.97 when you leave Frame rate numerator and Frame rate denominator blank. |
sampleRate | integer Minimum: 32000 Maximum: 48000 | False | Specify the audio sample rate, in Hz, for the silent audio in your video generator input. Enter an integer from 32000 to 48000. |
InsertableImage
These settings apply to a specific graphic overlay. You can include multiple overlays in your job.