JobTemplates name
URI
/2017-08-29/jobTemplates/name
HTTP Methods
GET
Operation ID: GetJobTemplate
Retrieve the JSON for a specific job template.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | True |
Responses
| Status Code | Response Model | Description |
|---|---|---|
200 |
GetJobTemplateResponse |
200 response |
400 |
ExceptionBody |
The service can't process your request because of a problem in the request. Please check your request form and syntax. |
403 |
ExceptionBody |
You don't have permissions for this action with the credentials you sent. |
404 |
ExceptionBody |
The resource you requested does not exist. |
409 |
ExceptionBody |
The service could not complete your request because there is a conflict with the current state of the resource. |
429 |
ExceptionBody |
Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. |
500 |
ExceptionBody |
The service encountered an unexpected condition and cannot fulfill your request. |
PUT
Operation ID: UpdateJobTemplate
Modify one of your existing job templates.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | True |
Responses
| Status Code | Response Model | Description |
|---|---|---|
200 |
UpdateJobTemplateResponse |
200 response |
400 |
ExceptionBody |
The service can't process your request because of a problem in the request. Please check your request form and syntax. |
403 |
ExceptionBody |
You don't have permissions for this action with the credentials you sent. |
404 |
ExceptionBody |
The resource you requested does not exist. |
409 |
ExceptionBody |
The service could not complete your request because there is a conflict with the current state of the resource. |
429 |
ExceptionBody |
Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. |
500 |
ExceptionBody |
The service encountered an unexpected condition and cannot fulfill your request. |
DELETE
Operation ID: DeleteJobTemplate
Permanently delete a job template you have created.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | True |
Responses
| Status Code | Response Model | Description |
|---|---|---|
202 |
DeleteJobTemplateResponse |
202 response |
400 |
ExceptionBody |
The service can't process your request because of a problem in the request. Please check your request form and syntax. |
403 |
ExceptionBody |
You don't have permissions for this action with the credentials you sent. |
404 |
ExceptionBody |
The resource you requested does not exist. |
409 |
ExceptionBody |
The service could not complete your request because there is a conflict with the current state of the resource. |
429 |
ExceptionBody |
Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. |
500 |
ExceptionBody |
The service encountered an unexpected condition and cannot fulfill your request. |
OPTIONS
Supports CORS preflight requests.
Responses
| Status Code | Response Model | Description |
|---|---|---|
200 |
None |
The request completed successfully. |
Schemas
Request Bodies
Example GET
{ "name": "string" }
Example PUT
{ "description": "string", "category": "string", "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, "pcrPid": integer, "pmtPid": integer, "privateMetadataPid": integer, "programNumber": integer, "patInterval": integer, "pmtInterval": integer, "scte35Source": enum, "scte35Pid": integer, "nielsenId3": enum, "timedMetadata": enum, "timedMetadataPid": integer, "transportStreamId": integer, "videoPid": integer, "audioPids": [ integer ] }, "f4vSettings": { "moovPlacement": enum }, "m2tsSettings": { "audioBufferModel": enum, "minEbpInterval": integer, "esRateInPes": enum, "patInterval": integer, "dvbNitSettings": { "nitInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "scte35Source": enum, "scte35Pid": integer, "scte35Esam": { "scte35EsamPid": integer }, "videoPid": integer, "dvbTdtSettings": { "tdtInterval": integer }, "pmtInterval": integer, "segmentationStyle": enum, "segmentationTime": number, "pmtPid": integer, "bitrate": integer, "audioPids": [ integer ], "privateMetadataPid": integer, "nielsenId3": enum, "timedMetadataPid": integer, "maxPcrInterval": integer, "transportStreamId": integer, "dvbSubPids": [ integer ], "rateMode": enum, "audioFramesPerPes": integer, "pcrControl": enum, "segmentationMarkers": enum, "ebpAudioInterval": enum, "forceTsVideoEbpOrder": enum, "programNumber": integer, "pcrPid": integer, "bufferModel": enum, "dvbTeletextPid": integer, "fragmentTime": number, "ebpPlacement": enum, "nullPacketBitrate": number }, "movSettings": { "clapAtom": enum, "cslgAtom": enum, "paddingControl": enum, "reference": enum, "mpeg2FourCCControl": enum }, "mp4Settings": { "cslgAtom": enum, "freeSpaceBox": enum, "mp4MajorBrand": "string", "moovPlacement": enum }, "mpdSettings": { "captionContainerType": enum, "scte35Source": enum, "scte35Esam": enum } }, "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, "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 } }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ] }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer }, "temporalFilterSettings": { "strength": integer, "speed": integer, "aggressiveMode": integer } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "entropyEncoding": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum }, "h265Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "alternateTransferFunctionSei": enum, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "tiles": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "temporalIds": enum, "sampleAdaptiveOffsetFilterMode": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum }, "mpeg2Settings": { "interlaceMode": enum, "parNumerator": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "bitrate": integer, "intraDcPrecision": enum, "framerateControl": enum, "rateControlMode": enum, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "dynamicSubGop": enum }, "proresSettings": { "interlaceMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum } }, "afdSignaling": enum, "dropFrameTimecode": enum, "respondToAfd": enum, "colorMetadata": enum }, "audioDescriptions": [ { "audioTypeControl": enum, "audioSourceName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "correctionGateLevel": integer, "loudnessLogging": enum, "targetLkfs": number, "peakCalculation": enum }, "codecSettings": { "codec": enum, "aacSettings": { "audioDescriptionBroadcasterMix": enum, "vbrQuality": enum, "bitrate": integer, "rateControlMode": enum, "codecProfile": enum, "codingMode": enum, "rawFormat": enum, "sampleRate": integer, "specification": enum }, "ac3Settings": { "bitrate": integer, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "dynamicRangeCompressionProfile": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "eac3AtmosSettings": { "surroundExMode": enum, "loRoSurroundMixLevel": number, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "loRoCenterMixLevel": number, "codingMode": enum, "bitstreamMode": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "meteringMode": enum, "dialogueIntelligence": enum, "speechThreshold": integer }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer, "channelsOut": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "outputSettings": { "hlsSettings": { "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": 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, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "dvbSubDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer, "subtitlingType": enum }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string", "pageTypes": [ enum ] }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "imscDestinationSettings": { "stylePassthrough": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": integer, "destination708ServiceNumber": integer } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } ], "outputGroupSettings": { "type": enum, "hlsGroupSettings": { "manifestDurationFormat": enum, "segmentLength": integer, "timedMetadataId3Period": integer, "captionLanguageSetting": enum, "captionLanguageMappings": [ { "captionChannel": integer, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ], "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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, "streamInfResolution": enum }, "dashIsoGroupSettings": { "segmentLength": integer, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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, "mpdProfile": enum, "hbbtvCompliance": enum, "writeSegmentTimelineInRepresentation": enum }, "fileGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string" }, "accessControl": { "cannedAcl": enum } } } }, "msSmoothGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string" }, "accessControl": { "cannedAcl": enum } } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "fragmentLength": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string" } }, "manifestEncoding": enum, "audioDeduplication": enum }, "cmafGroupSettings": { "writeHlsManifest": enum, "writeDashManifest": enum, "segmentLength": integer, "minFinalSegmentLength": number, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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, "mpdProfile": enum, "manifestDurationFormat": enum, "streamInfResolution": enum, "clientCache": enum, "manifestCompression": enum, "codecSpecification": enum } } } ], "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 }, "inputs": [ { "inputClippings": [ { "endTimecode": "string", "startTimecode": "string" } ], "audioSelectors": { }, "audioSelectorGroups": { }, "programNumber": integer, "videoSelector": { "colorSpace": enum, "rotate": enum, "pid": integer, "programNumber": integer, "alphaBehavior": enum, "colorSpaceUsage": 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, "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 } ] }, "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 }
Example DELETE
{ "name": "string" }
Response Bodies
Example GetJobTemplateResponse
{ "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, "pcrPid": integer, "pmtPid": integer, "privateMetadataPid": integer, "programNumber": integer, "patInterval": integer, "pmtInterval": integer, "scte35Source": enum, "scte35Pid": integer, "nielsenId3": enum, "timedMetadata": enum, "timedMetadataPid": integer, "transportStreamId": integer, "videoPid": integer, "audioPids": [ integer ] }, "f4vSettings": { "moovPlacement": enum }, "m2tsSettings": { "audioBufferModel": enum, "minEbpInterval": integer, "esRateInPes": enum, "patInterval": integer, "dvbNitSettings": { "nitInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "scte35Source": enum, "scte35Pid": integer, "scte35Esam": { "scte35EsamPid": integer }, "videoPid": integer, "dvbTdtSettings": { "tdtInterval": integer }, "pmtInterval": integer, "segmentationStyle": enum, "segmentationTime": number, "pmtPid": integer, "bitrate": integer, "audioPids": [ integer ], "privateMetadataPid": integer, "nielsenId3": enum, "timedMetadataPid": integer, "maxPcrInterval": integer, "transportStreamId": integer, "dvbSubPids": [ integer ], "rateMode": enum, "audioFramesPerPes": integer, "pcrControl": enum, "segmentationMarkers": enum, "ebpAudioInterval": enum, "forceTsVideoEbpOrder": enum, "programNumber": integer, "pcrPid": integer, "bufferModel": enum, "dvbTeletextPid": integer, "fragmentTime": number, "ebpPlacement": enum, "nullPacketBitrate": number }, "movSettings": { "clapAtom": enum, "cslgAtom": enum, "paddingControl": enum, "reference": enum, "mpeg2FourCCControl": enum }, "mp4Settings": { "cslgAtom": enum, "freeSpaceBox": enum, "mp4MajorBrand": "string", "moovPlacement": enum }, "mpdSettings": { "captionContainerType": enum, "scte35Source": enum, "scte35Esam": enum } }, "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, "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 } }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ] }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer }, "temporalFilterSettings": { "strength": integer, "speed": integer, "aggressiveMode": integer } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "entropyEncoding": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum }, "h265Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "alternateTransferFunctionSei": enum, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "tiles": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "temporalIds": enum, "sampleAdaptiveOffsetFilterMode": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum }, "mpeg2Settings": { "interlaceMode": enum, "parNumerator": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "bitrate": integer, "intraDcPrecision": enum, "framerateControl": enum, "rateControlMode": enum, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "dynamicSubGop": enum }, "proresSettings": { "interlaceMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum } }, "afdSignaling": enum, "dropFrameTimecode": enum, "respondToAfd": enum, "colorMetadata": enum }, "audioDescriptions": [ { "audioTypeControl": enum, "audioSourceName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "correctionGateLevel": integer, "loudnessLogging": enum, "targetLkfs": number, "peakCalculation": enum }, "codecSettings": { "codec": enum, "aacSettings": { "audioDescriptionBroadcasterMix": enum, "vbrQuality": enum, "bitrate": integer, "rateControlMode": enum, "codecProfile": enum, "codingMode": enum, "rawFormat": enum, "sampleRate": integer, "specification": enum }, "ac3Settings": { "bitrate": integer, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "dynamicRangeCompressionProfile": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "eac3AtmosSettings": { "surroundExMode": enum, "loRoSurroundMixLevel": number, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "loRoCenterMixLevel": number, "codingMode": enum, "bitstreamMode": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "meteringMode": enum, "dialogueIntelligence": enum, "speechThreshold": integer }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer, "channelsOut": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "outputSettings": { "hlsSettings": { "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": 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, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "dvbSubDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer, "subtitlingType": enum }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string", "pageTypes": [ enum ] }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "imscDestinationSettings": { "stylePassthrough": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": integer, "destination708ServiceNumber": integer } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } ], "outputGroupSettings": { "type": enum, "hlsGroupSettings": { "manifestDurationFormat": enum, "segmentLength": integer, "timedMetadataId3Period": integer, "captionLanguageSetting": enum, "captionLanguageMappings": [ { "captionChannel": integer, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ], "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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, "streamInfResolution": enum }, "dashIsoGroupSettings": { "segmentLength": integer, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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, "mpdProfile": enum, "hbbtvCompliance": enum, "writeSegmentTimelineInRepresentation": enum }, "fileGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string" }, "accessControl": { "cannedAcl": enum } } } }, "msSmoothGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string" }, "accessControl": { "cannedAcl": enum } } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "fragmentLength": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string" } }, "manifestEncoding": enum, "audioDeduplication": enum }, "cmafGroupSettings": { "writeHlsManifest": enum, "writeDashManifest": enum, "segmentLength": integer, "minFinalSegmentLength": number, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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, "mpdProfile": enum, "manifestDurationFormat": enum, "streamInfResolution": enum, "clientCache": enum, "manifestCompression": enum, "codecSpecification": enum } } } ], "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 }, "inputs": [ { "inputClippings": [ { "endTimecode": "string", "startTimecode": "string" } ], "audioSelectors": { }, "audioSelectorGroups": { }, "programNumber": integer, "videoSelector": { "colorSpace": enum, "rotate": enum, "pid": integer, "programNumber": integer, "alphaBehavior": enum, "colorSpaceUsage": 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, "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 } ] }, "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 } }
Example UpdateJobTemplateResponse
{ "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, "pcrPid": integer, "pmtPid": integer, "privateMetadataPid": integer, "programNumber": integer, "patInterval": integer, "pmtInterval": integer, "scte35Source": enum, "scte35Pid": integer, "nielsenId3": enum, "timedMetadata": enum, "timedMetadataPid": integer, "transportStreamId": integer, "videoPid": integer, "audioPids": [ integer ] }, "f4vSettings": { "moovPlacement": enum }, "m2tsSettings": { "audioBufferModel": enum, "minEbpInterval": integer, "esRateInPes": enum, "patInterval": integer, "dvbNitSettings": { "nitInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "scte35Source": enum, "scte35Pid": integer, "scte35Esam": { "scte35EsamPid": integer }, "videoPid": integer, "dvbTdtSettings": { "tdtInterval": integer }, "pmtInterval": integer, "segmentationStyle": enum, "segmentationTime": number, "pmtPid": integer, "bitrate": integer, "audioPids": [ integer ], "privateMetadataPid": integer, "nielsenId3": enum, "timedMetadataPid": integer, "maxPcrInterval": integer, "transportStreamId": integer, "dvbSubPids": [ integer ], "rateMode": enum, "audioFramesPerPes": integer, "pcrControl": enum, "segmentationMarkers": enum, "ebpAudioInterval": enum, "forceTsVideoEbpOrder": enum, "programNumber": integer, "pcrPid": integer, "bufferModel": enum, "dvbTeletextPid": integer, "fragmentTime": number, "ebpPlacement": enum, "nullPacketBitrate": number }, "movSettings": { "clapAtom": enum, "cslgAtom": enum, "paddingControl": enum, "reference": enum, "mpeg2FourCCControl": enum }, "mp4Settings": { "cslgAtom": enum, "freeSpaceBox": enum, "mp4MajorBrand": "string", "moovPlacement": enum }, "mpdSettings": { "captionContainerType": enum, "scte35Source": enum, "scte35Esam": enum } }, "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, "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 } }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ] }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer }, "temporalFilterSettings": { "strength": integer, "speed": integer, "aggressiveMode": integer } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "entropyEncoding": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum }, "h265Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "alternateTransferFunctionSei": enum, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "tiles": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "temporalIds": enum, "sampleAdaptiveOffsetFilterMode": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum }, "mpeg2Settings": { "interlaceMode": enum, "parNumerator": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "bitrate": integer, "intraDcPrecision": enum, "framerateControl": enum, "rateControlMode": enum, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "dynamicSubGop": enum }, "proresSettings": { "interlaceMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum } }, "afdSignaling": enum, "dropFrameTimecode": enum, "respondToAfd": enum, "colorMetadata": enum }, "audioDescriptions": [ { "audioTypeControl": enum, "audioSourceName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "correctionGateLevel": integer, "loudnessLogging": enum, "targetLkfs": number, "peakCalculation": enum }, "codecSettings": { "codec": enum, "aacSettings": { "audioDescriptionBroadcasterMix": enum, "vbrQuality": enum, "bitrate": integer, "rateControlMode": enum, "codecProfile": enum, "codingMode": enum, "rawFormat": enum, "sampleRate": integer, "specification": enum }, "ac3Settings": { "bitrate": integer, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "dynamicRangeCompressionProfile": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "eac3AtmosSettings": { "surroundExMode": enum, "loRoSurroundMixLevel": number, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "loRoCenterMixLevel": number, "codingMode": enum, "bitstreamMode": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "meteringMode": enum, "dialogueIntelligence": enum, "speechThreshold": integer }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer, "channelsOut": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "outputSettings": { "hlsSettings": { "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": 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, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer }, "dvbSubDestinationSettings": { "backgroundOpacity": integer, "shadowXOffset": integer, "teletextSpacing": enum, "alignment": enum, "outlineSize": integer, "yPosition": integer, "shadowColor": enum, "fontOpacity": integer, "fontSize": integer, "fontScript": enum, "fontColor": enum, "backgroundColor": enum, "fontResolution": integer, "outlineColor": enum, "shadowYOffset": integer, "xPosition": integer, "shadowOpacity": integer, "subtitlingType": enum }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string", "pageTypes": [ enum ] }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "imscDestinationSettings": { "stylePassthrough": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": integer, "destination708ServiceNumber": integer } }, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ] } ], "outputGroupSettings": { "type": enum, "hlsGroupSettings": { "manifestDurationFormat": enum, "segmentLength": integer, "timedMetadataId3Period": integer, "captionLanguageSetting": enum, "captionLanguageMappings": [ { "captionChannel": integer, "customLanguageCode": "string", "languageCode": enum, "languageDescription": "string" } ], "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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, "streamInfResolution": enum }, "dashIsoGroupSettings": { "segmentLength": integer, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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, "mpdProfile": enum, "hbbtvCompliance": enum, "writeSegmentTimelineInRepresentation": enum }, "fileGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string" }, "accessControl": { "cannedAcl": enum } } } }, "msSmoothGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string" }, "accessControl": { "cannedAcl": enum } } }, "additionalManifests": [ { "manifestNameModifier": "string", "selectedOutputs": [ "string" ] } ], "fragmentLength": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string" } }, "manifestEncoding": enum, "audioDeduplication": enum }, "cmafGroupSettings": { "writeHlsManifest": enum, "writeDashManifest": enum, "segmentLength": integer, "minFinalSegmentLength": number, "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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, "mpdProfile": enum, "manifestDurationFormat": enum, "streamInfResolution": enum, "clientCache": enum, "manifestCompression": enum, "codecSpecification": enum } } } ], "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 }, "inputs": [ { "inputClippings": [ { "endTimecode": "string", "startTimecode": "string" } ], "audioSelectors": { }, "audioSelectorGroups": { }, "programNumber": integer, "videoSelector": { "colorSpace": enum, "rotate": enum, "pid": integer, "programNumber": integer, "alphaBehavior": enum, "colorSpaceUsage": 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, "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 } ] }, "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 } }
Example DeleteJobTemplateResponse
{ }
Example ExceptionBody
{ "message": "string" }
Properties
AacAudioDescriptionBroadcasterMix
Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType.
-
BROADCASTER_MIXED_AD
-
NORMAL
AacCodecProfile
AAC Profile.
-
LC
-
HEV1
-
HEV2
AacCodingMode
Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. "1.0 - Audio Description (Receiver Mix)" setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.
-
AD_RECEIVER_MIX
-
CODING_MODE_1_0
-
CODING_MODE_1_1
-
CODING_MODE_2_0
-
CODING_MODE_5_1
AacRateControlMode
Rate Control Mode.
-
CBR
-
VBR
AacRawFormat
Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose "No container" for the output container.
-
LATM_LOAS
-
NONE
AacSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode (rateControlMode) to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the rate control mode.
AacSpecification
Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
-
MPEG2
-
MPEG4
AacVbrQuality
VBR Quality Level - Only used if rate_control_mode is VBR.
-
LOW
-
MEDIUM_LOW
-
MEDIUM_HIGH
-
HIGH
Ac3BitstreamMode
Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).
-
COMPLETE_MAIN
-
COMMENTARY
-
DIALOGUE
-
EMERGENCY
-
HEARING_IMPAIRED
-
MUSIC_AND_EFFECTS
-
VISUALLY_IMPAIRED
-
VOICE_OVER
Ac3CodingMode
Dolby Digital coding mode. Determines number of channels.
-
CODING_MODE_1_0
-
CODING_MODE_1_1
-
CODING_MODE_2_0
-
CODING_MODE_3_2_LFE
Ac3DynamicRangeCompressionProfile
If set to FILM_STANDARD, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
-
FILM_STANDARD
-
NONE
Ac3LfeFilter
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.
-
ENABLED
-
DISABLED
Ac3MetadataControl
When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
-
FOLLOW_INPUT
-
USE_CONFIGURED
Ac3Settings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3.
AccelerationMode
Specify whether the service runs your job with accelerated transcoding. Choose DISABLED if you don't want accelerated transcoding. Choose ENABLED if you want your job to run with accelerated transcoding and to fail if your input files or your job settings aren't compatible with accelerated transcoding. Choose PREFERRED if you want your job to run with accelerated transcoding if the job is compatible with the feature and to run at standard speed if it's not.
-
DISABLED
-
ENABLED
-
PREFERRED
AccelerationSettings
Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.
AfdSignaling
This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.
-
NONE
-
AUTO
-
FIXED
AiffSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF.
AlphaBehavior
Ignore this setting unless this input is a QuickTime animation. Specify which part of this input MediaConvert uses for your outputs. Leave this setting set to DISCARD in order to delete the alpha channel and preserve the video. Use REMAP_TO_LUMA for this setting to delete the video and map the alpha channel to the luma channel of your outputs.
-
DISCARD
-
REMAP_TO_LUMA
AncillaryConvert608To708
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.
-
UPCONVERT
-
DISABLED
AncillarySourceSettings
Settings for ancillary captions source.
AncillaryTerminateCaptions
By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.
-
END_OF_INPUT
-
DISABLED
AntiAlias
The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.
-
DISABLED
-
ENABLED
AudioCodec
Type of Audio codec.
-
AAC
-
MP2
-
WAV
-
AIFF
-
AC3
-
EAC3
-
EAC3_ATMOS
-
PASSTHROUGH
AudioCodecSettings
Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings
AudioDefaultSelection
Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.
-
DEFAULT
-
NOT_DEFAULT
AudioDescription
Description of audio output
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.
-
LOG
-
DONT_LOG
AudioNormalizationPeakCalculation
If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.
-
TRUE_PEAK
-
NONE
AudioNormalizationSettings
Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.
AudioSelector
Selector for Audio
AudioSelectorGroup
Group of Audio Selectors
AudioSelectorType
Specifies the type of the audio selector.
-
PID
-
TRACK
-
LANGUAGE_CODE
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
AvailBlanking
Settings for Avail Blanking
BurninDestinationSettings
Burn-In Destination Settings.
BurninSubtitleAlignment
If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
CENTERED
-
LEFT
BurninSubtitleBackgroundColor
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
-
NONE
-
BLACK
-
WHITE
BurninSubtitleFontColor
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
WHITE
-
BLACK
-
YELLOW
-
RED
-
GREEN
-
BLUE
BurninSubtitleOutlineColor
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
BLACK
-
WHITE
-
YELLOW
-
RED
-
GREEN
-
BLUE
BurninSubtitleShadowColor
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
-
NONE
-
BLACK
-
WHITE
BurninSubtitleTeletextSpacing
Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.
-
FIXED_GRID
-
PROPORTIONAL
CaptionDescription
Description of Caption output
CaptionDestinationSettings
Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.
CaptionDestinationType
Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).
-
BURN_IN
-
DVB_SUB
-
EMBEDDED
-
EMBEDDED_PLUS_SCTE20
-
IMSC
-
SCTE20_PLUS_EMBEDDED
-
SCC
-
SRT
-
SMI
-
TELETEXT
-
TTML
-
WEBVTT
CaptionSelector
Set up captions in your outputs by first selecting them from your input here.
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.
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
-
TELETEXT
-
NULL_SOURCE
-
IMSC
ChannelMapping
Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification).
| Property | Type | Required | Description |
|---|---|---|---|
outputChannels |
Array of type OutputChannelMapping |
False |
List of output channels |
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.
CmafClientCache
When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.
-
DISABLED
-
ENABLED
CmafCodecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
-
RFC_6381
-
RFC_4281
CmafEncryptionSettings
Settings for CMAF encryption
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).
-
SAMPLE_AES
-
AES_CTR
CmafGroupSettings
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output.
| Property | Type | Required | Description |
|---|---|---|---|
writeHlsManifest |
False |
When set to ENABLED, an Apple HLS manifest will be generated for this output. |
|
writeDashManifest |
False |
When set to ENABLED, a DASH MPD manifest will be generated for this output. |
|
segmentLength |
integer Minimum: 1 Maximum: 2147483647 |
False |
Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment. |
minFinalSegmentLength |
number Format: float Minimum: 0.0 Maximum: 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. |
destination |
string Pattern: |
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 |
False |
Settings associated with the destination. Will vary based on the type of destination |
|
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. |
encryption |
False |
DRM settings. |
|
minBufferTime |
integer Minimum: 0 Maximum: 2147483647 |
False |
Minimum time of initially buffered media that is needed to ensure smooth playout. |
fragmentLength |
integer Minimum: 1 Maximum: 2147483647 |
False |
Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types. |
baseUrl |
string |
False |
A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file. |
segmentControl |
False |
When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created. |
|
mpdProfile |
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). |
|
manifestDurationFormat |
False |
Indicates whether the output manifest should use floating point values for segment duration. |
|
streamInfResolution |
False |
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. |
|
clientCache |
False |
When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay. |
|
manifestCompression |
False |
When set to GZIP, compresses HLS playlist. |
|
codecSpecification |
False |
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. |
CmafInitializationVectorInManifest
When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.
-
INCLUDE
-
EXCLUDE
CmafKeyProviderType
Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.
-
SPEKE
-
STATIC_KEY
CmafManifestCompression
When set to GZIP, compresses HLS playlist.
-
GZIP
-
NONE
CmafManifestDurationFormat
Indicates whether the output manifest should use floating point values for segment duration.
-
FLOATING_POINT
-
INTEGER
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
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
CmafStreamInfResolution
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
-
INCLUDE
-
EXCLUDE
CmafWriteDASHManifest
When set to ENABLED, a DASH MPD manifest will be generated for this output.
-
DISABLED
-
ENABLED
CmafWriteHLSManifest
When set to ENABLED, an Apple HLS manifest will be generated for this output.
-
DISABLED
-
ENABLED
ColorCorrector
Settings for color correction.
ColorMetadata
Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.
-
IGNORE
-
INSERT
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, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output.
-
NONE
-
FORCE_601
-
FORCE_709
-
FORCE_HDR10
-
FORCE_HLG_2020
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.
-
FORCE
-
FALLBACK
ContainerSettings
Container specific settings.
ContainerType
Container for this output. Some containers require a container settings object. If not specified, the default object will be created.
-
F4V
-
ISMV
-
M2TS
-
M3U8
-
CMFC
-
MOV
-
MP4
-
MPD
-
MXF
-
RAW
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.
DashIsoEncryptionSettings
Specifies DRM settings for DASH outputs.
DashIsoGroupSettings
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS.
| Property | Type | Required | Description |
|---|---|---|---|
segmentLength |
integer Minimum: 1 Maximum: 2147483647 |
False |
Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types. |
destination |
string Pattern: |
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 |
False |
Settings associated with the destination. Will vary based on the type of destination |
|
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. |
encryption |
False |
DRM settings. |
|
minBufferTime |
integer Minimum: 0 Maximum: 2147483647 |
False |
Minimum time of initially buffered media that is needed to ensure smooth playout. |
fragmentLength |
integer Minimum: 1 Maximum: 2147483647 |
False |
Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types. |
baseUrl |
string |
False |
A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file. |
segmentControl |
False |
When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created. |
|
mpdProfile |
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). |
|
hbbtvCompliance |
False |
Supports HbbTV specification as indicated |
|
writeSegmentTimelineInRepresentation |
False |
If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest. |
DashIsoHbbtvCompliance
Supports HbbTV specification as indicated
-
HBBTV_1_5
-
NONE
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.
-
CENC_V1
-
UNENCRYPTED_SEI
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
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.
-
ENABLED
-
DISABLED
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
DeinterlacerControl
- When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video.
-
FORCE_ALL_FRAMES
-
NORMAL
DeinterlacerMode
Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive.
-
DEINTERLACE
-
INVERSE_TELECINE
-
ADAPTIVE
DeleteJobTemplateRequest
Delete a job template by sending a request with the job template name
DeleteJobTemplateResponse
Delete job template requests will return an OK message or error message with an empty body.
DestinationSettings
Settings associated with the destination. Will vary based on the type of destination
DolbyVision
Settings for Dolby Vision
DolbyVisionLevel6Metadata
Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the MaxCLL and MaxFALL values in your input with new values.
DolbyVisionLevel6Mode
Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL and MaxFALL properies.
-
PASSTHROUGH
-
RECALCULATE
-
SPECIFY
DolbyVisionProfile
In the current MediaConvert implementation, the Dolby Vision profile is always 5 (PROFILE_5). Therefore, all of your inputs must contain Dolby Vision frame interleaved data.
-
PROFILE_5
DropFrameTimecode
Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.
-
DISABLED
-
ENABLED
DvbNitSettings
Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
DvbSdtSettings
Inserts DVB Service Description Table (NIT) at the specified table repetition interval.
DvbSubDestinationSettings
DVB-Sub Destination Settings
DvbSubSourceSettings
DVB Sub Source Settings
DvbSubtitleAlignment
If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
CENTERED
-
LEFT
DvbSubtitleBackgroundColor
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
-
NONE
-
BLACK
-
WHITE
DvbSubtitleFontColor
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
WHITE
-
BLACK
-
YELLOW
-
RED
-
GREEN
-
BLUE
DvbSubtitleOutlineColor
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
BLACK
-
WHITE
-
YELLOW
-
RED
-
GREEN
-
BLUE
DvbSubtitleShadowColor
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
-
NONE
-
BLACK
-
WHITE
DvbSubtitleTeletextSpacing
Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.
-
FIXED_GRID
-
PROPORTIONAL
DvbSubtitlingType
Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.
-
HEARING_IMPAIRED
-
STANDARD
DvbTdtSettings
Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
Eac3AtmosBitstreamMode
Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).
-
COMPLETE_MAIN
Eac3AtmosCodingMode
The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).
-
CODING_MODE_9_1_6
Eac3AtmosDialogueIntelligence
Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.
-
ENABLED
-
DISABLED
Eac3AtmosDynamicRangeCompressionLine
Specify the absolute peak level for a signal with dynamic range compression.
-
NONE
-
FILM_STANDARD
-
FILM_LIGHT
-
MUSIC_STANDARD
-
MUSIC_LIGHT
-
SPEECH
Eac3AtmosDynamicRangeCompressionRf
Specify how the service limits the audio dynamic range when compressing the audio.
-
NONE
-
FILM_STANDARD
-
FILM_LIGHT
-
MUSIC_STANDARD
-
MUSIC_LIGHT
-
SPEECH
Eac3AtmosMeteringMode
Choose how the service meters the loudness of your audio.
-
LEQ_A
-
ITU_BS_1770_1
-
ITU_BS_1770_2
-
ITU_BS_1770_3
-
ITU_BS_1770_4
Eac3AtmosSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3_ATMOS.
Eac3AtmosStereoDownmix
Choose how the service does stereo downmixing.
-
NOT_INDICATED
-
STEREO
-
SURROUND
-
DPL2
Eac3AtmosSurroundExMode
Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.
-
NOT_INDICATED
-
ENABLED
-
DISABLED
Eac3AttenuationControl
If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
-
ATTENUATE_3_DB
-
NONE
Eac3BitstreamMode
Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).
-
COMPLETE_MAIN
-
COMMENTARY
-
EMERGENCY
-
HEARING_IMPAIRED
-
VISUALLY_IMPAIRED
Eac3CodingMode
Dolby Digital Plus coding mode. Determines number of channels.
-
CODING_MODE_1_0
-
CODING_MODE_2_0
-
CODING_MODE_3_2
Eac3DcFilter
Activates a DC highpass filter for all input channels.
-
ENABLED
-
DISABLED
Eac3DynamicRangeCompressionLine
Specify the absolute peak level for a signal with dynamic range compression.
-
NONE
-
FILM_STANDARD
-
FILM_LIGHT
-
MUSIC_STANDARD
-
MUSIC_LIGHT
-
SPEECH
Eac3DynamicRangeCompressionRf
Specify how the service limits the audio dynamic range when compressing the audio.
-
NONE
-
FILM_STANDARD
-
FILM_LIGHT
-
MUSIC_STANDARD
-
MUSIC_LIGHT
-
SPEECH
Eac3LfeControl
When encoding 3/2 audio, controls whether the LFE channel is enabled
-
LFE
-
NO_LFE
Eac3LfeFilter
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.
-
ENABLED
-
DISABLED
Eac3MetadataControl
When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
-
FOLLOW_INPUT
-
USE_CONFIGURED
Eac3PassthroughControl
When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
-
WHEN_POSSIBLE
-
NO_PASSTHROUGH
Eac3PhaseControl
Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode.
-
SHIFT_90_DEGREES
-
NO_SHIFT
Eac3Settings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.
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.
-
UPCONVERT
-
DISABLED
EmbeddedDestinationSettings
Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.
EmbeddedSourceSettings
Settings for embedded captions Source
EmbeddedTerminateCaptions
By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.
-
END_OF_INPUT
-
DISABLED
EsamManifestConfirmConditionNotification
ESAM ManifestConfirmConditionNotification defined by OC-SP-ESAM-API-I03-131025.
EsamSettings
Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
EsamSignalProcessingNotification
ESAM SignalProcessingNotification data defined by OC-SP-ESAM-API-I03-131025.
ExceptionBody
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
FileGroupSettings
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILE_GROUP_SETTINGS.
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.
-
UPCONVERT
-
DISABLED
FileSourceSettings
If your input captions are SCC, SMI, SRT, STL, TTML, 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.
FontScript
Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset.
-
AUTOMATIC
-
HANS
-
HANT
FrameCaptureSettings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.
GetJobTemplateRequest
Query a job template by sending a request with the job template name.
GetJobTemplateResponse
Successful get job template requests will return an OK message and the job template JSON.
H264AdaptiveQuantization
Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
-
OFF
-
LOW
-
MEDIUM
-
HIGH
-
HIGHER
-
MAX
H264CodecLevel
Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO).
-
AUTO
-
LEVEL_1
-
LEVEL_1_1
-
LEVEL_1_2
-
LEVEL_1_3
-
LEVEL_2
-
LEVEL_2_1
-
LEVEL_2_2
-
LEVEL_3
-
LEVEL_3_1
-
LEVEL_3_2
-
LEVEL_4
-
LEVEL_4_1
-
LEVEL_4_2
-
LEVEL_5
-
LEVEL_5_1
-
LEVEL_5_2
H264CodecProfile
H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.
-
BASELINE
-
HIGH
-
HIGH_10BIT
-
HIGH_422
-
HIGH_422_10BIT
-
MAIN
H264DynamicSubGop
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).
-
ADAPTIVE
-
STATIC
H264EntropyEncoding
Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC.
-
CABAC
-
CAVLC
H264FieldEncoding
Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.
-
PAFF
-
FORCE_FIELD
H264FlickerAdaptiveQuantization
Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
-
DISABLED
-
ENABLED
H264FramerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.
-
INITIALIZE_FROM_SOURCE
-
SPECIFIED
H264FramerateConversionAlgorithm
When set to INTERPOLATE, produces smoother motion during frame rate conversion.
-
DUPLICATE_DROP
-
INTERPOLATE
H264GopBReference
If enable, use reference B frames for GOP structures that have B frames > 1.
-
DISABLED
-
ENABLED
H264GopSizeUnits
Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.
-
FRAMES
-
SECONDS
H264InterlaceMode
Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type, as follows. - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of "top field first" and "bottom field first". - If the source is progressive, the output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the Follow options you chose.
-
PROGRESSIVE
-
TOP_FIELD
-
BOTTOM_FIELD
-
FOLLOW_TOP_FIELD
-
FOLLOW_BOTTOM_FIELD
H264ParControl
Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio.
-
INITIALIZE_FROM_SOURCE
-
SPECIFIED
H264QualityTuningLevel
Use Quality tuning level (H264QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding.
-
SINGLE_PASS
-
SINGLE_PASS_HQ
-
MULTI_PASS_HQ
H264QvbrSettings
Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.
H264RateControlMode
Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).
-
VBR
-
CBR
-
QVBR
H264RepeatPps
Places a PPS header on each encoded picture, even if repeated.
-
DISABLED
-
ENABLED
H264SceneChangeDetect
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.
-
DISABLED
-
ENABLED
-
TRANSITION_DETECTION
H264Settings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.
H264SlowPal
Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.
-
DISABLED
-
ENABLED
H264SpatialAdaptiveQuantization
Adjust quantization within each frame based on spatial variation of content complexity.
-
DISABLED
-
ENABLED
H264Syntax
Produces a bitstream compliant with SMPTE RP-2027.
-
DEFAULT
-
RP2027
H264Telecine
This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.
-
NONE
-
SOFT
-
HARD
H264TemporalAdaptiveQuantization
Adjust quantization within each frame based on temporal variation of content complexity.
-
DISABLED
-
ENABLED
H264UnregisteredSeiTimecode
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.
-
DISABLED
-
ENABLED
H265AdaptiveQuantization
Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
-
OFF
-
LOW
-
MEDIUM
-
HIGH
-
HIGHER
-
MAX
H265AlternateTransferFunctionSei
Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF).
-
DISABLED
-
ENABLED
H265CodecLevel
H.265 Level.
-
AUTO
-
LEVEL_1
-
LEVEL_2
-
LEVEL_2_1
-
LEVEL_3
-
LEVEL_3_1
-
LEVEL_4
-
LEVEL_4_1
-
LEVEL_5
-
LEVEL_5_1
-
LEVEL_5_2
-
LEVEL_6
-
LEVEL_6_1
-
LEVEL_6_2
H265CodecProfile
Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so "Main/High" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License.
-
MAIN_MAIN
-
MAIN_HIGH
-
MAIN10_MAIN
-
MAIN10_HIGH
-
MAIN_422_8BIT_MAIN
-
MAIN_422_8BIT_HIGH
-
MAIN_422_10BIT_MAIN
-
MAIN_422_10BIT_HIGH
H265DynamicSubGop
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).
-
ADAPTIVE
-
STATIC
H265FlickerAdaptiveQuantization
Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
-
DISABLED
-
ENABLED
H265FramerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.
-
INITIALIZE_FROM_SOURCE
-
SPECIFIED
H265FramerateConversionAlgorithm
When set to INTERPOLATE, produces smoother motion during frame rate conversion.
-
DUPLICATE_DROP
-
INTERPOLATE
H265GopBReference
If enable, use reference B frames for GOP structures that have B frames > 1.
-
DISABLED
-
ENABLED
H265GopSizeUnits
Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.
-
FRAMES
-
SECONDS
H265InterlaceMode
Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of "top field first" and "bottom field first". If the source is progressive, your output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE).
-
PROGRESSIVE
-
TOP_FIELD
-
BOTTOM_FIELD
-
FOLLOW_TOP_FIELD
-
FOLLOW_BOTTOM_FIELD
H265ParControl
Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio.
-
INITIALIZE_FROM_SOURCE
-
SPECIFIED
H265QualityTuningLevel
Use Quality tuning level (H265QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding.
-
SINGLE_PASS
-
SINGLE_PASS_HQ
-
MULTI_PASS_HQ
H265QvbrSettings
Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.
H265RateControlMode
Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).
-
VBR
-
CBR
-
QVBR
H265SampleAdaptiveOffsetFilterMode
Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content
-
DEFAULT
-
ADAPTIVE
-
OFF
H265SceneChangeDetect
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.
-
DISABLED
-
ENABLED
-
TRANSITION_DETECTION
H265Settings
Settings for H265 codec
H265SlowPal
Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.
-
DISABLED
-
ENABLED
H265SpatialAdaptiveQuantization
Adjust quantization within each frame based on spatial variation of content complexity.
-
DISABLED
-
ENABLED
H265Telecine
This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.
-
NONE
-
SOFT
-
HARD
H265TemporalAdaptiveQuantization
Adjust quantization within each frame based on temporal variation of content complexity.
-
DISABLED
-
ENABLED
H265TemporalIds
Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame rate output.
-
DISABLED
-
ENABLED
H265Tiles
Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures.
-
DISABLED
-
ENABLED
H265UnregisteredSeiTimecode
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.
-
DISABLED
-
ENABLED
H265WriteMp4PackagingType
If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting only with CMAF or DASH outputs, or with standalone file outputs in an MPEG-4 container (MP4 outputs). Choose HVC1 to mark your output as HVC1. This makes your output compliant with the following specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. For MP4 outputs, when you choose HVC1, your output video might not work properly with some downstream systems and video players. The service defaults to marking your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples.
-
HVC1
-
HEV1
Hdr10Metadata
Use these settings to specify static color calibration metadata, as defined by SMPTE ST 2086. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator.
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.
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.
-
AUTOMATIC
-
M2TS
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
HlsCaptionLanguageSetting
Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.
-
INSERT
-
OMIT
-
NONE
HlsClientCache
When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.
-
DISABLED
-
ENABLED
HlsCodecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
-
RFC_6381
-
RFC_4281
HlsDirectoryStructure
Indicates whether segments should be placed in subdirectories.
-
SINGLE_DIRECTORY
-
SUBDIRECTORY_PER_STREAM
HlsEncryptionSettings
Settings for HLS encryption
HlsEncryptionType
Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.
-
AES128
-
SAMPLE_AES
HlsGroupSettings
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.
| Property | Type | Required | Description |
|---|---|---|---|
manifestDurationFormat |
False |
Indicates whether the output manifest should use floating point values for segment duration. |
|
segmentLength |
integer Minimum: 1 Maximum: 2147483647 |
False |
Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. |
timedMetadataId3Period |
integer Minimum: -2147483648 Maximum: 2147483647 |
False |
Timed Metadata interval in seconds. |
captionLanguageSetting |
False |
Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest. |
|
captionLanguageMappings |
Array of type HlsCaptionLanguageMapping |
False |
Language to be used on Caption outputs |
destination |
string Pattern: |
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 |
False |
Settings associated with the destination. Will vary based on the type of destination |
|
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. |
encryption |
False |
DRM settings. |
|
timedMetadataId3Frame |
False |
Indicates ID3 frame that has the timecode. |
|
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. |
codecSpecification |
False |
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. |
|
outputSelection |
False |
Indicates whether the .m3u8 manifest file should be generated for this HLS output group. |
|
programDateTimePeriod |
integer Minimum: 0 Maximum: 3600 |
False |
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. |
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. |
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. |
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. |
directoryStructure |
False |
Indicates whether segments should be placed in subdirectories. |
|
programDateTime |
False |
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset. |
|
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. |
segmentControl |
False |
When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback. |
|
timestampDeltaMilliseconds |
integer Minimum: -2147483648 Maximum: 2147483647 |
False |
Provides an extra millisecond delta offset to fine tune the timestamps. |
manifestCompression |
False |
When set to GZIP, compresses HLS playlist. |
|
clientCache |
False |
When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay. |
|
streamInfResolution |
False |
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. |
HlsIFrameOnlyManifest
When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest
-
INCLUDE
-
EXCLUDE
HlsInitializationVectorInManifest
The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.
-
INCLUDE
-
EXCLUDE
HlsKeyProviderType
Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.
-
SPEKE
-
STATIC_KEY
HlsManifestCompression
When set to GZIP, compresses HLS playlist.
-
GZIP
-
NONE
HlsManifestDurationFormat
Indicates whether the output manifest should use floating point values for segment duration.
-
FLOATING_POINT
-
INTEGER
HlsOfflineEncrypted
Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.
-
ENABLED
-
DISABLED
HlsOutputSelection
Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
-
MANIFESTS_AND_SEGMENTS
-
SEGMENTS_ONLY
HlsProgramDateTime
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.
-
INCLUDE
-
EXCLUDE
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
HlsSettings
Settings for HLS output groups
HlsStreamInfResolution
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
-
INCLUDE
-
EXCLUDE
HlsTimedMetadataId3Frame
Indicates ID3 frame that has the timecode.
-
NONE
-
PRIV
-
TDRL
Id3Insertion
To insert ID3 tags in your output, specify two values. Use ID3 tag (Id3) to specify the base 64 encoded string and use Timecode (TimeCode) to specify the time when the tag should be inserted. To insert multiple ID3 tags in your output, create multiple instances of ID3 insertion (Id3Insertion).
ImageInserter
Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input or output individually. This setting is disabled by default.
| Property | Type | Required | Description |
|---|---|---|---|
insertableImages |
Array of type InsertableImage |
False |
Specify the images that you want to overlay on your video. The images must be PNG or TGA files. |
ImscDestinationSettings
Settings specific to IMSC caption outputs.
ImscStylePassthrough
Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are CFF-TT, IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions.
-
ENABLED
-
DISABLED
InputClipping
To transcode only portions of your input (clips), include one Input clipping (one instance of InputClipping in the JSON job file) for each input clip. All input clips you specify will be included in every output of the job.
InputDeblockFilter
Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully controllable for MPEG2 and uncompressed video inputs.
-
ENABLED
-
DISABLED
InputDenoiseFilter
Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.
-
ENABLED
-
DISABLED
InputFilterEnable
Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type.
-
AUTO
-
DISABLE
-
FORCE
InputPsiControl
Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.
-
IGNORE_PSI
-
USE_PSI
InputRotate
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
InputTemplate
Specified video input in a template.
| Property | Type | Required | Description |
|---|---|---|---|
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. |
audioSelectors |
object |
False |
Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use mutiple Audio selectors per input. |
audioSelectorGroups |
object |
False |
Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See "Audio Selector Group":#inputs-audio_selector_group for more information. |
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. |
videoSelector |
False |
Selector for video. |
|
filterEnable |
False |
Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type. |
|
psiControl |
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. |
|
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. |
deblockFilter |
False |
Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully controllable for MPEG2 and uncompressed video inputs. |
|
denoiseFilter |
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. |
|
timecodeSource |
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: 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. |
captionSelectors |
object |
False |
Use Captions selectors (CaptionSelectors) to specify the captions data from the input that you will use in your outputs. You can use mutiple captions selectors per input. |
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. |
|
crop |
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). |
|
position |
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). |
InputTimecodeSource
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
Settings that specify how your still graphic overlay appears.
JobTemplate
A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
JobTemplateSettings
JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
| Property | Type | Required | Description |
|---|---|---|---|
timecodeConfig |
False |
Contains settings used to acquire and adjust timecode information from inputs. |
|
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 |
adAvailOffset |
integer Minimum: -1000 Maximum: 1000 |
False |
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. |
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. |
|
timedMetadataInsertion |
False |
Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects. |
|
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. |
|
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. |
|
esam |
False |
Settings for Event Signaling And Messaging (ESAM). |
|
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. |
LanguageCode
Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php.
-
ENG
-
SPA
-
FRA
-
DEU
-
GER
-
ZHO
-
ARA
-
HIN
-
JPN
-
RUS
-
POR
-
ITA
-
URD
-
VIE
-
KOR
-
PAN
-
ABK
-
AAR
-
AFR
-
AKA
-
SQI
-
AMH
-
ARG
-
HYE
-
ASM
-
AVA
-
AVE
-
AYM
-
AZE
-
BAM
-
BAK
-
EUS
-
BEL
-
BEN
-
BIH
-
BIS
-
BOS
-
BRE
-
BUL
-
MYA
-
CAT
-
KHM
-
CHA
-
CHE
-
NYA
-
CHU
-
CHV
-
COR
-
COS
-
CRE
-
HRV
-
CES
-
DAN
-
DIV
-
NLD
-
DZO
-
ENM
-
EPO
-
EST
-
EWE
-
FAO
-
FIJ
-
FIN
-
FRM
-
FUL
-
GLA
-
GLG
-
LUG
-
KAT
-
ELL
-
GRN
-
GUJ
-
HAT
-
HAU
-
HEB
-
HER
-
HMO
-
HUN
-
ISL
-
IDO
-
IBO
-
IND
-
INA
-
ILE
-
IKU
-
IPK
-
GLE
-
JAV
-
KAL
-
KAN
-
KAU
-
KAS
-
KAZ
-
KIK
-
KIN
-
KIR
-
KOM
-
KON
-
KUA
-
KUR
-
LAO
-
LAT
-
LAV
-
LIM
-
LIN
-
LIT
-
LUB
-
LTZ
-
MKD
-
MLG
-
MSA
-
MAL
-
MLT
-
GLV
-
MRI
-
MAR
-
MAH
-
MON
-
NAU
-
NAV
-
NDE
-
NBL
-
NDO
-
NEP
-
SME
-
NOR
-
NOB
-
NNO
-
OCI
-
OJI
-
ORI
-
ORM
-
OSS
-
PLI
-
FAS
-
POL
-
PUS
-
QUE
-
QAA
-
RON
-
ROH
-
RUN
-
SMO
-
SAG
-
SAN
-
SRD
-
SRB
-
SNA
-
III
-
SND
-
SIN
-
SLK
-
SLV
-
SOM
-
SOT
-
SUN
-
SWA
-
SSW
-
SWE
-
TGL
-
TAH
-
TGK
-
TAM
-
TAT
-
TEL
-
THA
-
BOD
-
TIR
-
TON
-
TSO
-
TSN
-
TUR
-
TUK
-
TWI
-
UIG
-
UKR
-
UZB
-
VEN
-
VOL
-
WLN
-
CYM
-
FRY
-
WOL
-
XHO
-
YID
-
YOR
-
ZHA
-
ZUL
-
ORJ
-
QPC
-
TNG
M2tsAudioBufferModel
Selects between the DVB and ATSC buffer models for Dolby Digital audio.
-
DVB
-
ATSC
M2tsBufferModel
Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.
-
MULTIPLEX
-
NONE
M2tsEbpAudioInterval
When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).
-
VIDEO_AND_FIXED_INTERVALS
-
VIDEO_INTERVAL
M2tsEbpPlacement
Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).
-
VIDEO_AND_AUDIO_PIDS
-
VIDEO_PID
M2tsEsRateInPes
Controls whether to include the ES Rate field in the PES header.
-
INCLUDE
-
EXCLUDE
M2tsForceTsVideoEbpOrder
Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE).
-
FORCE
-
DEFAULT
M2tsNielsenId3
If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
-
INSERT
-
NONE
M2tsPcrControl
When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream.
-
PCR_EVERY_PES_PACKET
-
CONFIGURED_PCR_PERIOD
M2tsRateMode
When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.
-
VBR
-
CBR
M2tsScte35Esam
Settings for SCTE-35 signals from ESAM. Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).
M2tsScte35Source
For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).
-
PASSTHROUGH
-
NONE
M2tsSegmentationMarkers
Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
-
NONE
-
RAI_SEGSTART
-
RAI_ADAPT
-
PSI_SEGSTART
-
EBP
-
EBP_LEGACY
M2tsSegmentationStyle
The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "reset_cadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of "maintain_cadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.
-
MAINTAIN_CADENCE
-
RESET_CADENCE
M2tsSettings
MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.