JobTemplates
URI
/2017-08-29/jobTemplates
HTTP methods
GET
Operation ID: ListJobTemplates
Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array
|
| Name | Type | Required | Description |
|---|
category | String | False | |
listBy | String | False | |
nextToken | String | False | |
maxResults | String | False | |
order | String | False | |
|
| Status code | Response model | Description |
|---|
200 | ListJobTemplatesResponse | 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: CreateJobTemplate
Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
|
| Status code | Response model | Description |
|---|
201 | CreateJobTemplateResponse | 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
{
"description": "string",
"category": "string",
"queue": "string",
"name": "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,
"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
},
"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,
"klvMetadata": enum
},
"cmfcSettings": {
"scte35Source": enum,
"scte35Esam": enum,
"audioDuration": enum,
"iFrameOnlyManifest": enum,
"audioGroupId": "string",
"audioRenditionSets": "string",
"audioTrackType": enum,
"descriptiveVideoServiceFlag": enum,
"timedMetadata": 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,
"contrast": integer,
"hue": integer,
"saturation": integer,
"hdr10Metadata": {
"redPrimaryX": integer,
"redPrimaryY": integer,
"greenPrimaryX": integer,
"greenPrimaryY": integer,
"bluePrimaryX": integer,
"bluePrimaryY": integer,
"whitePointX": integer,
"whitePointY": integer,
"maxFrameAverageLightLevel": integer,
"maxContentLightLevel": integer,
"maxLuminance": integer,
"minLuminance": integer
}
},
"deinterlacer": {
"algorithm": enum,
"mode": enum,
"control": enum
},
"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
}
]
},
"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
},
"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,
"codecLevel": enum,
"fieldEncoding": enum,
"sceneChangeDetect": enum,
"qualityTuningLevel": enum,
"framerateConversionAlgorithm": enum,
"unregisteredSeiTimecode": enum,
"gopSizeUnits": enum,
"parControl": enum,
"numberBFramesBetweenReferenceFrames": integer,
"repeatPps": enum,
"dynamicSubGop": enum
},
"h265Settings": {
"interlaceMode": enum,
"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
},
"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
},
"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
},
"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
},
"audioChannelTaggingSettings": {
"channelTag": 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
},
"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
},
"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,
"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,
"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
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"encryption": {
"encryptionMethod": enum,
"constantInitializationVector": "string",
"initializationVectorInManifest": enum,
"offlineEncrypted": enum,
"spekeKeyProvider": {
"resourceId": "string",
"systemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
},
"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,
"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
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"encryption": {
"playbackDeviceCompatibility": enum,
"spekeKeyProvider": {
"resourceId": "string",
"systemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
}
},
"minBufferTime": integer,
"fragmentLength": integer,
"baseUrl": "string",
"segmentControl": enum,
"ptsOffsetHandlingForBFrames": enum,
"mpdProfile": enum,
"hbbtvCompliance": enum,
"writeSegmentTimelineInRepresentation": enum,
"imageBasedTrickPlay": enum,
"imageBasedTrickPlaySettings": {
"thumbnailHeight": integer,
"thumbnailWidth": integer,
"tileHeight": integer,
"tileWidth": integer,
"intervalCadence": enum,
"thumbnailInterval": number
}
},
"fileGroupSettings": {
"destination": "string",
"destinationSettings": {
"s3Settings": {
"encryption": {
"encryptionType": enum,
"kmsKeyArn": "string",
"kmsEncryptionContext": "string"
},
"accessControl": {
"cannedAcl": enum
}
}
}
},
"msSmoothGroupSettings": {
"destination": "string",
"destinationSettings": {
"s3Settings": {
"encryption": {
"encryptionType": enum,
"kmsKeyArn": "string",
"kmsEncryptionContext": "string"
},
"accessControl": {
"cannedAcl": enum
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"fragmentLength": integer,
"fragmentLengthControl": enum,
"encryption": {
"spekeKeyProvider": {
"resourceId": "string",
"systemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
}
},
"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
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"encryption": {
"encryptionMethod": enum,
"constantInitializationVector": "string",
"initializationVectorInManifest": enum,
"spekeKeyProvider": {
"resourceId": "string",
"hlsSignaledSystemIds": [
"string"
],
"dashSignaledSystemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
},
"staticKeyProvider": {
"staticKeyValue": "string",
"keyFormat": "string",
"keyFormatVersions": "string",
"url": "string"
},
"type": enum
},
"minBufferTime": integer,
"fragmentLength": integer,
"baseUrl": "string",
"segmentControl": enum,
"ptsOffsetHandlingForBFrames": enum,
"mpdProfile": enum,
"writeSegmentTimelineInRepresentation": enum,
"manifestDurationFormat": enum,
"streamInfResolution": enum,
"clientCache": enum,
"manifestCompression": enum,
"codecSpecification": enum,
"imageBasedTrickPlay": enum,
"imageBasedTrickPlaySettings": {
"thumbnailHeight": integer,
"thumbnailWidth": integer,
"tileHeight": integer,
"tileWidth": integer,
"intervalCadence": enum,
"thumbnailInterval": number
}
}
},
"automatedEncodingSettings": {
"abrSettings": {
"maxRenditions": integer,
"maxAbrBitrate": integer,
"minAbrBitrate": integer
}
}
}
],
"adAvailOffset": integer,
"availBlanking": {
"availBlankingImage": "string"
},
"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
},
"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,
"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
}
]
},
"dolbyVisionMetadataXml": "string",
"crop": {
"height": integer,
"width": integer,
"x": integer,
"y": integer
},
"position": {
"height": integer,
"width": integer,
"x": integer,
"y": integer
}
}
]
},
"tags": {
},
"accelerationSettings": {
"mode": enum
},
"statusUpdateInterval": enum,
"priority": integer,
"hopDestinations": [
{
"waitMinutes": integer,
"queue": "string",
"priority": integer
}
]
}
Response bodies
{
"jobTemplates": [
{
"arn": "string",
"createdAt": "string",
"lastUpdated": "string",
"description": "string",
"category": "string",
"queue": "string",
"name": "string",
"type": enum,
"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,
"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
},
"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,
"klvMetadata": enum
},
"cmfcSettings": {
"scte35Source": enum,
"scte35Esam": enum,
"audioDuration": enum,
"iFrameOnlyManifest": enum,
"audioGroupId": "string",
"audioRenditionSets": "string",
"audioTrackType": enum,
"descriptiveVideoServiceFlag": enum,
"timedMetadata": 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,
"contrast": integer,
"hue": integer,
"saturation": integer,
"hdr10Metadata": {
"redPrimaryX": integer,
"redPrimaryY": integer,
"greenPrimaryX": integer,
"greenPrimaryY": integer,
"bluePrimaryX": integer,
"bluePrimaryY": integer,
"whitePointX": integer,
"whitePointY": integer,
"maxFrameAverageLightLevel": integer,
"maxContentLightLevel": integer,
"maxLuminance": integer,
"minLuminance": integer
}
},
"deinterlacer": {
"algorithm": enum,
"mode": enum,
"control": enum
},
"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
}
]
},
"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
},
"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,
"codecLevel": enum,
"fieldEncoding": enum,
"sceneChangeDetect": enum,
"qualityTuningLevel": enum,
"framerateConversionAlgorithm": enum,
"unregisteredSeiTimecode": enum,
"gopSizeUnits": enum,
"parControl": enum,
"numberBFramesBetweenReferenceFrames": integer,
"repeatPps": enum,
"dynamicSubGop": enum
},
"h265Settings": {
"interlaceMode": enum,
"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
},
"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
},
"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
},
"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
},
"audioChannelTaggingSettings": {
"channelTag": 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
},
"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
},
"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,
"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,
"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
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"encryption": {
"encryptionMethod": enum,
"constantInitializationVector": "string",
"initializationVectorInManifest": enum,
"offlineEncrypted": enum,
"spekeKeyProvider": {
"resourceId": "string",
"systemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
},
"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,
"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
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"encryption": {
"playbackDeviceCompatibility": enum,
"spekeKeyProvider": {
"resourceId": "string",
"systemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
}
},
"minBufferTime": integer,
"fragmentLength": integer,
"baseUrl": "string",
"segmentControl": enum,
"ptsOffsetHandlingForBFrames": enum,
"mpdProfile": enum,
"hbbtvCompliance": enum,
"writeSegmentTimelineInRepresentation": enum,
"imageBasedTrickPlay": enum,
"imageBasedTrickPlaySettings": {
"thumbnailHeight": integer,
"thumbnailWidth": integer,
"tileHeight": integer,
"tileWidth": integer,
"intervalCadence": enum,
"thumbnailInterval": number
}
},
"fileGroupSettings": {
"destination": "string",
"destinationSettings": {
"s3Settings": {
"encryption": {
"encryptionType": enum,
"kmsKeyArn": "string",
"kmsEncryptionContext": "string"
},
"accessControl": {
"cannedAcl": enum
}
}
}
},
"msSmoothGroupSettings": {
"destination": "string",
"destinationSettings": {
"s3Settings": {
"encryption": {
"encryptionType": enum,
"kmsKeyArn": "string",
"kmsEncryptionContext": "string"
},
"accessControl": {
"cannedAcl": enum
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"fragmentLength": integer,
"fragmentLengthControl": enum,
"encryption": {
"spekeKeyProvider": {
"resourceId": "string",
"systemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
}
},
"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
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"encryption": {
"encryptionMethod": enum,
"constantInitializationVector": "string",
"initializationVectorInManifest": enum,
"spekeKeyProvider": {
"resourceId": "string",
"hlsSignaledSystemIds": [
"string"
],
"dashSignaledSystemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
},
"staticKeyProvider": {
"staticKeyValue": "string",
"keyFormat": "string",
"keyFormatVersions": "string",
"url": "string"
},
"type": enum
},
"minBufferTime": integer,
"fragmentLength": integer,
"baseUrl": "string",
"segmentControl": enum,
"ptsOffsetHandlingForBFrames": enum,
"mpdProfile": enum,
"writeSegmentTimelineInRepresentation": enum,
"manifestDurationFormat": enum,
"streamInfResolution": enum,
"clientCache": enum,
"manifestCompression": enum,
"codecSpecification": enum,
"imageBasedTrickPlay": enum,
"imageBasedTrickPlaySettings": {
"thumbnailHeight": integer,
"thumbnailWidth": integer,
"tileHeight": integer,
"tileWidth": integer,
"intervalCadence": enum,
"thumbnailInterval": number
}
}
},
"automatedEncodingSettings": {
"abrSettings": {
"maxRenditions": integer,
"maxAbrBitrate": integer,
"minAbrBitrate": integer
}
}
}
],
"adAvailOffset": integer,
"availBlanking": {
"availBlankingImage": "string"
},
"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
},
"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,
"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
}
]
},
"dolbyVisionMetadataXml": "string",
"crop": {
"height": integer,
"width": integer,
"x": integer,
"y": integer
},
"position": {
"height": integer,
"width": integer,
"x": integer,
"y": integer
}
}
]
},
"accelerationSettings": {
"mode": enum
},
"statusUpdateInterval": enum,
"priority": integer,
"hopDestinations": [
{
"waitMinutes": integer,
"queue": "string",
"priority": integer
}
]
}
],
"nextToken": "string"
}
{
"jobTemplate": {
"arn": "string",
"createdAt": "string",
"lastUpdated": "string",
"description": "string",
"category": "string",
"queue": "string",
"name": "string",
"type": enum,
"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,
"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
},
"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,
"klvMetadata": enum
},
"cmfcSettings": {
"scte35Source": enum,
"scte35Esam": enum,
"audioDuration": enum,
"iFrameOnlyManifest": enum,
"audioGroupId": "string",
"audioRenditionSets": "string",
"audioTrackType": enum,
"descriptiveVideoServiceFlag": enum,
"timedMetadata": 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,
"contrast": integer,
"hue": integer,
"saturation": integer,
"hdr10Metadata": {
"redPrimaryX": integer,
"redPrimaryY": integer,
"greenPrimaryX": integer,
"greenPrimaryY": integer,
"bluePrimaryX": integer,
"bluePrimaryY": integer,
"whitePointX": integer,
"whitePointY": integer,
"maxFrameAverageLightLevel": integer,
"maxContentLightLevel": integer,
"maxLuminance": integer,
"minLuminance": integer
}
},
"deinterlacer": {
"algorithm": enum,
"mode": enum,
"control": enum
},
"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
}
]
},
"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
},
"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,
"codecLevel": enum,
"fieldEncoding": enum,
"sceneChangeDetect": enum,
"qualityTuningLevel": enum,
"framerateConversionAlgorithm": enum,
"unregisteredSeiTimecode": enum,
"gopSizeUnits": enum,
"parControl": enum,
"numberBFramesBetweenReferenceFrames": integer,
"repeatPps": enum,
"dynamicSubGop": enum
},
"h265Settings": {
"interlaceMode": enum,
"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
},
"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
},
"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
},
"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
},
"audioChannelTaggingSettings": {
"channelTag": 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
},
"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
},
"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,
"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,
"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
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"encryption": {
"encryptionMethod": enum,
"constantInitializationVector": "string",
"initializationVectorInManifest": enum,
"offlineEncrypted": enum,
"spekeKeyProvider": {
"resourceId": "string",
"systemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
},
"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,
"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
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"encryption": {
"playbackDeviceCompatibility": enum,
"spekeKeyProvider": {
"resourceId": "string",
"systemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
}
},
"minBufferTime": integer,
"fragmentLength": integer,
"baseUrl": "string",
"segmentControl": enum,
"ptsOffsetHandlingForBFrames": enum,
"mpdProfile": enum,
"hbbtvCompliance": enum,
"writeSegmentTimelineInRepresentation": enum,
"imageBasedTrickPlay": enum,
"imageBasedTrickPlaySettings": {
"thumbnailHeight": integer,
"thumbnailWidth": integer,
"tileHeight": integer,
"tileWidth": integer,
"intervalCadence": enum,
"thumbnailInterval": number
}
},
"fileGroupSettings": {
"destination": "string",
"destinationSettings": {
"s3Settings": {
"encryption": {
"encryptionType": enum,
"kmsKeyArn": "string",
"kmsEncryptionContext": "string"
},
"accessControl": {
"cannedAcl": enum
}
}
}
},
"msSmoothGroupSettings": {
"destination": "string",
"destinationSettings": {
"s3Settings": {
"encryption": {
"encryptionType": enum,
"kmsKeyArn": "string",
"kmsEncryptionContext": "string"
},
"accessControl": {
"cannedAcl": enum
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"fragmentLength": integer,
"fragmentLengthControl": enum,
"encryption": {
"spekeKeyProvider": {
"resourceId": "string",
"systemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
}
},
"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
}
}
},
"additionalManifests": [
{
"manifestNameModifier": "string",
"selectedOutputs": [
"string"
]
}
],
"encryption": {
"encryptionMethod": enum,
"constantInitializationVector": "string",
"initializationVectorInManifest": enum,
"spekeKeyProvider": {
"resourceId": "string",
"hlsSignaledSystemIds": [
"string"
],
"dashSignaledSystemIds": [
"string"
],
"url": "string",
"certificateArn": "string"
},
"staticKeyProvider": {
"staticKeyValue": "string",
"keyFormat": "string",
"keyFormatVersions": "string",
"url": "string"
},
"type": enum
},
"minBufferTime": integer,
"fragmentLength": integer,
"baseUrl": "string",
"segmentControl": enum,
"ptsOffsetHandlingForBFrames": enum,
"mpdProfile": enum,
"writeSegmentTimelineInRepresentation": enum,
"manifestDurationFormat": enum,
"streamInfResolution": enum,
"clientCache": enum,
"manifestCompression": enum,
"codecSpecification": enum,
"imageBasedTrickPlay": enum,
"imageBasedTrickPlaySettings": {
"thumbnailHeight": integer,
"thumbnailWidth": integer,
"tileHeight": integer,
"tileWidth": integer,
"intervalCadence": enum,
"thumbnailInterval": number
}
}
},
"automatedEncodingSettings": {
"abrSettings": {
"maxRenditions": integer,
"maxAbrBitrate": integer,
"minAbrBitrate": integer
}
}
}
],
"adAvailOffset": integer,
"availBlanking": {
"availBlankingImage": "string"
},
"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
},
"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,
"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
}
]
},
"dolbyVisionMetadataXml": "string",
"crop": {
"height": integer,
"width": integer,
"x": integer,
"y": integer
},
"position": {
"height": integer,
"width": integer,
"x": integer,
"y": integer
}
}
]
},
"accelerationSettings": {
"mode": enum
},
"statusUpdateInterval": enum,
"priority": integer,
"hopDestinations": [
{
"waitMinutes": integer,
"queue": "string",
"priority": integer
}
]
}
}
Properties
AacAudioDescriptionBroadcasterMix
Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType.
BROADCASTER_MIXED_AD
NORMAL
AacCodecProfile
AAC Profile.
AacCodingMode
Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. "1.0 - Audio Description (Receiver Mix)" setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
AD_RECEIVER_MIX
CODING_MODE_1_0
CODING_MODE_1_1
CODING_MODE_2_0
CODING_MODE_5_1
AacRateControlMode
Rate Control Mode.
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.
AacSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode (rateControlMode) to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the rate control mode.
| Property | Type | Required | Description |
|---|
audioDescriptionBroadcasterMix | AacAudioDescriptionBroadcasterMix | False | Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType. |
bitrate | integer Minimum: 6000 Maximum: 1024000 | False | Specify the average bitrate in bits per second. The set of valid values for this setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000. The value you set is also constrained by the values that you choose for Profile (codecProfile), Bitrate control mode (codingMode), and Sample rate (sampleRate). Default values depend on Bitrate control mode and Profile. |
codecProfile | AacCodecProfile | False | AAC Profile. |
codingMode | AacCodingMode | False | Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. "1.0 - Audio Description (Receiver Mix)" setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. |
rateControlMode | AacRateControlMode | False | Rate Control Mode. |
rawFormat | AacRawFormat | False | Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose "No container" for the output container. |
sampleRate | integer Minimum: 8000 Maximum: 96000 | False | Sample rate in Hz. Valid values depend on rate control mode and profile. |
specification | AacSpecification | False | Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. |
vbrQuality | AacVbrQuality | False | VBR Quality Level - Only used if rate_control_mode is VBR. |
AacSpecification
Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
AacVbrQuality
VBR Quality Level - Only used if rate_control_mode is VBR.
LOW
MEDIUM_LOW
MEDIUM_HIGH
HIGH
Ac3BitstreamMode
Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).
COMPLETE_MAIN
COMMENTARY
DIALOGUE
EMERGENCY
HEARING_IMPAIRED
MUSIC_AND_EFFECTS
VISUALLY_IMPAIRED
VOICE_OVER
Ac3CodingMode
Dolby Digital coding mode. Determines number of channels.
CODING_MODE_1_0
CODING_MODE_1_1
CODING_MODE_2_0
CODING_MODE_3_2_LFE
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 (DynamicRangeCompressionProfile). 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 (DynamicRangeCompressionProfile). The mode-specific settings are Dynamic range compression profile, line mode (dynamicRangeCompressionLine) and Dynamic range compression profile, RF mode (dynamicRangeCompressionRf). 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 (NONE) to leave out DRC signaling. Keep the default Film standard (FILM_STANDARD) to set the profile to Dolby's film standard profile for all operating modes.
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 (DynamicRangeCompressionProfile). 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.
When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
FOLLOW_INPUT
USE_CONFIGURED
Ac3Settings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3.
| Property | Type | Required | Description |
|---|
bitrate | integer Minimum: 64000 Maximum: 640000 | False | Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode. |
bitstreamMode | Ac3BitstreamMode | False | Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E). |
codingMode | Ac3CodingMode | False | Dolby Digital coding mode. Determines number of channels. |
dialnorm | integer Minimum: 1 Maximum: 31 | False | Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through. |
dynamicRangeCompressionLine | Ac3DynamicRangeCompressionLine | 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 (DynamicRangeCompressionProfile). 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 | Ac3DynamicRangeCompressionProfile | 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 (DynamicRangeCompressionProfile). The mode-specific settings are Dynamic range compression profile, line mode (dynamicRangeCompressionLine) and Dynamic range compression profile, RF mode (dynamicRangeCompressionRf). 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 (NONE) to leave out DRC signaling. Keep the default Film standard (FILM_STANDARD) to set the profile to Dolby's film standard profile for all operating modes. |
dynamicRangeCompressionRf | Ac3DynamicRangeCompressionRf | 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 (DynamicRangeCompressionProfile). 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 | Ac3LfeFilter | False | Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode. |
metadataControl | Ac3MetadataControl | False | When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. |
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.
AccelerationSettings
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
| Property | Type | Required | Description |
|---|
mode | AccelerationMode | True | Specify the conditions when the service will run your job with accelerated transcoding. |
AfdSignaling
This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.
AiffSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF.
| Property | Type | Required | Description |
|---|
bitDepth | integer Minimum: 16 Maximum: 24 | False | Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track. |
channels | integer Minimum: 1 Maximum: 64 | False | Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64. |
sampleRate | integer Minimum: 8000 Maximum: 192000 | False | Sample rate in hz. |
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.
AncillaryConvert608To708
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (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.
AncillarySourceSettings
Settings for ancillary captions source.
| Property | Type | Required | Description |
|---|
convert608To708 | AncillaryConvert608To708 | False | Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (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 | AncillaryTerminateCaptions | 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.
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.
AudioChannelTag
You can add a tag for this mono-channel audio track to mimic its placement in a multi-channel layout. For example, if this track is the left surround channel, choose Left surround (LS).
L
R
C
LFE
LS
RS
LC
RC
CS
LSD
RSD
TCS
VHL
VHC
VHR
AudioChannelTaggingSettings
When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually. For example, you would tag the tracks that contain your left, right, and center audio with Left (L), Right (R), and Center (C), respectively. 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; your audio codec must be AAC, WAV, or AIFF; and you must set up your audio track to have only one channel.
| Property | Type | Required | Description |
|---|
channelTag | AudioChannelTag | False | You can add a tag for this mono-channel audio track to mimic its placement in a multi-channel layout. For example, if this track is the left surround channel, choose Left surround (LS). |
AudioCodec
Choose the audio codec for this output. Note that the option Dolby Digital passthrough (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
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 | AacSettings | False | Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode (rateControlMode) to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the rate control mode. |
ac3Settings | Ac3Settings | False | Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3. |
aiffSettings | AiffSettings | False | Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF. |
codec | AudioCodec | False | Choose the audio codec for this output. Note that the option Dolby Digital passthrough (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 | Eac3AtmosSettings | False | Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3_ATMOS. |
eac3Settings | Eac3Settings | False | Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3. |
mp2Settings | Mp2Settings | False | Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2. |
mp3Settings | Mp3Settings | False | Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3. |
opusSettings | OpusSettings | False | Required when you set Codec, under AudioDescriptions>CodecSettings, to the value OPUS. |
vorbisSettings | VorbisSettings | False | Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis. |
wavSettings | WavSettings | False | Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) 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.
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 | AudioChannelTaggingSettings | False | When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually. For example, you would tag the tracks that contain your left, right, and center audio with Left (L), Right (R), and Center (C), respectively. 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; your audio codec must be AAC, WAV, or AIFF; and you must set up your audio track to have only one channel. |
audioNormalizationSettings | 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 | 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 | AudioCodecSettings | 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: ^[A-Za-z]{2,3}(-[A-Za-z-]+)?$ | 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 (AudioLanguageCodeControl) to Use configured (USE_CONFIGURED). The service also uses your specified custom language code when you set Language code control (AudioLanguageCodeControl) to Follow input (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 | 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 | AudioLanguageCodeControl | False | Specify which source for language code takes precedence for this audio track. When you choose Follow input (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 (languageCode or customLanguageCode). When you choose Use configured (USE_CONFIGURED), the service uses the language code that you specify. |
remixSettings | RemixSettings | False | Advanced audio remixing settings. |
streamName | string Pattern: ^[\w\s]*$ | False | Specify a label for this output audio stream. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting. |
AudioLanguageCodeControl
Specify which source for language code takes precedence for this audio track. When you choose Follow input (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 (languageCode or customLanguageCode). When you choose Use configured (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.
AudioNormalizationPeakCalculation
If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.
AudioNormalizationSettings
Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.
| Property | Type | Required | Description |
|---|
algorithm | AudioNormalizationAlgorithm | False | Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1. |
algorithmControl | AudioNormalizationAlgorithmControl | False | When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted. |
correctionGateLevel | integer Minimum: -70 Maximum: 0 | False | Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected. |
loudnessLogging | AudioNormalizationLoudnessLogging | False | If set to LOG, log each output's audio track loudness to a CSV file. |
peakCalculation | AudioNormalizationPeakCalculation | 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 (AudioNormalizationSettings), optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS. |
AudioSelector
Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use multiple Audio selectors per input.
| Property | Type | Required | Description |
|---|
customLanguageCode | string Pattern: ^[A-Za-z]{3}$ 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 | AudioDefaultSelection | 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: ^((s3://([^\/]+\/+)+([^\/\.]+|(([^\/]*)\.([mM]2[pP]|[wW][eE][bB][mM]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]|[aA][tT][mM][oO][sS]|[oO][gG][gGaA]))))|(https?://([^\/]+\/+)+([^\/\.]+|(([^\/]*)\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]|[aA][tT][mM][oO][sS]|[oO][gG][gGaA])))(\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$ | False | Specifies audio data from an external file source. |
hlsRenditionGroupSettings | 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 | 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 you are sending a JSON file, provide the program ID, which is part of the audio metadata. 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 | 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 | AudioSelectorType | 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 examle, type "1,2,3" to include tracks 1 through 3. Specifying directly in your JSON job file, provide the track numbers in an array. For example, "tracks": [1,2,3]. |
AudioSelectorGroup
Use audio selector groups to combine multiple sidecar audio inputs so that you can assign them to a single output audio tab (AudioDescription). 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
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 | Optional. The maximum target bit rate used in your automated ABR stack. Use this value to set an upper limit on the bandwidth consumed by the highest-quality rendition. This is the rendition that is delivered to viewers with the fastest internet connections. If you don't specify a value, MediaConvert uses 8,000,000 (8 mb/s) by default. |
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 | Optional. The minimum target bitrate used in your automated ABR stack. Use this value to set a lower limit on the bitrate of video delivered to viewers with slow internet connections. If you don't specify a value, MediaConvert uses 600,000 (600 kb/s) by default. |
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 | AutomatedAbrSettings | 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 (spatialAdaptiveQuantization).
OFF
LOW
MEDIUM
HIGH
HIGHER
MAX
Av1BitDepth
Specify the Bit depth (Av1BitDepth). You can choose 8-bit (BIT_8) or 10-bit (BIT_10).
Av1FramerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.
INITIALIZE_FROM_SOURCE
SPECIFIED
Av1FramerateConversionAlgorithm
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. 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, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.
DUPLICATE_DROP
INTERPOLATE
FRAMEFORMER
Av1QvbrSettings
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).
| Property | Type | Required | Description |
|---|
qvbrQualityLevel | integer Minimum: 1 Maximum: 10 | False | Use this setting only when you set Rate control mode (RateControlMode) 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.'
Av1Settings
Required when you set Codec, under VideoDescription>CodecSettings to the value AV1.
| Property | Type | Required | Description |
|---|
adaptiveQuantization | Av1AdaptiveQuantization | False | Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to Spatial adaptive quantization (spatialAdaptiveQuantization). |
bitDepth | Av1BitDepth | False | Specify the Bit depth (Av1BitDepth). You can choose 8-bit (BIT_8) or 10-bit (BIT_10). |
framerateControl | Av1FramerateControl | False | If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator. |
framerateConversionAlgorithm | Av1FramerateConversionAlgorithm | False | Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. 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, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. |
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 | Av1QvbrSettings | 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). |
rateControlMode | Av1RateControlMode | 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 | Av1SpatialAdaptiveQuantization | False | Keep the default value, Enabled (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 (adaptiveQuantization) 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 (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 (adaptiveQuantization) 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.
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: ^((s3://(.*?)\.(bmp|BMP|png|PNG))|(https?://(.*?)\.(bmp|BMP|png|PNG)(\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$ 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. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.
INITIALIZE_FROM_SOURCE
SPECIFIED
AvcIntraFramerateConversionAlgorithm
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. 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, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.
DUPLICATE_DROP
INTERPOLATE
FRAMEFORMER
AvcIntraInterlaceMode
Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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 (INTERLACED_OPTIMIZE) 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 (INTERLACED), 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 (telecine) to None (NONE) or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode (interlaceMode) to a value other than Progressive (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 | 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 | AvcIntraUhdSettings | False | Optional when you set AVC-Intra class (avcIntraClass) to Class 4K/2K (CLASS_4K_2K). When you set AVC-Intra class to a different value, this object isn't allowed. |
framerateControl | AvcIntraFramerateControl | False | If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator. |
framerateConversionAlgorithm | AvcIntraFramerateConversionAlgorithm | False | Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. 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, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. |
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 | AvcIntraInterlaceMode | False | Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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 | AvcIntraScanTypeConversionMode | 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 (INTERLACED_OPTIMIZE) 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 (INTERLACED), 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 (telecine) to None (NONE) or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode (interlaceMode) to a value other than Progressive (PROGRESSIVE). |
slowPal | AvcIntraSlowPal | 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. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. |
telecine | AvcIntraTelecine | 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 (HARD) to create a smoother picture. When you keep the default value, None (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. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.
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 (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.
AvcIntraUhdQualityTuningLevel
Optional. Use Quality tuning level (qualityTuningLevel) to choose how many transcoding passes MediaConvert does with your video. When you choose Multi-pass (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 (SINGLE_PASS), your encoding time is faster. The default behavior is Single-pass (SINGLE_PASS).
AvcIntraUhdSettings
Optional when you set AVC-Intra class (avcIntraClass) to Class 4K/2K (CLASS_4K_2K). When you set AVC-Intra class to a different value, this object isn't allowed.
| Property | Type | Required | Description |
|---|
qualityTuningLevel | AvcIntraUhdQualityTuningLevel | False | Optional. Use Quality tuning level (qualityTuningLevel) to choose how many transcoding passes MediaConvert does with your video. When you choose Multi-pass (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 (SINGLE_PASS), your encoding time is faster. The default behavior is Single-pass (SINGLE_PASS). |
BurnInSubtitleStylePassthrough
Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: 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.
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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.
| Property | Type | Required | Description |
|---|
alignment | BurninSubtitleAlignment | 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 | BurninSubtitleApplyFontColor | False | Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (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 | BurninSubtitleBackgroundColor | False | Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) 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 (StylePassthrough) 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 | BurninSubtitleFallbackFont | 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 (FallbackFont) to best match (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 | BurninSubtitleFontColor | False | Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present. |
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 (FontResolution) in DPI (dots per inch). |
fontScript | FontScript | False | Set Font script (FontScript) to Automatically determined (AUTOMATIC), 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 (FontSize) in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size. |
hexFontColor | string Pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ 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 | BurninSubtitleOutlineColor | False | Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) 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 (OutlineSize) of the caption text, in pixels. Leave Outline size blank and set Style passthrough (StylePassthrough) to enabled to use the outline size data from your input captions, if present. |
shadowColor | BurninSubtitleShadowColor | False | Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) 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 (StylePassthrough) is set to Enabled, leave Shadow opacity (ShadowOpacity) 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 (ShadowYOffset) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow y-offset data from your input captions, if present. |
stylePassthrough | BurnInSubtitleStylePassthrough | False | Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: 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. |
teletextSpacing | BurninSubtitleTeletextSpacing | False | Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. |
xPosition | integer Minimum: 0 Maximum: 2147483647 | False | Specify the horizontal position (XPosition) 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 (YPosition) 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.
BurninSubtitleApplyFontColor
Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (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.
BurninSubtitleBackgroundColor
Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.
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 (FallbackFont) to best match (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 (FontColor) blank and set Style passthrough (StylePassthrough) 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 (OutlineColor) blank and set Style passthrough (StylePassthrough) 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 (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present.
BurninSubtitleTeletextSpacing
Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (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: ^[A-Za-z]{2,3}(-[A-Za-z-]+)?$ | 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 | CaptionDestinationSettings | False | Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the 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 | 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. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the 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 | 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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN. |
destinationType | CaptionDestinationType | 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 (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20). |
dvbSubDestinationSettings | 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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB. |
embeddedDestinationSettings | 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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED. |
imscDestinationSettings | 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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC. |
sccDestinationSettings | 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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC. |
srtDestinationSettings | 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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT. |
teletextDestinationSettings | 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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TELETEXT. |
ttmlDestinationSettings | 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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML. |
webvttDestinationSettings | 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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT. |
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 (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).
BURN_IN
DVB_SUB
EMBEDDED
EMBEDDED_PLUS_SCTE20
IMSC
SCTE20_PLUS_EMBEDDED
SCC
SRT
SMI
TELETEXT
TTML
WEBVTT
CaptionSelector
Use captions selectors to specify the captions data from your input that you use in your outputs. You can use up to 20 captions selectors per input.
| Property | Type | Required | Description |
|---|
customLanguageCode | string Pattern: ^[A-Za-z]{3}$ 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 or SMPTE-TT, 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 | 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 or SMPTE-TT, 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 | CaptionSourceSettings | 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. |
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. When you work directly in your JSON job specification, use the settings framerateNumerator and framerateDenominator. 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 (CaptionSourceFramerate). Use this setting along with the setting Framerate numerator (framerateNumerator). |
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 (CaptionSourceFramerate). Use this setting along with the setting Framerate denominator (framerateDenominator). |
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 | AncillarySourceSettings | False | Settings for ancillary captions source. |
dvbSubSourceSettings | DvbSubSourceSettings | False | DVB Sub Source Settings |
embeddedSourceSettings | EmbeddedSourceSettings | False | Settings for embedded captions Source |
fileSourceSettings | 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 | CaptionSourceType | False | Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format. |
teletextSourceSettings | TeletextSourceSettings | False | Settings specific to Teletext caption sources, including Page number. |
trackSourceSettings | 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 | 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 (SourceType) 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 (ChannelMapping) 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. |
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 (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header.
CmafCodecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
CmafEncryptionSettings
Settings for CMAF encryption
| Property | Type | Required | Description |
|---|
constantInitializationVector | string Pattern: ^[0-9a-fA-F]{32}$ 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 | CmafEncryptionType | False | Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR). |
initializationVectorInManifest | CmafInitializationVectorInManifest | 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 | SpekeKeyProviderCmaf | 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 | StaticKeyProvider | False | Use these settings to set up encryption with a static key provider. |
type | CmafKeyProviderType | 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 (SAMPLE-AES) or AES_CTR (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. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to CMAF_GROUP_SETTINGS.
| 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 | CmafClientCache | False | Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header. |
codecSpecification | CmafCodecSpecification | False | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. |
destination | string Pattern: ^s3:\/\/ | False | Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. |
destinationSettings | DestinationSettings | False | Settings associated with the destination. Will vary based on the type of destination |
encryption | CmafEncryptionSettings | 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 (FragmentLengthControl) to specify whether the encoder enforces this value strictly. |
imageBasedTrickPlay | CmafImageBasedTrickPlay | False | Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest (WriteHlsManifest), 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 (WriteDashManifest), 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 | CmafImageBasedTrickPlaySettings | False | Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED |
manifestCompression | CmafManifestCompression | False | When set to GZIP, compresses HLS playlist. |
manifestDurationFormat | CmafManifestDurationFormat | 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. |
mpdProfile | CmafMpdProfile | False | Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), 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 (SegmentControl) to Single file (SINGLE_FILE). |
ptsOffsetHandlingForBFrames | CmafPtsOffsetHandlingForBFrames | 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 (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (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 | CmafSegmentControl | 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 (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (CmafSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries. |
segmentLengthControl | CmafSegmentLengthControl | False | Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary. |
streamInfResolution | CmafStreamInfResolution | False | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. |
targetDurationCompatibilityMode | CmafTargetDurationCompatibilityMode | 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. |
writeDashManifest | CmafWriteDASHManifest | False | When set to ENABLED, a DASH MPD manifest will be generated for this output. |
writeHlsManifest | CmafWriteHLSManifest | False | When set to ENABLED, an Apple HLS manifest will be generated for this output. |
writeSegmentTimelineInRepresentation | CmafWriteSegmentTimelineInRepresentation | False | When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), 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 (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest (WriteHlsManifest), 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 (WriteDashManifest), 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 | CmafIntervalCadence | 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.
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.
CmafManifestCompression
When set to GZIP, compresses HLS playlist.
Indicates whether the output manifest should use floating point values for segment duration.
CmafMpdProfile
Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), 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 (SegmentControl) to Single file (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 (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (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 (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.
CmafStreamInfResolution
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
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.
CmafWriteDASHManifest
When set to ENABLED, a DASH MPD manifest will be generated for this output.
CmafWriteHLSManifest
When set to ENABLED, an Apple HLS manifest will be generated for this output.
CmafWriteSegmentTimelineInRepresentation
When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), 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.
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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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. 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 (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 (ALTERNATE_AUDIO_AUTO_SELECT) 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
CmfcDescriptiveVideoServiceFlag
Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (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 (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.
CmfcIFrameOnlyManifest
Choose Include (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 (EXCLUDE).
Applies to CMAF outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.
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 (sccXml).
CmfcScte35Source
Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.
CmfcSettings
These settings relate to the fragmented MP4 container for the segments in your CMAF outputs.
| Property | Type | Required | Description |
|---|
audioDuration | CmfcAudioDuration | 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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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). |
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 (AudioGroupId) 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 | CmfcAudioTrackType | 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. 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 (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 (ALTERNATE_AUDIO_AUTO_SELECT) 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 | CmfcDescriptiveVideoServiceFlag | False | Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (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 (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation. |
iFrameOnlyManifest | CmfcIFrameOnlyManifest | False | Choose Include (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 (EXCLUDE). |
klvMetadata | CmfcKlvMetadata | False | Applies to CMAF outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output. |
scte35Esam | CmfcScte35Esam | 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 (sccXml). |
scte35Source | CmfcScte35Source | False | Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output. |
timedMetadata | CmfcTimedMetadata | False | To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank. |
To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.
ColorCorrector
Settings for color correction.
| Property | Type | Required | Description |
|---|
brightness | integer Minimum: 1 Maximum: 100 | False | Brightness level. |
colorSpaceConversion | ColorSpaceConversion | False | Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, 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 Elemental tone mapping technology to approximate the outcome of manually regrading from HDR to SDR. |
contrast | integer Minimum: 1 Maximum: 100 | False | Contrast level. |
hdr10Metadata | Hdr10Metadata | False | Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr. |
hue | integer Minimum: -180 Maximum: 180 | False | Hue in degrees. |
sampleRangeConversion | SampleRangeConversion | False | Specify the video color sample range for this output. To create a full range output, you must start with a full range YUV input and keep the default value, None (NONE). To create a limited range output from a full range input, choose Limited range (LIMITED_RANGE_SQUEEZE). With RGB inputs, your output is always limited range, regardless of your choice here. When you create a limited range output from a full range input, MediaConvert limits the active pixel values in a way that depends on the output's bit depth: 8-bit outputs contain only values from 16 through 235 and 10-bit outputs contain only values from 64 through 940. With this conversion, MediaConvert also changes the output metadata to note the limited range. |
saturation | integer Minimum: 1 Maximum: 100 | False | Saturation level. |
Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
ColorSpace
If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, 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 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.
FOLLOW
REC_601
REC_709
HDR10
HLG_2020
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 Elemental tone mapping technology to approximate the outcome of manually regrading from HDR to SDR.
NONE
FORCE_601
FORCE_709
FORCE_HDR10
FORCE_HLG_2020
ColorSpaceUsage
There are two sources for color metadata, the input file and the job input settings Color space (ColorSpace) and HDR master display information settings(Hdr10Metadata). The Color space usage setting determines which takes precedence. Choose Force (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 (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.
ContainerSettings
Container specific settings.
| Property | Type | Required | Description |
|---|
cmfcSettings | CmfcSettings | False | These settings relate to the fragmented MP4 container for the segments in your CMAF outputs. |
container | ContainerType | False | Container for this output. Some containers require a container settings object. If not specified, the default object will be created. |
f4vSettings | F4vSettings | False | Settings for F4v container |
m2tsSettings | M2tsSettings | False | MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset. |
m3u8Settings | M3u8Settings | False | These settings relate to the MPEG-2 transport stream (MPEG2-TS) container for the MPEG2-TS segments in your HLS outputs. |
movSettings | MovSettings | False | These settings relate to your QuickTime MOV output container. |
mp4Settings | 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 | MpdSettings | False | These settings relate to the fragmented MP4 container for the segments in your DASH outputs. |
mxfSettings | 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
WEBM
RAW
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.
CreateJobTemplateRequest
Send your create job template request with the name of the template and the JSON for the template. The template JSON should include everything in a valid job, except for input location and filename, IAM role, and user metadata.
| Property | Type | Required | Description |
|---|
accelerationSettings | AccelerationSettings | False | 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. |
category | string | False | Optional. A category for the job template you are creating |
description | string | False | Optional. A description of the job template you are creating. |
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. |
name | string | True | The name of the job template you are creating. |
priority | integer Format: int32 Minimum: -50 Maximum: 50 | False | 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. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue. |
settings | JobTemplateSettings | True | JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it. |
statusUpdateInterval | StatusUpdateInterval | False | 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 | The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. |
CreateJobTemplateResponse
Successful create job template requests will return the template JSON.
| Property | Type | Required | Description |
|---|
jobTemplate | JobTemplate | False | A job template is a pre-made set of encoding instructions that you can use to quickly create a job. |
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 | DashIsoPlaybackDeviceCompatibility | 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 (UNENCRYPTED_SEI) only to correct problems with playback on older devices. Otherwise, keep the default setting CENC v1 (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 | 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 (MPEG_CHANNEL_CONFIGURATION), to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby channel configuration (DOLBY_CHANNEL_CONFIGURATION) to have MediaConvert write this instead: tag:dolby.com,2014:dash:audio_channel_configuration:2011.
DashIsoGroupSettings
Settings related to your DASH output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to DASH_ISO_GROUP_SETTINGS.
| 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 | DashIsoGroupAudioChannelConfigSchemeIdUri | 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 (MPEG_CHANNEL_CONFIGURATION), to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby channel configuration (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. |
destination | string Pattern: ^s3:\/\/ | False | Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. |
destinationSettings | DestinationSettings | False | Settings associated with the destination. Will vary based on the type of destination |
encryption | DashIsoEncryptionSettings | 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 | DashIsoHbbtvCompliance | False | Supports HbbTV specification as indicated |
imageBasedTrickPlay | DashIsoImageBasedTrickPlay | False | Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) 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 | DashIsoImageBasedTrickPlaySettings | 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. |
mpdProfile | DashIsoMpdProfile | False | Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), 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 (SegmentControl) to Single file (SINGLE_FILE). |
ptsOffsetHandlingForBFrames | DashIsoPtsOffsetHandlingForBFrames | 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 (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (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 | DashIsoSegmentControl | 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 (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (DashIsoSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries. |
segmentLengthControl | DashIsoSegmentLengthControl | False | Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary. |
writeSegmentTimelineInRepresentation | DashIsoWriteSegmentTimelineInRepresentation | 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
DashIsoImageBasedTrickPlay
Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) 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 | DashIsoIntervalCadence | 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
DashIsoMpdProfile
Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), 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 (SegmentControl) to Single file (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 (UNENCRYPTED_SEI) only to correct problems with playback on older devices. Otherwise, keep the default setting CENC v1 (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.
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 (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (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 (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.
DashIsoWriteSegmentTimelineInRepresentation
When you enable Precise segment duration in manifests (writeSegmentTimelineInRepresentation), 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.
DeinterlaceAlgorithm
Only applies when you set Deinterlacer (DeinterlaceMode) to Deinterlace (DEINTERLACE) or Adaptive (ADAPTIVE). Motion adaptive interpolate (INTERPOLATE) produces sharper pictures, while blend (BLEND) produces smoother motion. Use (INTERPOLATE_TICKER) OR (BLEND_TICKER) if your source file includes a ticker, such as a scrolling headline at the bottom of the frame.
INTERPOLATE
INTERPOLATE_TICKER
BLEND
BLEND_TICKER
Deinterlacer
Settings for deinterlacer
| Property | Type | Required | Description |
|---|
algorithm | DeinterlaceAlgorithm | False | Only applies when you set Deinterlacer (DeinterlaceMode) to Deinterlace (DEINTERLACE) or Adaptive (ADAPTIVE). Motion adaptive interpolate (INTERPOLATE) produces sharper pictures, while blend (BLEND) produces smoother motion. Use (INTERPOLATE_TICKER) OR (BLEND_TICKER) if your source file includes a ticker, such as a scrolling headline at the bottom of the frame. |
control | DeinterlacerControl | False | - When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video. |
mode | DeinterlacerMode | False | Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive. |
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.
DeinterlacerMode
Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive.
DEINTERLACE
INVERSE_TELECINE
ADAPTIVE
DestinationSettings
Settings associated with the destination. Will vary based on the type of destination
| Property | Type | Required | Description |
|---|
s3Settings | S3DestinationSettings | False | Settings associated with S3 destination |
DolbyVision
With AWS Elemental MediaConvert, you can create profile 5 Dolby Vision outputs from MXF and IMF sources that contain mastering information as frame-interleaved Dolby Vision metadata.
| Property | Type | Required | Description |
|---|
l6Metadata | DolbyVisionLevel6Metadata | False | Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the MaxCLL and MaxFALL values in your input with new values. |
l6Mode | DolbyVisionLevel6Mode | False | Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL and MaxFALL properies. |
mapping | DolbyVisionMapping | False | Required when you set Dolby Vision Profile (Profile) to Profile 8.1 (PROFILE_8_1). When you set Content mapping (Mapping) to None (HDR10_NOMAP), 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 Static (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 | DolbyVisionProfile | False | Required when you use Dolby Vision (DolbyVision) processing. Set Profile (DolbyVisionProfile) to Profile 5 (Profile_5) to only include frame-interleaved Dolby Vision metadata in your output. Set Profile to Profile 8.1 (Profile_8_1) to include both frame-interleaved Dolby Vision metadata and HDR10 metadata in your output. |
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 (Profile) to Profile 8.1 (PROFILE_8_1). When you set Content mapping (Mapping) to None (HDR10_NOMAP), 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 Static (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.
DolbyVisionProfile
Required when you use Dolby Vision (DolbyVision) processing. Set Profile (DolbyVisionProfile) to Profile 5 (Profile_5) to only include frame-interleaved Dolby Vision metadata in your output. Set Profile to Profile 8.1 (Profile_8_1) to include both frame-interleaved Dolby Vision metadata and HDR10 metadata in your output.
DropFrameTimecode
Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.
DvbNitSettings
Use these settings to insert a DVB Network Information Table (NIT) in the transport stream of this output. When you work directly in your JSON job specification, include this object only when your job has a transport stream output and the container settings contain the object M2tsSettings.
| 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. When you work directly in your JSON job specification, include this object only when your job has a transport stream output and the container settings contain the object M2tsSettings.
| Property | Type | Required | Description |
|---|
outputSdt | OutputSdt | False | Selects method of inserting SDT information into output stream. "Follow input SDT" copies SDT information from input stream to output stream. "Follow input SDT if present" copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. Enter "SDT Manually" means user will enter the SDT information. "No SDT" means output stream will not contain SDT information. |
sdtInterval | integer Minimum: 25 Maximum: 2000 | False | The number of milliseconds between instances of this table in the output transport stream. |
serviceName | string MinLength: 1 MaxLength: 256 | False | The service name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters. |
serviceProviderName | string MinLength: 1 MaxLength: 256 | False | The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters. |
DvbSubDestinationSettings
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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB.
| Property | Type | Required | Description |
|---|
alignment | DvbSubtitleAlignment | 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 | DvbSubtitleApplyFontColor | False | Ignore this setting unless Style Passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (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 | DvbSubtitleBackgroundColor | False | Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) 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 (StylePassthrough) 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 | DvbddsHandling | False | Specify how MediaConvert handles the display definition segment (DDS). Keep the default, None (NONE), to exclude the DDS from this set of captions. Choose No display window (NO_DISPLAY_WINDOW) to have MediaConvert include the DDS but not include display window data. In this case, MediaConvert writes that information to the page composition segment (PCS) instead. Choose Specify (SPECIFIED) to have MediaConvert set up the display window based on the values that you specify in related job settings. For video resolutions that are 576 pixels or smaller in height, MediaConvert doesn't include the DDS, regardless of the value you choose for DDS handling (ddsHandling). In this case, it doesn't write the display window data to the PCS either. Related settings: Use the settings DDS x-coordinate (ddsXCoordinate) and DDS y-coordinate (ddsYCoordinate) to specify the offset between the top left corner of the display window and the top left corner of the video frame. 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 (ddsYCoordinate), 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 (ddsHandling) to a value other than None (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. |
ddsYCoordinate | integer Minimum: 0 Maximum: 2147483647 | False | Use this setting, along with DDS x-coordinate (ddsXCoordinate), 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 (ddsHandling) to a value other than None (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 | DvbSubSubtitleFallbackFont | 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 (FallbackFont) to best match (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 | DvbSubtitleFontColor | False | Specify the color of the captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) 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. |
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 (FontResolution) in DPI (dots per inch).
Within your job settings, all of your DVB-Sub settings must be identical. |
fontScript | FontScript | False | Set Font script (FontScript) to Automatically determined (AUTOMATIC), 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 (FontSize) 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 (ddsHandling) to a value other than None (NONE). All burn-in and DVB-Sub font settings must match. |
hexFontColor | string Pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ 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 | DvbSubtitleOutlineColor | False | Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) 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 (OutlineSize) of the caption text, in pixels. Leave Outline size blank and set Style passthrough (StylePassthrough) 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 | DvbSubtitleShadowColor | False | Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) 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 (StylePassthrough) is set to Enabled, leave Shadow opacity (ShadowOpacity) 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 (ShadowYOffset) blank and set Style passthrough (StylePassthrough) 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 | DvbSubtitleStylePassthrough | False | Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: 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. |
subtitlingType | DvbSubtitlingType | 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 | DvbSubtitleTeletextSpacing | False | Specify whether the Text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (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 (ddsHandling) to a value other than None (NONE). All burn-in and DVB-Sub font settings must match. |
xPosition | integer Minimum: 0 Maximum: 2147483647 | False | Specify the horizontal position (XPosition) of the captions, relative to the left side of the outputin pixels. A value of 10 would result in the captions starting 10 pixels from the left ofthe output. If no explicit x_position is provided, the horizontal caption position will bedetermined 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 (YPosition) 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 or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors. |
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 (FallbackFont) to best match (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.
DvbSubtitleApplyFontColor
Ignore this setting unless Style Passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (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.
DvbSubtitleBackgroundColor
Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.
DvbSubtitleFontColor
Specify the color of the captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) 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 (OutlineColor) blank and set Style passthrough (StylePassthrough) 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 (ShadowColor) blank and set Style passthrough (StylePassthrough) 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.
DvbSubtitleStylePassthrough
Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: 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.
DvbSubtitleTeletextSpacing
Specify whether the Text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (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.
DvbTdtSettings
Use these settings to insert a DVB Time and Date Table (TDT) in the transport stream of this output. When you work directly in your JSON job specification, include this object only when your job has a transport stream output and the container settings contain the object M2tsSettings.
| 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). Keep the default, None (NONE), to exclude the DDS from this set of captions. Choose No display window (NO_DISPLAY_WINDOW) to have MediaConvert include the DDS but not include display window data. In this case, MediaConvert writes that information to the page composition segment (PCS) instead. Choose Specify (SPECIFIED) to have MediaConvert set up the display window based on the values that you specify in related job settings. For video resolutions that are 576 pixels or smaller in height, MediaConvert doesn't include the DDS, regardless of the value you choose for DDS handling (ddsHandling). In this case, it doesn't write the display window data to the PCS either. Related settings: Use the settings DDS x-coordinate (ddsXCoordinate) and DDS y-coordinate (ddsYCoordinate) to specify the offset between the top left corner of the display window and the top left corner of the video frame. 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).
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.
Eac3AtmosDownmixControl
Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom (SPECIFIED) to provide downmix values in your job settings. Choose Follow source (INITIALIZE_FROM_SOURCE) to use the metadata from your input. Related settings--Use these settings to specify your downmix values: Left only/Right only surround (LoRoSurroundMixLevel), Left total/Right total surround (LtRtSurroundMixLevel), Left total/Right total center (LtRtCenterMixLevel), Left only/Right only center (LoRoCenterMixLevel), and Stereo downmix (StereoDownmix). When you keep Custom (SPECIFIED) for Downmix control (DownmixControl) 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 (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). Otherwise, MediaConvert ignores Dynamic range compression line (DynamicRangeCompressionLine). 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 (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). Otherwise, MediaConvert ignores Dynamic range compression RF (DynamicRangeCompressionRf). 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 (SPECIFIED), to provide dynamic range control values in your job settings. Choose Follow source (INITIALIZE_FROM_SOURCE) to use the metadata from your input. Related settings--Use these settings to specify your dynamic range control values: Dynamic range compression line (DynamicRangeCompressionLine) and Dynamic range compression RF (DynamicRangeCompressionRf). When you keep the value Custom (SPECIFIED) for Dynamic range control (DynamicRangeControl) 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) under (AudioDescriptions)>(CodecSettings) 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 | Eac3AtmosBitstreamMode | False | Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E). |
codingMode | Eac3AtmosCodingMode | False | The coding mode for Dolby Digital Plus JOC (Atmos). |
dialogueIntelligence | Eac3AtmosDialogueIntelligence | False | Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis. |
downmixControl | Eac3AtmosDownmixControl | False | Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom (SPECIFIED) to provide downmix values in your job settings. Choose Follow source (INITIALIZE_FROM_SOURCE) to use the metadata from your input. Related settings--Use these settings to specify your downmix values: Left only/Right only surround (LoRoSurroundMixLevel), Left total/Right total surround (LtRtSurroundMixLevel), Left total/Right total center (LtRtCenterMixLevel), Left only/Right only center (LoRoCenterMixLevel), and Stereo downmix (StereoDownmix). When you keep Custom (SPECIFIED) for Downmix control (DownmixControl) and you don't specify values for the related settings, MediaConvert uses default values for those settings. |
dynamicRangeCompressionLine | Eac3AtmosDynamicRangeCompressionLine | 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 (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). Otherwise, MediaConvert ignores Dynamic range compression line (DynamicRangeCompressionLine). 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 | Eac3AtmosDynamicRangeCompressionRf | 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 (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). Otherwise, MediaConvert ignores Dynamic range compression RF (DynamicRangeCompressionRf). 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 | Eac3AtmosDynamicRangeControl | False | Specify whether MediaConvert should use any dynamic range control metadata from your input file. Keep the default value, Custom (SPECIFIED), to provide dynamic range control values in your job settings. Choose Follow source (INITIALIZE_FROM_SOURCE) to use the metadata from your input. Related settings--Use these settings to specify your dynamic range control values: Dynamic range compression line (DynamicRangeCompressionLine) and Dynamic range compression RF (DynamicRangeCompressionRf). When you keep the value Custom (SPECIFIED) for Dynamic range control (DynamicRangeControl) 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 (ATMOS_STORAGE_DDP_MIXLEV_MINUS_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 (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores Left only/Right only center (LoRoCenterMixLevel). |
loRoSurroundMixLevel | number Format: float Minimum: -60.0 Maximum: -1.5 | False | Specify a value for the following Dolby Atmos setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. Default value: -3 dB (ATMOS_STORAGE_DDP_MIXLEV_MINUS_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 (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores Left only/Right only surround (LoRoSurroundMixLevel). |
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 (ATMOS_STORAGE_DDP_MIXLEV_MINUS_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 (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores Left total/Right total center (LtRtCenterMixLevel). |
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 (ATMOS_STORAGE_DDP_MIXLEV_MINUS_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 (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, the service ignores Left total/Right total surround (LtRtSurroundMixLevel). |
meteringMode | Eac3AtmosMeteringMode | 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 | Eac3AtmosStereoDownmix | False | Choose how the service does stereo downmixing. Default value: Not indicated (ATMOS_STORAGE_DDP_DMIXMOD_NOT_INDICATED) Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores Stereo downmix (StereoDownmix). |
surroundExMode | Eac3AtmosSurroundExMode | 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 (ATMOS_STORAGE_DDP_DMIXMOD_NOT_INDICATED) Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores Stereo downmix (StereoDownmix).
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.
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.
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 (DynamicRangeCompressionProfile). 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 (DynamicRangeCompressionProfile). 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
Eac3LfeFilter
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.
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.
Eac3Settings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.
| Property | Type | Required | Description |
|---|
attenuationControl | Eac3AttenuationControl | False | If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. |
bitrate | integer Minimum: 64000 Maximum: 640000 | False | Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode. |
bitstreamMode | Eac3BitstreamMode | False | Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E). |
codingMode | Eac3CodingMode | False | Dolby Digital Plus coding mode. Determines number of channels. |
dcFilter | Eac3DcFilter | 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 | Eac3DynamicRangeCompressionLine | 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 (DynamicRangeCompressionProfile). 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 | Eac3DynamicRangeCompressionRf | 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 (DynamicRangeCompressionProfile). 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 | Eac3LfeControl | False | When encoding 3/2 audio, controls whether the LFE channel is enabled |
lfeFilter | Eac3LfeFilter | 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 (Lo/Ro center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only center (loRoCenterMixLevel). |
loRoSurroundMixLevel | number Format: float Minimum: -60.0 Maximum: -1.5 | False | Specify a value for the following Dolby Digital Plus setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only surround (loRoSurroundMixLevel). |
ltRtCenterMixLevel | number Format: float Minimum: -60.0 Maximum: 3.0 | False | Specify a value for the following Dolby Digital Plus setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total center (ltRtCenterMixLevel). |
ltRtSurroundMixLevel | number Format: float Minimum: -60.0 Maximum: -1.5 | False | Specify a value for the following Dolby Digital Plus setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total surround (ltRtSurroundMixLevel). |
metadataControl | Eac3MetadataControl | False | When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. |
passthroughControl | Eac3PassthroughControl | False | When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. |
phaseControl | Eac3PhaseControl | 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 | Eac3StereoDownmix | False | Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Stereo downmix (Eac3StereoDownmix). |
surroundExMode | Eac3SurroundExMode | False | When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. |
surroundMode | Eac3SurroundMode | 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 (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Stereo downmix (Eac3StereoDownmix).
NOT_INDICATED
LO_RO
LT_RT
DPL2
Eac3SurroundExMode
When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
NOT_INDICATED
ENABLED
DISABLED
Eac3SurroundMode
When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
NOT_INDICATED
ENABLED
DISABLED
EmbeddedConvert608To708
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (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.
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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.
| Property | Type | Required | Description |
|---|
destination608ChannelNumber | integer Minimum: 1 Maximum: 4 | False | Ignore this setting unless your input captions are SCC format and your output captions are embedded in the video stream. Specify a CC number for each captions channel in this output. If you have two channels, choose CC numbers that aren't in the same field. For example, choose 1 and 3. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. |
destination708ServiceNumber | integer Minimum: 1 Maximum: 6 | False | Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a different number for each channel. To use this setting, also set Force 608 to 708 upconvert (Convert608To708) to Upconvert (UPCONVERT) in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, MediaConvert uses the number that you specify for CC channel number (destination608ChannelNumber) for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. |
EmbeddedSourceSettings
Settings for embedded captions Source
| Property | Type | Required | Description |
|---|
convert608To708 | EmbeddedConvert608To708 | False | Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (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 | EmbeddedTerminateCaptions | 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.
EmbeddedTimecodeOverride
Set Embedded timecode override (embeddedTimecodeOverride) to Use MDPM (USE_MDPM) when your AVCHD input contains timecode tag data in the Modified Digital Video Pack Metadata (MDPM). When you do, we recommend you also set Timecode source (inputTimecodeSource) to Embedded (EMBEDDED). Leave Embedded timecode override blank, or set to None (NONE), when your input does not contain MDPM timecode.
EsamManifestConfirmConditionNotification
ESAM ManifestConfirmConditionNotification defined by OC-SP-ESAM-API-I03-131025.
| Property | Type | Required | Description |
|---|
mccXml | string Pattern: ^\s*<(.|\n)*ManifestConfirmConditionNotification(.|\n)*>\s*$ | 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 | EsamManifestConfirmConditionNotification | 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 (mccXml). |
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 | EsamSignalProcessingNotification | 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 (sccXml). |
EsamSignalProcessingNotification
ESAM SignalProcessingNotification data defined by OC-SP-ESAM-API-I03-131025.
| Property | Type | Required | Description |
|---|
sccXml | string Pattern: ^\s*<(.|\n)*SignalProcessingNotification(.|\n)*>\s*$ | 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. Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. 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 (scte35Esam). 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 | 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 | 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
If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end.
PROGRESSIVE_DOWNLOAD
NORMAL
F4vSettings
Settings for F4v container
| Property | Type | Required | Description |
|---|
moovPlacement | F4vMoovPlacement | False | If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end. |
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. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to FILE_GROUP_SETTINGS.
| Property | Type | Required | Description |
|---|
destination | string Pattern: ^s3:\/\/ | False | Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. |
destinationSettings | 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 (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.
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 |
|---|
convert608To708 | FileSourceConvert608To708 | False | Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (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. |
framerate | CaptionSourceFramerate | 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. When you work directly in your JSON job specification, use the settings framerateNumerator and framerateDenominator. 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: ^((s3://(.*?)\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI|vtt|VTT|webvtt|WEBVTT))|(https?://(.*?)\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI|vtt|VTT|webvtt|WEBVTT)(\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$ 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 (TimeDeltaUnits) to Milliseconds (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 | FileSourceTimeDeltaUnits | False | When you use the setting Time delta (TimeDelta) 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 (TimeDeltaUnits), MediaConvert uses seconds by default. |
FileSourceTimeDeltaUnits
When you use the setting Time delta (TimeDelta) 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 (TimeDeltaUnits), MediaConvert uses seconds by default.
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.
FrameCaptureSettings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.
| Property | Type | Required | Description |
|---|
framerateDenominator | integer Minimum: 1 Maximum: 2147483647 | False | Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture. |
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 (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 (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 (H264AdaptiveQuantization) to Off (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).
AUTO
LEVEL_1
LEVEL_1_1
LEVEL_1_2
LEVEL_1_3
LEVEL_2
LEVEL_2_1
LEVEL_2_2
LEVEL_3
LEVEL_3_1
LEVEL_3_2
LEVEL_4
LEVEL_4_1
LEVEL_4_2
LEVEL_5
LEVEL_5_1
LEVEL_5_2
H264CodecProfile
H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.
BASELINE
HIGH
HIGH_10BIT
HIGH_422
HIGH_422_10BIT
MAIN
H264DynamicSubGop
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).
H264EntropyEncoding
Entropy encoding mode. Use CABAC (must be in Main or High profile) or 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 (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.
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 (DISABLED). Change this value to Enabled (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 (H264AdaptiveQuantization) to a value other than AUTO.
H264FramerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.
INITIALIZE_FROM_SOURCE
SPECIFIED
H264FramerateConversionAlgorithm
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. 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, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.
DUPLICATE_DROP
INTERPOLATE
FRAMEFORMER
H264GopBReference
If enable, use reference B frames for GOP structures that have B frames > 1.
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 (AUTO) and and leave GOP size (GopSize) blank. By default, if you don't specify GOP mode control (GopSizeUnits), 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 (FRAMES) or Specified, seconds (SECONDS) and then provide the GOP length in the related setting GOP size (GopSize).
H264InterlaceMode
Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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 (INITIALIZE_FROM_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. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.
INITIALIZE_FROM_SOURCE
SPECIFIED
H264QualityTuningLevel
Optional. Use Quality tuning level (qualityTuningLevel) 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
H264QvbrSettings
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).
| 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 (RateControlMode) 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).
H264RepeatPps
Places a PPS header on each encoded picture, even if repeated.
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 (INTERLACED_OPTIMIZE) 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 (INTERLACED), 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 (telecine) to None (NONE) or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode (interlaceMode) to a value other than Progressive (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 (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.
DISABLED
ENABLED
TRANSITION_DETECTION
H264Settings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.
| Property | Type | Required | Description |
|---|
adaptiveQuantization | H264AdaptiveQuantization | False | Keep the default value, Auto (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 (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 (H264AdaptiveQuantization) to Off (OFF). Related settings: The value that you choose here applies to the following settings: H264FlickerAdaptiveQuantization, H264SpatialAdaptiveQuantization, and H264TemporalAdaptiveQuantization. |
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 | H264CodecLevel | False | Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO). |
codecProfile | H264CodecProfile | False | H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License. |
dynamicSubGop | H264DynamicSubGop | False | Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames). |
entropyEncoding | H264EntropyEncoding | False | Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC. |
fieldEncoding | H264FieldEncoding | 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 (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 | H264FlickerAdaptiveQuantization | 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 (DISABLED). Change this value to Enabled (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 (H264AdaptiveQuantization) to a value other than AUTO. |
framerateControl | H264FramerateControl | False | If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator. |
framerateConversionAlgorithm | H264FramerateConversionAlgorithm | False | Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. 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, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. |
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 | H264GopBReference | False | If enable, use reference B frames for GOP structures that have B frames > 1. |
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, keep the default value by leaving this setting out of your JSON job specification. 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 (GopSizeUnits) to Specified, frames (FRAMES) or Specified, seconds (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 (GopSizeUnits). If you want to allow MediaConvert to automatically determine GOP size, leave GOP size blank and set GOP mode control to Auto (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 | H264GopSizeUnits | 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 (AUTO) and and leave GOP size (GopSize) blank. By default, if you don't specify GOP mode control (GopSizeUnits), 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 (FRAMES) or Specified, seconds (SECONDS) and then provide the GOP length in the related setting GOP size (GopSize). |
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 | H264InterlaceMode | False | Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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 | Use this setting only when you also enable Scene change detection (SceneChangeDetect). This setting determines how the encoder manages the spacing between I-frames that it inserts as part of the I-frame cadence and the I-frames that it inserts for Scene change detection. 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, keep the default value by leaving this setting out of your JSON job specification. In the console, do this by keeping the default empty value. When you explicitly specify a value for this setting, the encoder determines whether to skip a cadence-driven I-frame by the value you set. For example, if you set Min I interval (minIInterval) to 5 and a cadence-driven I-frame would fall within 5 frames of a scene-change I-frame, then the encoder skips the cadence-driven I-frame. In this way, one GOP is shrunk slightly and one GOP is stretched slightly. When the cadence-driven I-frames are farther from the scene-change I-frame than the value you set, then the encoder leaves all I-frames in place and the GOPs surrounding the scene change are smaller than the usual cadence GOPs. |
numberBFramesBetweenReferenceFrames | integer Minimum: 0 Maximum: 7 | False | This setting to determines the number of B-frames that MediaConvert puts between reference frames in this output. We recommend that you use automatic behavior to allow the transcoder to choose the best value based on characteristics of your input video. In the console, choose AUTO to select this automatic behavior. When you manually edit your JSON job specification, leave this setting out to choose automatic behavior. When you want to specify this number explicitly, choose a whole number from 0 through 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 | H264ParControl | False | Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_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. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. 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 (parControl) 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 (parControl) 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 | H264QualityTuningLevel | False | Optional. Use Quality tuning level (qualityTuningLevel) 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 | H264QvbrSettings | 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). |
rateControlMode | H264RateControlMode | False | Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR). |
repeatPps | H264RepeatPps | False | Places a PPS header on each encoded picture, even if repeated. |
scanTypeConversionMode | H264ScanTypeConversionMode | 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 (INTERLACED_OPTIMIZE) 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 (INTERLACED), 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 (telecine) to None (NONE) or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode (interlaceMode) to a value other than Progressive (PROGRESSIVE). |
sceneChangeDetect | H264SceneChangeDetect | False | Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. |
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 | H264SlowPal | 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. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. |
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 (sharpness) or by enabling a noise reducer filter (noiseReducerFilter). The Softness (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 | H264SpatialAdaptiveQuantization | False | Only use this setting when you change the default value, Auto (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 (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 (DISABLED). Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (H264AdaptiveQuantization) 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 (H264AdaptiveQuantization) to a value other than AUTO. |
syntax | H264Syntax | False | Produces a bitstream compliant with SMPTE RP-2027. |
telecine | H264Telecine | 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 (HARD) produces a 29.97i output. Soft telecine (SOFT) 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 (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture. |
temporalAdaptiveQuantization | H264TemporalAdaptiveQuantization | 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 (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 (DISABLED). Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization). To manually enable or disable H264TemporalAdaptiveQuantization, you must set Adaptive quantization (H264AdaptiveQuantization) to a value other than AUTO. |
unregisteredSeiTimecode | H264UnregisteredSeiTimecode | 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. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.
H264SpatialAdaptiveQuantization
Only use this setting when you change the default value, Auto (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 (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 (DISABLED). Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (H264AdaptiveQuantization) 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 (H264AdaptiveQuantization) to a value other than AUTO.
H264Syntax
Produces a bitstream compliant with SMPTE RP-2027.
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 (HARD) produces a 29.97i output. Soft telecine (SOFT) 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 (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.
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 (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 (DISABLED). Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization). To manually enable or disable H264TemporalAdaptiveQuantization, you must set Adaptive quantization (H264AdaptiveQuantization) to a value other than AUTO.
H264UnregisteredSeiTimecode
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.
H265AdaptiveQuantization
When you set Adaptive Quantization (H265AdaptiveQuantization) to Auto (AUTO), or leave blank, MediaConvert automatically applies quantization to improve the video quality of your output. Set Adaptive Quantization to Low (LOW), Medium (MEDIUM), High (HIGH), Higher (HIGHER), or Max (MAX) to manually control the strength of the quantization filter. When you do, you can specify a value for Spatial Adaptive Quantization (H265SpatialAdaptiveQuantization), Temporal Adaptive Quantization (H265TemporalAdaptiveQuantization), and Flicker Adaptive Quantization (H265FlickerAdaptiveQuantization), to further control the quantization filter. Set Adaptive Quantization to Off (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).
H265CodecLevel
H.265 Level.
AUTO
LEVEL_1
LEVEL_2
LEVEL_2_1
LEVEL_3
LEVEL_3_1
LEVEL_4
LEVEL_4_1
LEVEL_5
LEVEL_5_1
LEVEL_5_2
LEVEL_6
LEVEL_6_1
LEVEL_6_2
H265CodecProfile
Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so "Main/High" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License.
MAIN_MAIN
MAIN_HIGH
MAIN10_MAIN
MAIN10_HIGH
MAIN_422_8BIT_MAIN
MAIN_422_8BIT_HIGH
MAIN_422_10BIT_MAIN
MAIN_422_10BIT_HIGH
H265DynamicSubGop
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).
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 (OFF).
H265FramerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.
INITIALIZE_FROM_SOURCE
SPECIFIED
H265FramerateConversionAlgorithm
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. 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, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.
DUPLICATE_DROP
INTERPOLATE
FRAMEFORMER
H265GopBReference
If enable, use reference B frames for GOP structures that have B frames > 1.
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 (AUTO) and and leave GOP size (GopSize) blank. By default, if you don't specify GOP mode control (GopSizeUnits), 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 (FRAMES) or Specified, seconds (SECONDS) and then provide the GOP length in the related setting GOP size (GopSize).
H265InterlaceMode
Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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 (INITIALIZE_FROM_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. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. 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 (qualityTuningLevel) 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 (RateControlMode).
| 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 (RateControlMode) 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).
H265SampleAdaptiveOffsetFilterMode
Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content
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 (INTERLACED_OPTIMIZE) 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 (INTERLACED), 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 (telecine) to None (NONE) or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode (interlaceMode) to a value other than Progressive (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 (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 | H265AdaptiveQuantization | False | When you set Adaptive Quantization (H265AdaptiveQuantization) to Auto (AUTO), or leave blank, MediaConvert automatically applies quantization to improve the video quality of your output. Set Adaptive Quantization to Low (LOW), Medium (MEDIUM), High (HIGH), Higher (HIGHER), or Max (MAX) to manually control the strength of the quantization filter. When you do, you can specify a value for Spatial Adaptive Quantization (H265SpatialAdaptiveQuantization), Temporal Adaptive Quantization (H265TemporalAdaptiveQuantization), and Flicker Adaptive Quantization (H265FlickerAdaptiveQuantization), to further control the quantization filter. Set Adaptive Quantization to Off (OFF) to apply no quantization to your output. |
alternateTransferFunctionSei | H265AlternateTransferFunctionSei | False | Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF). |
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 | H265CodecLevel | False | H.265 Level. |
codecProfile | H265CodecProfile | False | Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so "Main/High" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License. |
dynamicSubGop | H265DynamicSubGop | False | Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames). |
flickerAdaptiveQuantization | H265FlickerAdaptiveQuantization | 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 (OFF). |
framerateControl | H265FramerateControl | False | If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator. |
framerateConversionAlgorithm | H265FramerateConversionAlgorithm | False | Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. 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, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. |
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 | H265GopBReference | False | If enable, use reference B frames for GOP structures that have B frames > 1. |
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, keep the default value by leaving this setting out of your JSON job specification. 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 (GopSizeUnits) to Specified, frames (FRAMES) or Specified, seconds (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 (GopSizeUnits). If you want to allow MediaConvert to automatically determine GOP size, leave GOP size blank and set GOP mode control to Auto (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 | H265GopSizeUnits | 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 (AUTO) and and leave GOP size (GopSize) blank. By default, if you don't specify GOP mode control (GopSizeUnits), 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 (FRAMES) or Specified, seconds (SECONDS) and then provide the GOP length in the related setting GOP size (GopSize). |
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 | H265InterlaceMode | False | Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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 | Use this setting only when you also enable Scene change detection (SceneChangeDetect). This setting determines how the encoder manages the spacing between I-frames that it inserts as part of the I-frame cadence and the I-frames that it inserts for Scene change detection. 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, keep the default value by leaving this setting out of your JSON job specification. In the console, do this by keeping the default empty value. When you explicitly specify a value for this setting, the encoder determines whether to skip a cadence-driven I-frame by the value you set. For example, if you set Min I interval (minIInterval) to 5 and a cadence-driven I-frame would fall within 5 frames of a scene-change I-frame, then the encoder skips the cadence-driven I-frame. In this way, one GOP is shrunk slightly and one GOP is stretched slightly. When the cadence-driven I-frames are farther from the scene-change I-frame than the value you set, then the encoder leaves all I-frames in place and the GOPs surrounding the scene change are smaller than the usual cadence GOPs. |
numberBFramesBetweenReferenceFrames | integer Minimum: 0 Maximum: 7 | False | Specify the number of B-frames that MediaConvert puts between reference frames in this output. Valid values are whole numbers from 0 through 7. When you don't specify a value, MediaConvert defaults to 2. |
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 | H265ParControl | False | Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_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. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. 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 (parControl) 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 (parControl) 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 | H265QualityTuningLevel | False | Optional. Use Quality tuning level (qualityTuningLevel) 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 | H265QvbrSettings | 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). |
rateControlMode | H265RateControlMode | False | Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR). |
sampleAdaptiveOffsetFilterMode | H265SampleAdaptiveOffsetFilterMode | False | Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content |
scanTypeConversionMode | H265ScanTypeConversionMode | 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 (INTERLACED_OPTIMIZE) 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 (INTERLACED), 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 (telecine) to None (NONE) or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode (interlaceMode) to a value other than Progressive (PROGRESSIVE). |
sceneChangeDetect | H265SceneChangeDetect | False | Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. |
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 | H265SlowPal | 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. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1. |
spatialAdaptiveQuantization | H265SpatialAdaptiveQuantization | False | Keep the default value, Enabled (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 (adaptiveQuantization) 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 | H265Telecine | False | This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i. |
temporalAdaptiveQuantization | H265TemporalAdaptiveQuantization | False | Keep the default value, Enabled (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 (adaptiveQuantization). |
temporalIds | H265TemporalIds | False | Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame rate output. |
tiles | H265Tiles | False | Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures. |
unregisteredSeiTimecode | H265UnregisteredSeiTimecode | False | Inserts timecode for each frame as 4 bytes of an unregistered SEI message. |
writeMp4PackagingType | H265WriteMp4PackagingType | 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. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.
H265SpatialAdaptiveQuantization
Keep the default value, Enabled (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 (adaptiveQuantization) 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.
H265Telecine
This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.
H265TemporalAdaptiveQuantization
Keep the default value, Enabled (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 (adaptiveQuantization).
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.
H265Tiles
Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures.
H265UnregisteredSeiTimecode
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.
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.
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
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 (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.
Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.
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: ^[A-Za-z]{3}$ 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 | 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.
HlsCaptionSegmentLengthControl
Set Caption segment length control (CaptionSegmentLengthControl) to Match video (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 (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 (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header.
HlsCodecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
HlsDescriptiveVideoServiceFlag
Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (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 (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.
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: ^[0-9a-fA-F]{32}$ 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 | HlsEncryptionType | False | Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption. |
initializationVectorInManifest | HlsInitializationVectorInManifest | 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 | HlsOfflineEncrypted | 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 | 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 | StaticKeyProvider | False | Use these settings to set up encryption with a static key provider. |
type | HlsKeyProviderType | 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.
HlsGroupSettings
Settings related to your HLS output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to HLS_GROUP_SETTINGS.
| 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 | HlsAudioOnlyHeader | False | Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (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 | HlsCaptionLanguageSetting | 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 | HlsCaptionSegmentLengthControl | False | Set Caption segment length control (CaptionSegmentLengthControl) to Match video (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 (LARGE_SEGMENTS) to create caption segments that are 300 seconds long. |
clientCache | HlsClientCache | False | Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in your video distribution set up. For example, use the Cache-Control http header. |
codecSpecification | HlsCodecSpecification | False | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. |
destination | string Pattern: ^s3:\/\/ | False | Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file. |
destinationSettings | DestinationSettings | False | Settings associated with the destination. Will vary based on the type of destination |
directoryStructure | HlsDirectoryStructure | False | Indicates whether segments should be placed in subdirectories. |
encryption | HlsEncryptionSettings | False | DRM settings. |
imageBasedTrickPlay | HlsImageBasedTrickPlay | False | Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) 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 | HlsImageBasedTrickPlaySettings | False | Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED |
manifestCompression | HlsManifestCompression | False | When set to GZIP, compresses HLS playlist. |
manifestDurationFormat | HlsManifestDurationFormat | 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 | HlsOutputSelection | False | Indicates whether the .m3u8 manifest file should be generated for this HLS output group. |
programDateTime | HlsProgramDateTime | 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. |
segmentControl | HlsSegmentControl | 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 (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (HlsSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries. |
segmentLengthControl | HlsSegmentLengthControl | False | Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary. |
segmentsPerSubdirectory | integer Minimum: 1 Maximum: 2147483647 | False | Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect. |
streamInfResolution | HlsStreamInfResolution | False | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. |
targetDurationCompatibilityMode | HlsTargetDurationCompatibilityMode | 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 | HlsTimedMetadataId3Frame | False | Specify the type of the ID3 frame (timedMetadataId3Frame) to use for ID3 timestamps (timedMetadataId3Period) in your output. To include ID3 timestamps: Specify PRIV (PRIV) or TDRL (TDRL) and set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). To exclude ID3 timestamps: Set ID3 timestamp frame type to None (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 (timedMetadataId3Frame) to PRIV (PRIV) or TDRL (TDRL), and set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). |
timestampDeltaMilliseconds | integer Minimum: -2147483648 Maximum: 2147483647 | False | Provides an extra millisecond delta offset to fine tune the timestamps. |
HlsIFrameOnlyManifest
Choose Include (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 (EXCLUDE).
HlsImageBasedTrickPlay
Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) 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 | HlsIntervalCadence | 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.
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.
HlsManifestCompression
When set to GZIP, compresses HLS playlist.
Indicates whether the output manifest should use floating point values for segment duration.
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.
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.
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 | LanguageCode | 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 (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.
HlsSettings
Settings for HLS output groups
| Property | Type | Required | Description |
|---|
audioGroupId | string | False | Specifies the group to which the audio rendition belongs. |
audioOnlyContainer | HlsAudioOnlyContainer | 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 (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 | HlsAudioTrackType | 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 | HlsDescriptiveVideoServiceFlag | False | Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (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 (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation. |
iFrameOnlyManifest | HlsIFrameOnlyManifest | False | Choose Include (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 (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.
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.
Specify the type of the ID3 frame (timedMetadataId3Frame) to use for ID3 timestamps (timedMetadataId3Period) in your output. To include ID3 timestamps: Specify PRIV (PRIV) or TDRL (TDRL) and set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). To exclude ID3 timestamps: Set ID3 timestamp frame type to None (NONE).
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 1440 minutes, inclusive. |
Id3Insertion
To insert ID3 tags in your output, specify two values. Use ID3 tag (Id3) to specify the base 64 encoded string and use Timecode (TimeCode) to specify the time when the tag should be inserted. To insert multiple ID3 tags in your output, create multiple instances of ID3 insertion (Id3Insertion).
| Property | Type | Required | Description |
|---|
id3 | string Pattern: ^[A-Za-z0-9+\/]+={0,2}$ | False | Use ID3 tag (Id3) to provide a fully formed ID3 tag in base64-encode format. |
timecode | string Format: timecode Pattern: ^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$ | False | Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format. |
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. |
ImscAccessibilitySubs
Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.
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. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.
| Property | Type | Required | Description |
|---|
accessibility | ImscAccessibilitySubs | False | Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes. |
stylePassthrough | ImscStylePassthrough | False | Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are 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.
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: ^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$ | False | Set End timecode (EndTimecode) to the end of the portion of the input you are clipping. The frame corresponding to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for timecode source under input settings (InputTimecodeSource). For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end six minutes into the video, use 01:06:00:00. |
startTimecode | string Format: timecode Pattern: ^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$ | False | Set Start timecode (StartTimecode) to the beginning of the portion of the input you are clipping. The frame corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:05:00:00. |
Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.
Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.
Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type.
Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.
Use Rotate (InputRotate) 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
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 (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
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). 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.
Specified video input in a template.
| Property | Type | Required | Description |
|---|
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 (AudioDescription). 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 (AudioSelectors) 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 20 captions selectors per input. |
crop | Rectangle | False | Use Cropping selection (crop) 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 (crop). |
deblockFilter | InputDeblockFilter | False | Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs. |
denoiseFilter | InputDenoiseFilter | False | Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs. |
dolbyVisionMetadataXml | string Pattern: ^((s3://(.*?)\.(xml|XML))|(https?://(.*?)\.(xml|XML)(\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$ 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. |
filterEnable | InputFilterEnable | False | Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type. |
filterStrength | integer Minimum: -5 Maximum: 5 | False | Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0. |
imageInserter | 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 | (InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them. |
inputScanType | 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). 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 | Rectangle | False | Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior). |
programNumber | integer Minimum: 1 Maximum: 2147483647 | False | Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default. |
psiControl | InputPsiControl | False | Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data. |
timecodeSource | InputTimecodeSource | False | Use this Timecode source setting, located under the input settings (InputTimecodeSource), 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 (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). 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: ^((([0-1]\d)|(2[0-3]))(:[0-5]\d){2}([:;][0-5]\d))$ 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 (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode. |
videoSelector | VideoSelector | False | Input video selectors contain the video settings for the input. Each of your inputs can have up to one video selector. |
Use this Timecode source setting, located under the input settings (InputTimecodeSource), 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 (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). 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
InsertableImage
These settings apply to a specific graphic overlay. You can include multiple overlays in your job.
| Property | Type | Required | Description |
|---|
duration | integer Minimum: 0 Maximum: 2147483647 | False | Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time. |
fadeIn | integer Minimum: 0 Maximum: 2147483647 | False | Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time. |
fadeOut | integer Minimum: 0 Maximum: 2147483647 | False | Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration. |
height | integer Minimum: 0 Maximum: 2147483647 | False | Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank. |
imageInserterInput | string Pattern: ^((s3://(.*?)\.(bmp|BMP|png|PNG|tga|TGA))|(https?://(.*?)\.(bmp|BMP|png|PNG|tga|TGA)(\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$ MinLength: 14 | False | Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file. |
imageX | integer Minimum: 0 Maximum: 2147483647 | False | Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify. |
imageY | integer Minimum: 0 Maximum: 2147483647 | False | Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify. |
layer | integer Minimum: 0 Maximum: 99 | False | Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer. |
opacity | integer Minimum: 0 Maximum: 100 | False | Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50. |
startTime | string Pattern: ^((([0-1]\d)|(2[0-3]))(:[0-5]\d){2}([:;][0-5]\d))$ | False | Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings. |
width | integer Minimum: 0 Maximum: 2147483647 | False | Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank. |
JobTemplate
A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
| Property | Type | Required | Description |
|---|
accelerationSettings | AccelerationSettings | False | Accelerated transcoding can significantly speed up jobs with long, visually complex content. |
arn | string | False | An identifier for this resource that is unique within all of AWS. |
category | string | False | An optional category you create to organize your job templates. |
createdAt | string Format: date-time | False | The timestamp in epoch seconds for Job template creation. |
description | string | False | An optional description you create for each job template. |
hopDestinations | Array of type HopDestination | False | Optional list of hop destinations. |
lastUpdated | string Format: date-time | False | The timestamp in epoch seconds when the Job template was last updated. |
name | string | True | A name you create for each job template. Each name must be unique within your account. |
priority | integer Format: int32 Minimum: -50 Maximum: 50 | False | Relative priority on the job. |
queue | string | False | Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue. |
settings | JobTemplateSettings | True | JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it. |
statusUpdateInterval | StatusUpdateInterval | False | 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. |
type | Type | False | A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user. |
JobTemplateListBy
Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.
JobTemplateSettings
JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
| Property | Type | Required | Description |
|---|
adAvailOffset | integer Minimum: -1000 Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. |
availBlanking | AvailBlanking | False | Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails. |
esam | EsamSettings | False | Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings. |
extendedDataServices | ExtendedDataServices | False | 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. |
inputs | Array of type InputTemplate | False | Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template. |
kantarWatermark | KantarWatermarkSettings | False | Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html. |
motionImageInserter | MotionImageInserter | False | Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html. |
nielsenConfiguration | NielsenConfiguration | False | Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting. |
nielsenNonLinearWatermark | NielsenNonLinearWatermarkSettings | False | Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0] |
outputGroups | Array of type OutputGroup | False | (OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings |
timecodeConfig | TimecodeConfig | False | These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping. |
timedMetadataInsertion | TimedMetadataInsertion | False | Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). |
KantarWatermarkSettings
Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.
| Property | Type | Required | Description |
|---|
channelName | string MinLength: 1 MaxLength: 20 | False | Provide an audio channel name from your Kantar audio license. |
contentReference | string Pattern: ^[a-zA-Z0-9_\/_+=.@-]*$ MinLength: 1 MaxLength: 50 | False | Specify a unique identifier for Kantar to use for this piece of content. |
credentialsSecretName | string Pattern: ^[a-zA-Z0-9_\/_+=.@-]*$ MinLength: 1 MaxLength: 512 | False | Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets-manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide. |
fileOffset | number Format: float Minimum: 0.0 | False | Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero. |
kantarLicenseId | integer Minimum: 0 Maximum: 2147483647 | False | Provide your Kantar license ID number. You should get this number from Kantar. |
kantarServerUrl | string Format: uri Pattern: ^https:\/\/.*.kantarmedia.com$ | False | Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar. |
logDestination | string Format: uri Pattern: ^s3:\/\/ | False | Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html |
metadata3 | string MinLength: 1 MaxLength: 50 | False | You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support. |
metadata4 | string MinLength: 1 MaxLength: 50 | False | Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters. |
metadata5 | string MinLength: 1 MaxLength: 50 | False | Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters. |
metadata6 | string MinLength: 1 MaxLength: 50 | False | Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters. |
metadata7 | string MinLength: 1 MaxLength: 50 | False | Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters. |
metadata8 | string MinLength: 1 MaxLength: 50 | False | Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters. |
LanguageCode
Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php.
ENG
SPA
FRA
DEU
GER
ZHO
ARA
HIN
JPN
RUS
POR
ITA
URD
VIE
KOR
PAN
ABK
AAR
AFR
AKA
SQI
AMH
ARG
HYE
ASM
AVA
AVE
AYM
AZE
BAM
BAK
EUS
BEL
BEN
BIH
BIS
BOS
BRE
BUL
MYA
CAT
KHM
CHA
CHE
NYA
CHU
CHV
COR
COS
CRE
HRV
CES
DAN
DIV
NLD
DZO
ENM
EPO
EST
EWE
FAO
FIJ
FIN
FRM
FUL
GLA
GLG
LUG
KAT
ELL
GRN
GUJ
HAT
HAU
HEB
HER
HMO
HUN
ISL
IDO
IBO
IND
INA
ILE
IKU
IPK
GLE
JAV
KAL
KAN
KAU
KAS
KAZ
KIK
KIN
KIR
KOM
KON
KUA
KUR
LAO
LAT
LAV
LIM
LIN
LIT
LUB
LTZ
MKD
MLG
MSA
MAL
MLT
GLV
MRI
MAR
MAH
MON
NAU
NAV
NDE
NBL
NDO
NEP
SME
NOR
NOB
NNO
OCI
OJI
ORI
ORM
OSS
PLI
FAS
POL
PUS
QUE
QAA
RON
ROH
RUN
SMO
SAG
SAN
SRD
SRB
SNA
III
SND
SIN
SLK
SLV
SOM
SOT
SUN
SWA
SSW
SWE
TGL
TAH
TGK
TAM
TAT
TEL
THA
BOD
TIR
TON
TSO
TSN
TUR
TUK
TWI
UIG
UKR
UZB
VEN
VOL
WLN
CYM
FRY
WOL
XHO
YID
YOR
ZHA
ZUL
ORJ
QPC
TNG
SRP
ListJobTemplatesRequest
You can send list job templates requests with an empty body. Optionally, you can filter the response by category by specifying it in your request body. You can also optionally specify the maximum number, up to twenty, of job templates to be returned.
| Property | Type | Required | Description |
|---|
category | string | False | Optionally, specify a job template category to limit responses to only job templates from that category. |
listBy | JobTemplateListBy | False | Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name. |
maxResults | integer Format: int32 Minimum: 1 Maximum: 20 | False | Optional. Number of job templates, up to twenty, that will be returned at one time. |
nextToken | string | False | Use this string, provided with the response to a previous request, to request the next batch of job templates. |
order | Order | False | Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource. |
ListJobTemplatesResponse
Successful list job templates requests return a JSON array of job templates. If you don't specify how they are ordered, you will receive them in alphabetical order by name.
| Property | Type | Required | Description |
|---|
jobTemplates | Array of type JobTemplate | False | List of Job templates. |
nextToken | string | False | Use this string to request the next batch of job templates. |
M2tsAudioBufferModel
Selects between the DVB and ATSC buffer models for Dolby Digital audio.
M2tsAudioDuration
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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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
M2tsBufferModel
Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
M2tsDataPtsControl
If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value (AUTO) to allow all PTS values.
M2tsEbpAudioInterval
When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).
M2tsEbpPlacement
Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).
VIDEO_AND_AUDIO_PIDS
VIDEO_PID
M2tsEsRateInPes
Controls whether to include the ES Rate field in the PES header.
M2tsForceTsVideoEbpOrder
Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE).
Applies to MPEG-TS outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.
M2tsNielsenId3
If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
M2tsPcrControl
When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream.
PCR_EVERY_PES_PACKET
CONFIGURED_PCR_PERIOD
M2tsRateMode
When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.
M2tsScte35Esam
Settings for SCTE-35 signals from ESAM. Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).
| Property | Type | Required | Description |
|---|
scte35EsamPid | integer Minimum: 32 Maximum: 8182 | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream generated by ESAM. |
M2tsScte35Source
For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).
M2tsSegmentationMarkers
Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
NONE
RAI_SEGSTART
RAI_ADAPT
PSI_SEGSTART
EBP
EBP_LEGACY
M2tsSegmentationStyle
The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "reset_cadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of "maintain_cadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.
MAINTAIN_CADENCE
RESET_CADENCE
M2tsSettings
MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.
| Property | Type | Required | Description |
|---|
audioBufferModel | M2tsAudioBufferModel | False | Selects between the DVB and ATSC buffer models for Dolby Digital audio. |
audioDuration | M2tsAudioDuration | 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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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. |
audioFramesPerPes | integer Minimum: 0 Maximum: 2147483647 | False | The number of audio frames to insert for each PES packet. |
audioPids | Array of type integer Minimum: 32 Maximum: 8182 | False | Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492. |
bitrate | integer Minimum: 0 Maximum: 2147483647 | False | Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000. |
bufferModel | M2tsBufferModel | False | Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. |
dataPTSControl | M2tsDataPtsControl | False | If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value (AUTO) to allow all PTS values. |
dvbNitSettings | DvbNitSettings | False | Use these settings to insert a DVB Network Information Table (NIT) in the transport stream of this output. When you work directly in your JSON job specification, include this object only when your job has a transport stream output and the container settings contain the object M2tsSettings. |
dvbSdtSettings | DvbSdtSettings | False | Use these settings to insert a DVB Service Description Table (SDT) in the transport stream of this output. When you work directly in your JSON job specification, include this object only when your job has a transport stream output and the container settings contain the object M2tsSettings. |
dvbSubPids | Array of type integer Minimum: 32 Maximum: 8182 | False | Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479. |
dvbTdtSettings | DvbTdtSettings | False | Use these settings to insert a DVB Time and Date Table (TDT) in the transport stream of this output. When you work directly in your JSON job specification, include this object only when your job has a transport stream output and the container settings contain the object M2tsSettings. |
dvbTeletextPid | integer Minimum: 32 Maximum: 8182 | False | Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499. |
ebpAudioInterval | M2tsEbpAudioInterval | False | When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY). |
ebpPlacement | M2tsEbpPlacement | False | Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY). |
esRateInPes | M2tsEsRateInPes | False | Controls whether to include the ES Rate field in the PES header. |
forceTsVideoEbpOrder | M2tsForceTsVideoEbpOrder | False | Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE). |
fragmentTime | number Format: float Minimum: 0.0 | False | The length, in seconds, of each fragment. Only used with EBP markers. |
klvMetadata | M2tsKlvMetadata | False | Applies to MPEG-TS outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output. |
maxPcrInterval | integer Minimum: 0 Maximum: 500 | False | Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream. |
minEbpInterval | integer Minimum: 0 Maximum: 10000 | False | When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate. |
nielsenId3 | M2tsNielsenId3 | False | If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. |
nullPacketBitrate | number Format: float Minimum: 0.0 | False | Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets. |
patInterval | integer Minimum: 0 Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. |
pcrControl | M2tsPcrControl | False | When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream. |
pcrPid | integer Minimum: 32 Maximum: 8182 | False | Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID (VideoPid). |
pmtInterval | integer Minimum: 0 Maximum: 1000 | False | Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream. |
pmtPid | integer Minimum: 32 Maximum: 8182 | False | Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480. |
privateMetadataPid | integer Minimum: 32 Maximum: 8182 | False | Specify the packet identifier (PID) of the private metadata stream. Default is 503. |
programNumber | integer Minimum: 0 Maximum: 65535 | False | Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data. |
rateMode | M2tsRateMode | False | When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate. |
scte35Esam | M2tsScte35Esam | False | Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml). |
scte35Pid | integer Minimum: 32 Maximum: 8182 | False | Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream. |
scte35Source | M2tsScte35Source | False | For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam). |
segmentationMarkers | M2tsSegmentationMarkers | False | Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. |
segmentationStyle | M2tsSegmentationStyle | False | The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "reset_cadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of "maintain_cadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule. |
segmentationTime | number Format: float Minimum: 0.0 | False | Specify the length, in seconds, of each segment. Required unless markers is set to _none_. |
timedMetadataPid | integer Minimum: 32 Maximum: 8182 | False | Specify the packet identifier (PID) for timed metadata in this output. Default is 502. |
transportStreamId | integer Minimum: 0 Maximum: 65535 | False | Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and program map tables are parts of MPEG-2 transport stream containers, used for organizing data. |
videoPid | integer Minimum: 32 Maximum: 8182 | False | Specify the packet identifier (PID) of the elementary video stream in the transport stream. |
M3u8AudioDuration
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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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
M3u8DataPtsControl
If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value (AUTO) to allow all PTS values.
M3u8NielsenId3
If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
M3u8PcrControl
When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.
PCR_EVERY_PES_PACKET
CONFIGURED_PCR_PERIOD
M3u8Scte35Source
For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml).
M3u8Settings
These settings relate to the MPEG-2 transport stream (MPEG2-TS) container for the MPEG2-TS segments in your HLS outputs.
| Property | Type | Required | Description |
|---|
audioDuration | M3u8AudioDuration | 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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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. |
audioFramesPerPes | integer Minimum: 0 Maximum: 2147483647 | False | The number of audio frames to insert for each PES packet. |
audioPids | Array of type integer Minimum: 32 Maximum: 8182 | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. |
dataPTSControl | M3u8DataPtsControl | False | If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value (AUTO) to allow all PTS values. |
maxPcrInterval | integer Minimum: 0 Maximum: 500 | False | Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream. |
nielsenId3 | M3u8NielsenId3 | False | If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. |
patInterval | integer Minimum: 0 Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. |
pcrControl | M3u8PcrControl | False | When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. |
pcrPid | integer Minimum: 32 Maximum: 8182 | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. |
pmtInterval | integer Minimum: 0 Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. |
pmtPid | integer Minimum: 32 Maximum: 8182 | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. |
privateMetadataPid | integer Minimum: 32 Maximum: 8182 | False | Packet Identifier (PID) of the private metadata stream in the transport stream. |
programNumber | integer Minimum: 0 Maximum: 65535 | False | The value of the program number field in the Program Map Table. |
scte35Pid | integer Minimum: 32 Maximum: 8182 | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. |
scte35Source | M3u8Scte35Source | False | For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). |
timedMetadata | TimedMetadata | False | Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH) to include ID3 metadata in this output. This includes ID3 metadata from the following features: ID3 timestamp period (timedMetadataId3Period), and Custom ID3 metadata inserter (timedMetadataInsertion). To exclude this ID3 metadata in this output: set ID3 metadata to None (NONE) or leave blank. |
timedMetadataPid | integer Minimum: 32 Maximum: 8182 | False | Packet Identifier (PID) of the ID3 metadata stream in the transport stream. |
transportStreamId | integer Minimum: 0 Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. |
videoPid | integer Minimum: 32 Maximum: 8182 | False | Packet Identifier (PID) of the elementary video stream in the transport stream. |
MotionImageInserter
Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html.
| Property | Type | Required | Description |
|---|
framerate | MotionImageInsertionFramerate | False | If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video. |
input | string Pattern: ^((s3://(.*)(\.mov|[0-9]+\.png))|(https?://(.*)(\.mov|[0-9]+\.png)(\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$ MinLength: 14 | False | Specify the .mov file or series of .png files that you want to overlay on your video. For .png files, provide the file name of the first file in the series. Make sure that the names of the .png files end with sequential numbers that specify the order that they are played in. For example, overlay_000.png, overlay_001.png, overlay_002.png, and so on. The sequence must start at zero, and each image file name must have the same number of digits. Pad your initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png, there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is overlay_00.png, there can be 100 images in the sequence. |
insertionMode | MotionImageInsertionMode | False | Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files. |
offset | MotionImageInsertionOffset | False | Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling. |
playback | MotionImagePlayback | False | Specify whether your motion graphic overlay repeats on a loop or plays only once. |
startTime | string Pattern: ^((([0-1]\d)|(2[0-3]))(:[0-5]\d){2}([:;][0-5]\d))$ MinLength: 11 MaxLength: 11 | False | Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource. |
MotionImageInsertionFramerate
For motion overlays that don't have a built-in frame rate, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. The overlay frame rate doesn't need to match the frame rate of the underlying video.
| Property | Type | Required | Description |
|---|
framerateDenominator | integer Minimum: 1 Maximum: 17895697 | False | The bottom of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 1. |
framerateNumerator | integer Minimum: 1 Maximum: 2147483640 | False | The top of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 24. |
MotionImageInsertionMode
Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files.
MotionImageInsertionOffset
Specify the offset between the upper-left corner of the video frame and the top left corner of the overlay.
| Property | Type | Required | Description |
|---|
imageX | integer Minimum: 0 Maximum: 2147483647 | False | Set the distance, in pixels, between the overlay and the left edge of the video frame. |
imageY | integer Minimum: 0 Maximum: 2147483647 | False | Set the distance, in pixels, between the overlay and the top edge of the video frame. |
MotionImagePlayback
Specify whether your motion graphic overlay repeats on a loop or plays only once.
MovClapAtom
When enabled, include 'clap' atom if appropriate for the video output settings.
MovCslgAtom
When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.
MovMpeg2FourCCControl
When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable when the video codec is MPEG2.
MovPaddingControl
To make this output compatible with Omenon, keep the default value, OMNEON. Unless you need Omneon compatibility, set this value to NONE. When you keep the default value, OMNEON, MediaConvert increases the length of the edit list atom. This might cause file rejections when a recipient of the output file doesn't expct this extra padding.
MovReference
Always keep the default value (SELF_CONTAINED) for this setting.
MovSettings
These settings relate to your QuickTime MOV output container.
| Property | Type | Required | Description |
|---|
clapAtom | MovClapAtom | False | When enabled, include 'clap' atom if appropriate for the video output settings. |
cslgAtom | MovCslgAtom | False | When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools. |
mpeg2FourCCControl | MovMpeg2FourCCControl | False | When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable when the video codec is MPEG2. |
paddingControl | MovPaddingControl | False | To make this output compatible with Omenon, keep the default value, OMNEON. Unless you need Omneon compatibility, set this value to NONE. When you keep the default value, OMNEON, MediaConvert increases the length of the edit list atom. This might cause file rejections when a recipient of the output file doesn't expct this extra padding. |
reference | MovReference | False | Always keep the default value (SELF_CONTAINED) for this setting. |
Mp2Settings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2.
| Property | Type | Required | Description |
|---|
bitrate | integer Minimum: 32000 Maximum: 384000 | False | Specify the average bitrate in bits per second. |
channels | integer Minimum: 1 Maximum: 2 | False | Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2. |
sampleRate | integer Minimum: 32000 Maximum: 48000 | False | Sample rate in hz. |
Mp3RateControlMode
Specify whether the service encodes this MP3 audio output with a constant bitrate (CBR) or a variable bitrate (VBR).
Mp3Settings
Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3.
| Property | Type | Required | Description |
|---|
bitrate | integer Minimum: 16000 Maximum: 320000 | False | Specify the average bitrate in bits per second. |
channels | integer Minimum: 1 Maximum: 2 | 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 1 and 2. |
rateControlMode | Mp3RateControlMode | False | Specify whether the service encodes this MP3 audio output with a constant bitrate (CBR) or a variable bitrate (VBR). |
sampleRate | integer Minimum: 22050 Maximum: 48000 | False | Sample rate in hz. |
vbrQuality | integer Minimum: 0 Maximum: 9 | False | Required when you set Bitrate control mode (rateControlMode) to VBR. Specify the audio quality of this MP3 output from 0 (highest quality) to 9 (lowest quality). |
Mp4CslgAtom
When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.
Mp4FreeSpaceBox
Inserts a free-space box immediately after the moov box.
Mp4MoovPlacement
If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end.
PROGRESSIVE_DOWNLOAD
NORMAL
Mp4Settings
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.
| Property | Type | Required | Description |
|---|
audioDuration | CmfcAudioDuration | 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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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. |
cslgAtom | Mp4CslgAtom | False | When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools. |
cttsVersion | integer Minimum: 0 Maximum: 1 | False | Ignore this setting unless compliance to the CTTS box version specification matters in your workflow. Specify a value of 1 to set your CTTS box version to 1 and make your output compliant with the specification. When you specify a value of 1, you must also set CSLG atom (cslgAtom) to the value INCLUDE. Keep the default value 0 to set your CTTS box version to 0. This can provide backward compatibility for some players and packagers. |
freeSpaceBox | Mp4FreeSpaceBox | False | Inserts a free-space box immediately after the moov box. |
moovPlacement | Mp4MoovPlacement | False | If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end. |
mp4MajorBrand | string | False | Overrides the "Major Brand" field in the output file. Usually not necessary to specify. |
MpdAccessibilityCaptionHints
Optional. Choose Include (INCLUDE) to have MediaConvert mark up your DASH manifest with <Accessibility> elements for embedded 608 captions. This markup isn't generally required, but some video players require it to discover and play embedded 608 captions. Keep the default value, Exclude (EXCLUDE), to leave these elements out. When you enable this setting, this is the markup that MediaConvert includes in your manifest: <Accessibility schemeIdUri="urn:scte:dash:cc:cea-608:2015" value="CC1=eng"/>
MpdAudioDuration
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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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
MpdCaptionContainerType
Use this setting only in DASH output groups that include sidecar TTML or IMSC captions. You specify sidecar captions in a separate output from your audio and video. Choose Raw (RAW) for captions in a single XML file in a raw container. Choose Fragmented MPEG-4 (FRAGMENTED_MP4) for captions in XML format contained within fragmented MP4 files. This set of fragmented MP4 files is separate from your video and audio fragmented MP4 files.
Applies to DASH ISO outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.
MpdScte35Esam
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 (sccXml).
MpdScte35Source
Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.
MpdSettings
These settings relate to the fragmented MP4 container for the segments in your DASH outputs.
| Property | Type | Required | Description |
|---|
accessibilityCaptionHints | MpdAccessibilityCaptionHints | False | Optional. Choose Include (INCLUDE) to have MediaConvert mark up your DASH manifest with <Accessibility> elements for embedded 608 captions. This markup isn't generally required, but some video players require it to discover and play embedded 608 captions. Keep the default value, Exclude (EXCLUDE), to leave these elements out. When you enable this setting, this is the markup that MediaConvert includes in your manifest: <Accessibility schemeIdUri="urn:scte:dash:cc:cea-608:2015" value="CC1=eng"/> |
audioDuration | MpdAudioDuration | 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 (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (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. |
captionContainerType | MpdCaptionContainerType | False | Use this setting only in DASH output groups that include sidecar TTML or IMSC captions. You specify sidecar captions in a separate output from your audio and video. Choose Raw (RAW) for captions in a single XML file in a raw container. Choose Fragmented MPEG-4 (FRAGMENTED_MP4) for captions in XML format contained within fragmented MP4 files. This set of fragmented MP4 files is separate from your video and audio fragmented MP4 files. |
klvMetadata | MpdKlvMetadata | False | Applies to DASH ISO outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output. |
scte35Esam | MpdScte35Esam | 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 (sccXml). |
scte35Source | MpdScte35Source | False | Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output. |
timedMetadata | MpdTimedMetadata | False | To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank. |
To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.
Mpeg2AdaptiveQuantization
Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).
Mpeg2CodecLevel
Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output.
Mpeg2CodecProfile
Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output.
Mpeg2DynamicSubGop
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).
Mpeg2FramerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.
INITIALIZE_FROM_SOURCE
SPECIFIED
Mpeg2FramerateConversionAlgorithm
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. 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, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.
DUPLICATE_DROP
INTERPOLATE
FRAMEFORMER
Mpeg2GopSizeUnits
Specify the units for GOP size (GopSize). If you don't specify a value here, by default the encoder measures GOP size in frames.
Mpeg2InterlaceMode
Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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
Mpeg2IntraDcPrecision
Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio.
AUTO
INTRA_DC_PRECISION_8
INTRA_DC_PRECISION_9
INTRA_DC_PRECISION_10
INTRA_DC_PRECISION_11
Mpeg2ParControl
Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_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. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.
INITIALIZE_FROM_SOURCE
SPECIFIED
Mpeg2QualityTuningLevel
Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.
Mpeg2RateControlMode
Use Rate control mode (Mpeg2RateControlMode) to specify whether the bitrate is variable (vbr) or constant (cbr).
Mpeg2ScanTypeConversionMode
Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing (INTERLACED_OPTIMIZE) 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 (INTERLACED), 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 (telecine) to None (NONE) or Soft (SOFT). You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode (interlaceMode) to a value other than Progressive (PROGRESSIVE).
INTERLACED
INTERLACED_OPTIMIZE
Mpeg2SceneChangeDetect
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default.
Mpeg2Settings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2.
| Property | Type | Required | Description |
|---|
adaptiveQuantization | Mpeg2AdaptiveQuantization | False | Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization). |
bitrate | integer Minimum: 1000 Maximum: 288000000 | False | Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000. |
codecLevel | Mpeg2CodecLevel | False | Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output. |
codecProfile | Mpeg2CodecProfile | False | Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output. |
dynamicSubGop | Mpeg2DynamicSubGop | False | Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames). |
framerateControl | Mpeg2FramerateControl | False | If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator. |
framerateConversionAlgorithm | Mpeg2FramerateConversionAlgorithm | False | Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. 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, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. |
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. |
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. When you create a streaming output, we recommend that you keep the default value, 1, so that players starting mid-stream receive an IDR frame as quickly as possible. Don't set this value to 0; that would break output segmenting. |
gopSize | number Format: float Minimum: 0.0 | False | Specify the interval between keyframes, in seconds or frames, for this output. Default: 12 Related settings: When you specify the GOP size in seconds, set GOP mode control (GopSizeUnits) to Specified, seconds (SECONDS). The default value for GOP mode control (GopSizeUnits) is Frames (FRAMES). |
gopSizeUnits | Mpeg2GopSizeUnits | False | Specify the units for GOP size (GopSize). If you don't specify a value here, by default the encoder measures GOP size in frames. |
hrdBufferInitialFillPercentage | integer Minimum: 0 Maximum: 100 | False | Percentage of the buffer that should initially be filled (HRD buffer model). |
hrdBufferSize | integer Minimum: 0 Maximum: 47185920 | False | Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000. |
interlaceMode | Mpeg2InterlaceMode | False | Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) 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. |
intraDcPrecision | Mpeg2IntraDcPrecision | False | Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio. |
maxBitrate | integer Minimum: 1000 Maximum: 300000000 | False | Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. |
minIInterval | integer Minimum: 0 Maximum: 30 | False | Use this setting only when you also enable Scene change detection (SceneChangeDetect). This setting determines how the encoder manages the spacing between I-frames that it inserts as part of the I-frame cadence and the I-frames that it inserts for Scene change detection. When you specify a value for this setting, the encoder determines whether to skip a cadence-driven I-frame by the value you set. For example, if you set Min I interval (minIInterval) to 5 and a cadence-driven I-frame would fall within 5 frames of a scene-change I-frame, then the encoder skips the cadence-driven I-frame. In this way, one GOP is shrunk slightly and one GOP is stretched slightly. When the cadence-driven I-frames are farther from the scene-change I-frame than the value you set, then the encoder leaves all I-frames in place and the GOPs surrounding the scene change are smaller than the usual cadence GOPs. |
numberBFramesBetweenReferenceFrames | integer Minimum: 0 Maximum: 7 | False | Specify the number of B-frames that MediaConvert puts between reference frames in this output. Valid values are whole numbers from 0 through 7. When you don't specify a value, MediaConvert defaults to 2. |
parControl | Mpeg2ParControl | False | Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_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. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. 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 (parControl) 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 (parControl) 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 parN |