AWS Elemental MediaConvert API Reference
API Reference

Jobs

URI

/2017-08-29/jobs

HTTP Methods

GET

Operation ID: ListJobs

Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.

Query Parameters

Name Type Required Description
status String False
nextToken String False
maxResults String False
order String False
queue String False

Responses

Status Code Response Model Description
200 ListJobsResponse

200 response

400 ExceptionBody

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

403 ExceptionBody

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

404 ExceptionBody

The resource you requested does not exist.

409 ExceptionBody

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

429 ExceptionBody

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

500 ExceptionBody

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

POST

Operation ID: CreateJob

Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Responses

Status Code Response Model Description
201 CreateJobResponse

201 response

400 ExceptionBody

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

403 ExceptionBody

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

404 ExceptionBody

The resource you requested does not exist.

409 ExceptionBody

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

429 ExceptionBody

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

500 ExceptionBody

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

Schemas

Request Bodies

Example GET

{ "queue": "string", "status": enum, "order": enum, "nextToken": "string", "maxResults": integer }

Example POST

{ "clientRequestToken": "string", "jobTemplate": "string", "queue": "string", "role": "string", "settings": { "timecodeConfig": { "anchor": "string", "source": enum, "start": "string", "timestampOffset": "string" }, "outputGroups": [ { "customName": "string", "name": "string", "outputs": [ { "containerSettings": { "container": enum, "m3u8Settings": { "audioFramesPerPes": integer, "pcrControl": enum, "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 } }, "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 }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ] }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "entropyEncoding": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum }, "h265Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "alternateTransferFunctionSei": enum, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "tiles": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "temporalIds": enum, "sampleAdaptiveOffsetFilterMode": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum }, "mpeg2Settings": { "interlaceMode": enum, "parNumerator": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "bitrate": integer, "intraDcPrecision": enum, "framerateControl": enum, "rateControlMode": enum, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "dynamicSubGop": enum }, "proresSettings": { "interlaceMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum } }, "afdSignaling": enum, "dropFrameTimecode": enum, "respondToAfd": enum, "colorMetadata": enum }, "audioDescriptions": [ { "audioTypeControl": enum, "audioSourceName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "correctionGateLevel": integer, "loudnessLogging": enum, "targetLkfs": number, "peakCalculation": enum }, "codecSettings": { "codec": enum, "aacSettings": { "audioDescriptionBroadcasterMix": enum, "vbrQuality": enum, "bitrate": integer, "rateControlMode": enum, "codecProfile": enum, "codingMode": enum, "rawFormat": enum, "sampleRate": integer, "specification": enum }, "ac3Settings": { "bitrate": integer, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "dynamicRangeCompressionProfile": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer, "channelsOut": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "outputSettings": { "hlsSettings": { "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": enum, "iFrameOnlyManifest": enum, "segmentModifier": "string" } }, "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 }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string" }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": 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" } } }, "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" } } }, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string" } }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": enum, "hbbtvCompliance": enum, "writeSegmentTimelineInRepresentation": enum }, "fileGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string" } } } }, "msSmoothGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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" } } }, "encryption": { "encryptionMethod": enum, "constantInitializationVector": "string", "initializationVectorInManifest": enum, "staticKeyProvider": { "staticKeyValue": "string", "keyFormat": "string", "keyFormatVersions": "string", "url": "string" }, "type": enum }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": 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, "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, "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 } ] }, "fileInput": "string", "decryptionSettings": { "decryptionMode": enum, "encryptedDecryptionKey": "string", "initializationVector": "string", "kmsKeyRegion": "string" }, "supplementalImps": [ "string" ] } ] }, "userMetadata": { }, "billingTagsSource": enum, "accelerationSettings": { "mode": enum }, "statusUpdateInterval": enum }

Response Bodies

Example ListJobsResponse

{ "jobs": [ { "arn": "string", "id": "string", "createdAt": "string", "jobTemplate": "string", "queue": "string", "userMetadata": { }, "role": "string", "settings": { "timecodeConfig": { "anchor": "string", "source": enum, "start": "string", "timestampOffset": "string" }, "outputGroups": [ { "customName": "string", "name": "string", "outputs": [ { "containerSettings": { "container": enum, "m3u8Settings": { "audioFramesPerPes": integer, "pcrControl": enum, "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 } }, "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 }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ] }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "entropyEncoding": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum }, "h265Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "alternateTransferFunctionSei": enum, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "tiles": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "temporalIds": enum, "sampleAdaptiveOffsetFilterMode": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum }, "mpeg2Settings": { "interlaceMode": enum, "parNumerator": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "bitrate": integer, "intraDcPrecision": enum, "framerateControl": enum, "rateControlMode": enum, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "dynamicSubGop": enum }, "proresSettings": { "interlaceMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum } }, "afdSignaling": enum, "dropFrameTimecode": enum, "respondToAfd": enum, "colorMetadata": enum }, "audioDescriptions": [ { "audioTypeControl": enum, "audioSourceName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "correctionGateLevel": integer, "loudnessLogging": enum, "targetLkfs": number, "peakCalculation": enum }, "codecSettings": { "codec": enum, "aacSettings": { "audioDescriptionBroadcasterMix": enum, "vbrQuality": enum, "bitrate": integer, "rateControlMode": enum, "codecProfile": enum, "codingMode": enum, "rawFormat": enum, "sampleRate": integer, "specification": enum }, "ac3Settings": { "bitrate": integer, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "dynamicRangeCompressionProfile": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer, "channelsOut": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "outputSettings": { "hlsSettings": { "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": enum, "iFrameOnlyManifest": enum, "segmentModifier": "string" } }, "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 }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string" }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": 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" } } }, "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" } } }, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string" } }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": enum, "hbbtvCompliance": enum, "writeSegmentTimelineInRepresentation": enum }, "fileGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string" } } } }, "msSmoothGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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" } } }, "encryption": { "encryptionMethod": enum, "constantInitializationVector": "string", "initializationVectorInManifest": enum, "staticKeyProvider": { "staticKeyValue": "string", "keyFormat": "string", "keyFormatVersions": "string", "url": "string" }, "type": enum }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": 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, "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, "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 } ] }, "fileInput": "string", "decryptionSettings": { "decryptionMode": enum, "encryptedDecryptionKey": "string", "initializationVector": "string", "kmsKeyRegion": "string" }, "supplementalImps": [ "string" ] } ] }, "status": enum, "errorCode": integer, "errorMessage": "string", "timing": { "submitTime": "string", "startTime": "string", "finishTime": "string" }, "outputGroupDetails": [ { "outputDetails": [ { "durationInMs": integer, "videoDetails": { "widthInPx": integer, "heightInPx": integer } } ] } ], "billingTagsSource": enum, "accelerationSettings": { "mode": enum }, "statusUpdateInterval": enum, "jobPercentComplete": integer, "currentPhase": enum, "retryCount": integer } ], "nextToken": "string" }

Example CreateJobResponse

{ "job": { "arn": "string", "id": "string", "createdAt": "string", "jobTemplate": "string", "queue": "string", "userMetadata": { }, "role": "string", "settings": { "timecodeConfig": { "anchor": "string", "source": enum, "start": "string", "timestampOffset": "string" }, "outputGroups": [ { "customName": "string", "name": "string", "outputs": [ { "containerSettings": { "container": enum, "m3u8Settings": { "audioFramesPerPes": integer, "pcrControl": enum, "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 } }, "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 }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ] }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" } }, "timecodeInsertion": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "h264Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "entropyEncoding": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "dynamicSubGop": enum }, "h265Settings": { "interlaceMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "alternateTransferFunctionSei": enum, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "maxAverageBitrate": integer }, "codecProfile": enum, "tiles": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "temporalIds": enum, "sampleAdaptiveOffsetFilterMode": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum }, "mpeg2Settings": { "interlaceMode": enum, "parNumerator": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "bitrate": integer, "intraDcPrecision": enum, "framerateControl": enum, "rateControlMode": enum, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "dynamicSubGop": enum }, "proresSettings": { "interlaceMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum } }, "afdSignaling": enum, "dropFrameTimecode": enum, "respondToAfd": enum, "colorMetadata": enum }, "audioDescriptions": [ { "audioTypeControl": enum, "audioSourceName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "correctionGateLevel": integer, "loudnessLogging": enum, "targetLkfs": number, "peakCalculation": enum }, "codecSettings": { "codec": enum, "aacSettings": { "audioDescriptionBroadcasterMix": enum, "vbrQuality": enum, "bitrate": integer, "rateControlMode": enum, "codecProfile": enum, "codingMode": enum, "rawFormat": enum, "sampleRate": integer, "specification": enum }, "ac3Settings": { "bitrate": integer, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "dynamicRangeCompressionProfile": enum, "metadataControl": enum, "lfeFilter": enum, "sampleRate": integer }, "aiffSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer }, "eac3Settings": { "metadataControl": enum, "surroundExMode": enum, "loRoSurroundMixLevel": number, "phaseControl": enum, "dialnorm": integer, "ltRtSurroundMixLevel": number, "bitrate": integer, "ltRtCenterMixLevel": number, "passthroughControl": enum, "lfeControl": enum, "loRoCenterMixLevel": number, "attenuationControl": enum, "codingMode": enum, "surroundMode": enum, "bitstreamMode": enum, "lfeFilter": enum, "stereoDownmix": enum, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "dynamicRangeCompressionLine": enum, "dcFilter": enum }, "mp2Settings": { "bitrate": integer, "channels": integer, "sampleRate": integer }, "wavSettings": { "bitDepth": integer, "channels": integer, "sampleRate": integer, "format": enum } }, "remixSettings": { "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer, "channelsOut": integer }, "streamName": "string", "languageCodeControl": enum, "audioType": integer, "customLanguageCode": "string", "languageCode": enum } ], "outputSettings": { "hlsSettings": { "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": enum, "iFrameOnlyManifest": enum, "segmentModifier": "string" } }, "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 }, "sccDestinationSettings": { "framerate": enum }, "teletextDestinationSettings": { "pageNumber": "string" }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "embeddedDestinationSettings": { "destination608ChannelNumber": 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" } } }, "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" } } }, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string", "certificateArn": "string" } }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": enum, "hbbtvCompliance": enum, "writeSegmentTimelineInRepresentation": enum }, "fileGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "string" } } } }, "msSmoothGroupSettings": { "destination": "string", "destinationSettings": { "s3Settings": { "encryption": { "encryptionType": enum, "kmsKeyArn": "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" } } }, "encryption": { "encryptionMethod": enum, "constantInitializationVector": "string", "initializationVectorInManifest": enum, "staticKeyProvider": { "staticKeyValue": "string", "keyFormat": "string", "keyFormatVersions": "string", "url": "string" }, "type": enum }, "minBufferTime": integer, "fragmentLength": integer, "baseUrl": "string", "segmentControl": 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, "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, "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 } ] }, "fileInput": "string", "decryptionSettings": { "decryptionMode": enum, "encryptedDecryptionKey": "string", "initializationVector": "string", "kmsKeyRegion": "string" }, "supplementalImps": [ "string" ] } ] }, "status": enum, "errorCode": integer, "errorMessage": "string", "timing": { "submitTime": "string", "startTime": "string", "finishTime": "string" }, "outputGroupDetails": [ { "outputDetails": [ { "durationInMs": integer, "videoDetails": { "widthInPx": integer, "heightInPx": integer } } ] } ], "billingTagsSource": enum, "accelerationSettings": { "mode": enum }, "statusUpdateInterval": enum, "jobPercentComplete": integer, "currentPhase": enum, "retryCount": integer } }

Example ExceptionBody

{ "message": "string" }

Properties

AacAudioDescriptionBroadcasterMix

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

  • BROADCASTER_MIXED_AD

  • NORMAL

AacCodecProfile

AAC Profile.

  • LC

  • HEV1

  • HEV2

AacCodingMode

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

  • AD_RECEIVER_MIX

  • CODING_MODE_1_0

  • CODING_MODE_1_1

  • CODING_MODE_2_0

  • CODING_MODE_5_1

AacRateControlMode

Rate Control Mode.

  • CBR

  • VBR

AacRawFormat

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

  • LATM_LOAS

  • NONE

AacSettings

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

Property Type Required Description
audioDescriptionBroadcasterMix

AacAudioDescriptionBroadcasterMix

False

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

vbrQuality

AacVbrQuality

False

VBR Quality Level - Only used if rate_control_mode is VBR.

bitrate

integer

Minimum: 6000

Maximum: 1024000

False

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

rateControlMode

AacRateControlMode

False

Rate Control Mode.

codecProfile

AacCodecProfile

False

AAC Profile.

codingMode

AacCodingMode

False

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

rawFormat

AacRawFormat

False

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

sampleRate

integer

Minimum: 8000

Maximum: 96000

False

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

specification

AacSpecification

False

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

AacSpecification

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

  • MPEG2

  • MPEG4

AacVbrQuality

VBR Quality Level - Only used if rate_control_mode is VBR.

  • LOW

  • MEDIUM_LOW

  • MEDIUM_HIGH

  • HIGH

Ac3BitstreamMode

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

  • COMPLETE_MAIN

  • COMMENTARY

  • DIALOGUE

  • EMERGENCY

  • HEARING_IMPAIRED

  • MUSIC_AND_EFFECTS

  • VISUALLY_IMPAIRED

  • VOICE_OVER

Ac3CodingMode

Dolby Digital coding mode. Determines number of channels.

  • CODING_MODE_1_0

  • CODING_MODE_1_1

  • CODING_MODE_2_0

  • CODING_MODE_3_2_LFE

Ac3DynamicRangeCompressionProfile

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

  • FILM_STANDARD

  • NONE

Ac3LfeFilter

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

  • ENABLED

  • DISABLED

Ac3MetadataControl

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

  • FOLLOW_INPUT

  • USE_CONFIGURED

Ac3Settings

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

Property Type Required Description
bitrate

integer

Minimum: 64000

Maximum: 640000

False

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

bitstreamMode

Ac3BitstreamMode

False

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

codingMode

Ac3CodingMode

False

Dolby Digital coding mode. Determines number of channels.

dialnorm

integer

Minimum: 1

Maximum: 31

False

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

dynamicRangeCompressionProfile

Ac3DynamicRangeCompressionProfile

False

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

metadataControl

Ac3MetadataControl

False

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

lfeFilter

Ac3LfeFilter

False

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

sampleRate

integer

Minimum: 48000

Maximum: 48000

False

Sample rate in hz. Sample rate is always 48000.

AccelerationMode

Enable Acceleration (AccelerationMode) on any job that you want processed with accelerated transcoding.

  • DISABLED

  • ENABLED

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.

Property Type Required Description
mode

AccelerationMode

True

Acceleration configuration for the job.

AfdSignaling

This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.

  • NONE

  • AUTO

  • FIXED

AiffSettings

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

Property Type Required Description
bitDepth

integer

Minimum: 16

Maximum: 24

False

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

channels

integer

Minimum: 1

Maximum: 2

False

Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2.

sampleRate

integer

Minimum: 8000

Maximum: 192000

False

Sample rate in hz.

AncillarySourceSettings

Settings for ancillary captions source.

Property Type Required Description
sourceAncillaryChannelNumber

integer

Minimum: 1

Maximum: 4

False

Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough.

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

  • PASSTHROUGH

AudioCodecSettings

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

Property Type Required Description
codec

AudioCodec

False

Type of Audio codec.

aacSettings

AacSettings

False

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

ac3Settings

Ac3Settings

False

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

aiffSettings

AiffSettings

False

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

eac3Settings

Eac3Settings

False

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

mp2Settings

Mp2Settings

False

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

wavSettings

WavSettings

False

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

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

Property Type Required Description
audioTypeControl

AudioTypeControl

False

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

audioSourceName

string

False

Specifies which audio data to use from each input. In the simplest case, specify an "Audio Selector":#inputs-audio_selector by name based on its order within each input. For example if you specify "Audio Selector 3", then the third audio selector will be used from each input. If an input does not have an "Audio Selector 3", then the audio selector marked as "default" in that input will be used. If there is no audio selector marked as "default", silence will be inserted for the duration of that input. Alternatively, an "Audio Selector Group":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then "Audio Selector 1" will be chosen automatically.

audioNormalizationSettings

AudioNormalizationSettings

False

Advanced audio normalization settings.

codecSettings

AudioCodecSettings

False

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

remixSettings

RemixSettings

False

Advanced audio remixing settings.

streamName

string

Pattern: ^[\w\s]*$

False

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

languageCodeControl

AudioLanguageCodeControl

False

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

audioType

integer

Minimum: 0

Maximum: 255

False

Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved.

customLanguageCode

string

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

MinLength: 3

MaxLength: 3

False

Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code. The language specified will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.

languageCode

LanguageCode

False

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

AudioLanguageCodeControl

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

  • FOLLOW_INPUT

  • USE_CONFIGURED

AudioNormalizationAlgorithm

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

  • ITU_BS_1770_1

  • ITU_BS_1770_2

AudioNormalizationAlgorithmControl

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.

Property Type Required Description
algorithm

AudioNormalizationAlgorithm

False

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

algorithmControl

AudioNormalizationAlgorithmControl

False

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

correctionGateLevel

integer

Minimum: -70

Maximum: 0

False

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

loudnessLogging

AudioNormalizationLoudnessLogging

False

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

targetLkfs

number

Format: float

Minimum: -59.0

Maximum: 0.0

False

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

peakCalculation

AudioNormalizationPeakCalculation

False

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

AudioSelector

Selector for Audio

Property Type Required Description
tracks

Array of type integer

Minimum: 1

Maximum: 2147483647

False

Identify a track from the input audio to include in this selector by entering the track index number. To include several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a comma-separated list. For examle, type "1,2,3" to include tracks 1 through 3. Specifying directly in your JSON job file, provide the track numbers in an array. For example, "tracks": [1,2,3].

offset

integer

Minimum: -2147483648

Maximum: 2147483647

False

Specifies a time delta in milliseconds to offset the audio from the input video.

defaultSelection

AudioDefaultSelection

False

Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.

selectorType

AudioSelectorType

False

Specifies the type of the audio selector.

pids

Array of type integer

Minimum: 1

Maximum: 2147483647

False

Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101).

externalAudioFileInput

string

Pattern: ^(s3:\/\/)([^\/]+\/)+([^\/\.]+|(([^\/]*)\.([mM]2[vV]|[mM][pP][eE][gG]|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))$

False

Specifies audio data from an external file source.

programSelection

integer

Minimum: 0

Maximum: 8

False

Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track.

customLanguageCode

string

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

MinLength: 3

MaxLength: 3

False

Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code

languageCode

LanguageCode

False

Selects a specific language code from within an audio source.

remixSettings

RemixSettings

False

Use these settings to reorder the audio channels of one input to match those of another input. This allows you to combine the two files into a single output, one after the other.

AudioSelectorGroup

Group of Audio Selectors

Property Type Required Description
audioSelectorNames

Array of type string

MinLength: 1

False

Name of an Audio Selector within the same input to include in the group. Audio selector names are standardized, based on their order within the input (e.g., "Audio Selector 1"). The audio selector name parameter can be repeated to add any number of audio selectors to the group.

AudioSelectorType

Specifies the type of the audio selector.

  • PID

  • TRACK

  • LANGUAGE_CODE

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

Property Type Required Description
availBlankingImage

string

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

MinLength: 14

False

Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.

BillingTagsSource

Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.

  • QUEUE

  • PRESET

  • JOB_TEMPLATE

BurninDestinationSettings

Burn-In Destination Settings.

Property Type Required Description
backgroundOpacity

integer

Minimum: 0

Maximum: 255

False

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

shadowXOffset

integer

Minimum: -2147483648

Maximum: 2147483647

False

Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.

teletextSpacing

BurninSubtitleTeletextSpacing

False

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

alignment

BurninSubtitleAlignment

False

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

outlineSize

integer

Minimum: 0

Maximum: 10

False

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

yPosition

integer

Minimum: 0

Maximum: 2147483647

False

Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

shadowColor

BurninSubtitleShadowColor

False

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

fontOpacity

integer

Minimum: 0

Maximum: 255

False

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

fontSize

integer

Minimum: 0

Maximum: 96

False

A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.

fontScript

FontScript

False

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

fontColor

BurninSubtitleFontColor

False

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

backgroundColor

BurninSubtitleBackgroundColor

False

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

fontResolution

integer

Minimum: 96

Maximum: 600

False

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

outlineColor

BurninSubtitleOutlineColor

False

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

shadowYOffset

integer

Minimum: -2147483648

Maximum: 2147483647

False

Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.

xPosition

integer

Minimum: 0

Maximum: 2147483647

False

Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

shadowOpacity

integer

Minimum: 0

Maximum: 255

False

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

BurninSubtitleAlignment

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

  • CENTERED

  • LEFT

BurninSubtitleBackgroundColor

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

  • NONE

  • BLACK

  • WHITE

BurninSubtitleFontColor

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

  • WHITE

  • BLACK

  • YELLOW

  • RED

  • GREEN

  • BLUE

BurninSubtitleOutlineColor

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

  • BLACK

  • WHITE

  • YELLOW

  • RED

  • GREEN

  • BLUE

BurninSubtitleShadowColor

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

  • NONE

  • BLACK

  • WHITE

BurninSubtitleTeletextSpacing

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

  • FIXED_GRID

  • PROPORTIONAL

CaptionDescription

Description of Caption output

Property Type Required Description
captionSelectorName

string

MinLength: 1

False

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input.

destinationSettings

CaptionDestinationSettings

False

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

customLanguageCode

string

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

MinLength: 3

MaxLength: 3

False

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

languageCode

LanguageCode

False

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

languageDescription

string

False

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

CaptionDestinationSettings

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

Property Type Required Description
destinationType

CaptionDestinationType

False

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

burninDestinationSettings

BurninDestinationSettings

False

Burn-In Destination Settings.

dvbSubDestinationSettings

DvbSubDestinationSettings

False

DVB-Sub Destination Settings

sccDestinationSettings

SccDestinationSettings

False

Settings for SCC caption output.

teletextDestinationSettings

TeletextDestinationSettings

False

Settings for Teletext caption output

ttmlDestinationSettings

TtmlDestinationSettings

False

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

embeddedDestinationSettings

EmbeddedDestinationSettings

False

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

CaptionDestinationType

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, 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

  • SCTE20_PLUS_EMBEDDED

  • SCC

  • SRT

  • SMI

  • TELETEXT

  • TTML

  • WEBVTT

CaptionSelector

Set up captions in your outputs by first selecting them from your input here.

Property Type Required Description
customLanguageCode

string

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

MinLength: 3

MaxLength: 3

False

The specific language to extract from source, using the ISO 639-2 or ISO 639-3 three-letter language code. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions.

languageCode

LanguageCode

False

The specific language to extract from source. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions.

sourceSettings

CaptionSourceSettings

False

Source settings (SourceSettings) contains the group of settings for captions in the input.

CaptionSourceSettings

Source settings (SourceSettings) contains the group of settings for captions in the input.

Property Type Required Description
sourceType

CaptionSourceType

False

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

ancillarySourceSettings

AncillarySourceSettings

False

Settings for ancillary captions source.

dvbSubSourceSettings

DvbSubSourceSettings

False

DVB Sub Source Settings

embeddedSourceSettings

EmbeddedSourceSettings

False

Settings for embedded captions Source

fileSourceSettings

FileSourceSettings

False

Settings for File-based Captions in Source

teletextSourceSettings

TeletextSourceSettings

False

Settings specific to Teletext caption sources, including Page number.

trackSourceSettings

TrackSourceSettings

False

Settings specific to caption sources that are specfied by track number. Sources include IMSC in IMF.

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

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

Property Type Required Description
encryptionMethod

CmafEncryptionType

False

Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.

constantInitializationVector

string

Pattern: ^[0-9a-fA-F]{32}$

MinLength: 32

MaxLength: 32

False

This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default.

initializationVectorInManifest

CmafInitializationVectorInManifest

False

The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.

staticKeyProvider

StaticKeyProvider

False

Use these settings to set up encryption with a static key provider.

type

CmafKeyProviderType

False

Indicates which type of key provider is used for encryption.

CmafEncryptionType

Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.

  • SAMPLE_AES

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

CmafWriteHLSManifest

False

When set to ENABLED, an Apple HLS manifest will be generated for this output.

writeDashManifest

CmafWriteDASHManifest

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: 2147483647

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: ^s3:\/\/

False

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

destinationSettings

DestinationSettings

False

Settings associated with the destination. Will vary based on the type of destination

encryption

CmafEncryptionSettings

False

DRM settings.

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

CmafSegmentControl

False

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

manifestDurationFormat

CmafManifestDurationFormat

False

Indicates whether the output manifest should use floating point values for segment duration.

streamInfResolution

CmafStreamInfResolution

False

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

clientCache

CmafClientCache

False

When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.

manifestCompression

CmafManifestCompression

False

When set to GZIP, compresses HLS playlist.

codecSpecification

CmafCodecSpecification

False

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

CmafInitializationVectorInManifest

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

CmafKeyProviderType

Indicates which type of key provider is used for encryption.

  • 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

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.

Property Type Required Description
brightness

integer

Minimum: 1

Maximum: 100

False

Brightness level.

colorSpaceConversion

ColorSpaceConversion

False

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

contrast

integer

Minimum: 1

Maximum: 100

False

Contrast level.

hue

integer

Minimum: -180

Maximum: 180

False

Hue in degrees.

saturation

integer

Minimum: 1

Maximum: 100

False

Saturation level.

hdr10Metadata

Hdr10Metadata

False

Use the HDR master display (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. Note that these settings are not color correction.

ColorMetadata

Enable Insert color metadata (ColorMetadata) to include color metadata in this output. This setting is enabled 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. The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, or if your input video is missing color space metadata that should be there, specify the accurate color space here. If you choose HDR10, you can also correct inaccurate color space coefficients, using the HDR master display information controls. You must also set Color space usage (ColorSpaceUsage) to FORCE for the service to use these values.

  • FOLLOW

  • REC_601

  • REC_709

  • HDR10

  • HLG_2020

ColorSpaceConversion

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

  • NONE

  • FORCE_601

  • FORCE_709

  • FORCE_HDR10

  • FORCE_HLG_2020

ColorSpaceUsage

There are two sources for color metadata, the input file and the job configuration (in the Color space and HDR master display informaiton settings). The Color space usage setting controls which takes precedence. FORCE: The system will use color metadata supplied by user, if any. If the user does not supply color metadata, the system will use data from the source. FALLBACK: The system will use color metadata from the source. If source has no color metadata, the system will use user-supplied color metadata values if available.

  • FORCE

  • FALLBACK

ContainerSettings

Container specific settings.

Property Type Required Description
container

ContainerType

False

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

m3u8Settings

M3u8Settings

False

Settings for TS segments in HLS

f4vSettings

F4vSettings

False

Settings for F4v container

m2tsSettings

M2tsSettings

False

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

movSettings

MovSettings

False

Settings for MOV Container.

mp4Settings

Mp4Settings

False

Settings for MP4 Container

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

CreateJobRequest

Send your create job request with your job settings and IAM role. Optionally, include user metadata and the ARN for the queue.

Property Type Required Description
clientRequestToken

string

False

Idempotency token for CreateJob operation.

jobTemplate

string

False

When you create a job, you can either specify a job template or specify the transcoding settings individually

queue

string

False

Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.

role

string

True

Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.

settings

JobSettings

True

JobSettings contains all the transcode settings for a job.

userMetadata

object

False

User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

billingTagsSource

BillingTagsSource

False

Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.

accelerationSettings

AccelerationSettings

False

Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.

statusUpdateInterval

StatusUpdateInterval

False

Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.

CreateJobResponse

Successful create job requests will return the job JSON.

Property Type Required Description
job

Job

False

Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

DashIsoEncryptionSettings

Specifies DRM settings for DASH outputs.

Property Type Required Description
spekeKeyProvider

SpekeKeyProvider

False

Settings for use with a SPEKE key provider

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: ^s3:\/\/

False

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

destinationSettings

DestinationSettings

False

Settings associated with the destination. Will vary based on the type of destination

encryption

DashIsoEncryptionSettings

False

DRM settings.

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

DashIsoSegmentControl

False

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

hbbtvCompliance

DashIsoHbbtvCompliance

False

Supports HbbTV specification as indicated

writeSegmentTimelineInRepresentation

DashIsoWriteSegmentTimelineInRepresentation

False

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.

DashIsoHbbtvCompliance

Supports HbbTV specification as indicated

  • HBBTV_1_5

  • NONE

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

DecryptionMode

Specify the encryption mode that you used to encrypt your input files.

  • AES_CTR

  • AES_CBC

  • AES_GCM

DeinterlaceAlgorithm

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

  • INTERPOLATE

  • INTERPOLATE_TICKER

  • BLEND

  • BLEND_TICKER

Deinterlacer

Settings for deinterlacer

Property Type Required Description
algorithm

DeinterlaceAlgorithm

False

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

mode

DeinterlacerMode

False

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

control

DeinterlacerControl

False

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

DeinterlacerControl

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

  • FORCE_ALL_FRAMES

  • NORMAL

DeinterlacerMode

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

  • DEINTERLACE

  • INVERSE_TELECINE

  • ADAPTIVE

DestinationSettings

Settings associated with the destination. Will vary based on the type of destination

Property Type Required Description
s3Settings

S3DestinationSettings

False

Settings associated with S3 destination

DropFrameTimecode

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

  • DISABLED

  • ENABLED

DvbNitSettings

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

Property Type Required Description
nitInterval

integer

Minimum: 25

Maximum: 10000

False

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

networkId

integer

Minimum: 0

Maximum: 65535

False

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

networkName

string

MinLength: 1

MaxLength: 256

False

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

DvbSdtSettings

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

Property Type Required Description
outputSdt

OutputSdt

False

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

sdtInterval

integer

Minimum: 25

Maximum: 2000

False

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

serviceName

string

MinLength: 1

MaxLength: 256

False

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

serviceProviderName

string

MinLength: 1

MaxLength: 256

False

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

DvbSubDestinationSettings

DVB-Sub Destination Settings

Property Type Required Description
backgroundOpacity

integer

Minimum: 0

Maximum: 255

False

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

shadowXOffset

integer

Minimum: -2147483648

Maximum: 2147483647

False

Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.

teletextSpacing

DvbSubtitleTeletextSpacing

False

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

alignment

DvbSubtitleAlignment

False

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

outlineSize

integer

Minimum: 0

Maximum: 10

False

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

yPosition

integer

Minimum: 0

Maximum: 2147483647

False

Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

shadowColor

DvbSubtitleShadowColor

False

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

fontOpacity

integer

Minimum: 0

Maximum: 255

False

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

fontSize

integer

Minimum: 0

Maximum: 96

False

A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.

fontScript

FontScript

False

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

fontColor

DvbSubtitleFontColor

False

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

backgroundColor

DvbSubtitleBackgroundColor

False

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

fontResolution

integer

Minimum: 96

Maximum: 600

False

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

outlineColor

DvbSubtitleOutlineColor

False

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

shadowYOffset

integer

Minimum: -2147483648

Maximum: 2147483647

False

Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.

xPosition

integer

Minimum: 0

Maximum: 2147483647

False

Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

shadowOpacity

integer

Minimum: 0

Maximum: 255

False

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

DvbSubSourceSettings

DVB Sub Source Settings

Property Type Required Description
pid

integer

Minimum: 1

Maximum: 2147483647

False

When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.

DvbSubtitleAlignment

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

  • CENTERED

  • LEFT

DvbSubtitleBackgroundColor

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

  • NONE

  • BLACK

  • WHITE

DvbSubtitleFontColor

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

  • WHITE

  • BLACK

  • YELLOW

  • RED

  • GREEN

  • BLUE

DvbSubtitleOutlineColor

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

  • BLACK

  • WHITE

  • YELLOW

  • RED

  • GREEN

  • BLUE

DvbSubtitleShadowColor

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

  • NONE

  • BLACK

  • WHITE

DvbSubtitleTeletextSpacing

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

  • FIXED_GRID

  • PROPORTIONAL

DvbTdtSettings

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

Property Type Required Description
tdtInterval

integer

Minimum: 1000

Maximum: 30000

False

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

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

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

  • COMPLETE_MAIN

  • COMMENTARY

  • EMERGENCY

  • HEARING_IMPAIRED

  • VISUALLY_IMPAIRED

Eac3CodingMode

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

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

  • NONE

  • FILM_STANDARD

  • FILM_LIGHT

  • MUSIC_STANDARD

  • MUSIC_LIGHT

  • SPEECH

Eac3DynamicRangeCompressionRf

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

  • NONE

  • FILM_STANDARD

  • FILM_LIGHT

  • MUSIC_STANDARD

  • MUSIC_LIGHT

  • SPEECH

Eac3LfeControl

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

  • LFE

  • NO_LFE

Eac3LfeFilter

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

  • ENABLED

  • DISABLED

Eac3MetadataControl

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

  • FOLLOW_INPUT

  • USE_CONFIGURED

Eac3PassthroughControl

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

  • WHEN_POSSIBLE

  • NO_PASSTHROUGH

Eac3PhaseControl

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

  • SHIFT_90_DEGREES

  • NO_SHIFT

Eac3Settings

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

Property Type Required Description
metadataControl

Eac3MetadataControl

False

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

surroundExMode

Eac3SurroundExMode

False

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

loRoSurroundMixLevel

number

Format: float

Minimum: -60.0

Maximum: -1.5

False

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

phaseControl

Eac3PhaseControl

False

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

dialnorm

integer

Minimum: 1

Maximum: 31

False

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

ltRtSurroundMixLevel

number

Format: float

Minimum: -60.0

Maximum: -1.5

False

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

bitrate

integer

Minimum: 64000

Maximum: 640000

False

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

ltRtCenterMixLevel

number

Format: float

Minimum: -60.0

Maximum: 3.0

False

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

passthroughControl

Eac3PassthroughControl

False

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

lfeControl

Eac3LfeControl

False

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

loRoCenterMixLevel

number

Format: float

Minimum: -60.0

Maximum: 3.0

False

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

attenuationControl

Eac3AttenuationControl

False

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

codingMode

Eac3CodingMode

False

Dolby Digital Plus coding mode. Determines number of channels.

surroundMode

Eac3SurroundMode

False

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

bitstreamMode

Eac3BitstreamMode

False

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

lfeFilter

Eac3LfeFilter

False

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

stereoDownmix

Eac3StereoDownmix

False

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

dynamicRangeCompressionRf

Eac3DynamicRangeCompressionRf

False

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

sampleRate

integer

Minimum: 48000

Maximum: 48000

False

Sample rate in hz. Sample rate is always 48000.

dynamicRangeCompressionLine

Eac3DynamicRangeCompressionLine

False

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

dcFilter

Eac3DcFilter

False

Activates a DC highpass filter for all input channels.

Eac3StereoDownmix

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

  • 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

When set to UPCONVERT, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.

  • UPCONVERT

  • DISABLED

EmbeddedDestinationSettings

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

Property Type Required Description
destination608ChannelNumber

integer

Minimum: 1

Maximum: 4

False

Ignore this setting unless your input captions are SCC format and your output container is MXF. With this combination of input captions format and output container, you can optionally use this setting to replace the input channel number with the track number that you specify. Specify a different number for each output captions track. If you don't specify an output track number, the system uses the input channel number for the output channel number. This setting applies to each output individually. You can optionally combine two captions channels in your output. The two output channel numbers can be one of the following pairs: 1,3; 2,4; 1,4; or 2,3.

EmbeddedSourceSettings

Settings for embedded captions Source

Property Type Required Description
source608ChannelNumber

integer

Minimum: 1

Maximum: 4

False

Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.

source608TrackNumber

integer

Minimum: 1

Maximum: 1

False

Specifies the video track index used for extracting captions. The system only supports one input video track, so this should always be set to '1'.

convert608To708

EmbeddedConvert608To708

False

When set to UPCONVERT, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.

EsamManifestConfirmConditionNotification

ESAM ManifestConfirmConditionNotification defined by OC-SP-ESAM-API-I03-131025.

Property Type Required Description
mccXml

string

Pattern: ^\s*<(.|\n)*ManifestConfirmConditionNotification(.|\n)*>\s*$

False

Provide your ESAM ManifestConfirmConditionNotification XML document inside your JSON job settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the Manifest Conditioning instructions in the message that you supply.

EsamSettings

Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.

Property Type Required Description
signalProcessingNotification

EsamSignalProcessingNotification

False

Specifies an ESAM SignalProcessingNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the signal processing instructions that you provide in the setting SCC XML (sccXml).

manifestConfirmConditionNotification

EsamManifestConfirmConditionNotification

False

Specifies an ESAM ManifestConfirmConditionNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the manifest conditioning instructions that you provide in the setting MCC XML (mccXml).

responseSignalPreroll

integer

Minimum: 0

Maximum: 30000

False

Specifies the stream distance, in milliseconds, between the SCTE 35 messages that the transcoder places and the splice points that they refer to. If the time between the start of the asset and the SCTE-35 message is less than this value, then the transcoder places the SCTE-35 marker at the beginning of the stream.

EsamSignalProcessingNotification

ESAM SignalProcessingNotification data defined by OC-SP-ESAM-API-I03-131025.

Property Type Required Description
sccXml

string

Pattern: ^\s*<(.|\n)*SignalProcessingNotification(.|\n)*>\s*$

False

Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the signal processing instructions in the message that you supply. Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. If you want the service to place SCTE-35 markers at the insertion points you specify in the XML document, you must also enable SCTE-35 ESAM (scte35Esam). Note that you can either specify an ESAM XML document or enable SCTE-35 passthrough. You can't do both.

ExceptionBody

Property Type Required Description
message

string

False

F4vMoovPlacement

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

  • PROGRESSIVE_DOWNLOAD

  • NORMAL

F4vSettings

Settings for F4v container

Property Type Required Description
moovPlacement

F4vMoovPlacement

False

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

FileGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILE_GROUP_SETTINGS.

Property Type Required Description
destination

string

Pattern: ^s3:\/\/

False

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

destinationSettings

DestinationSettings

False

Settings associated with the destination. Will vary based on the type of destination

FileSourceConvert608To708

If set to UPCONVERT, 608 caption data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.

  • UPCONVERT

  • DISABLED

FileSourceSettings

Settings for File-based Captions in Source

Property Type Required Description
sourceFile

string

Pattern: ^(s3:\/\/)(.*?)\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|smi|SMI)$

MinLength: 14

False

External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', and 'smi'.

timeDelta

integer

Minimum: -2147483648

Maximum: 2147483647

False

Specifies a time delta in seconds to offset the captions from the source file.

convert608To708

FileSourceConvert608To708

False

If set to UPCONVERT, 608 caption data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.

FontScript

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

  • AUTOMATIC

  • HANS

  • HANT

FrameCaptureSettings

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

Property Type Required Description
framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.

framerateDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.

maxCaptures

integer

Minimum: 1

Maximum: 10000000

False

Maximum number of captures (encoded jpg output files).

quality

integer

Minimum: 1

Maximum: 100

False

JPEG Quality - a higher value equals higher quality.

H264AdaptiveQuantization

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

  • HIGHER

  • MAX

H264CodecLevel

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

  • AUTO

  • LEVEL_1

  • LEVEL_1_1

  • LEVEL_1_2

  • LEVEL_1_3

  • LEVEL_2

  • LEVEL_2_1

  • LEVEL_2_2

  • LEVEL_3

  • LEVEL_3_1

  • LEVEL_3_2

  • LEVEL_4

  • LEVEL_4_1

  • LEVEL_4_2

  • LEVEL_5

  • LEVEL_5_1

  • LEVEL_5_2

H264CodecProfile

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

  • BASELINE

  • HIGH

  • HIGH_10BIT

  • HIGH_422

  • HIGH_422_10BIT

  • MAIN

H264DynamicSubGop

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

  • ADAPTIVE

  • STATIC

H264EntropyEncoding

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

  • CABAC

  • CAVLC

H264FieldEncoding

Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.

  • PAFF

  • FORCE_FIELD

H264FlickerAdaptiveQuantization

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

  • DISABLED

  • ENABLED

H264FramerateControl

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264FramerateConversionAlgorithm

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

  • DUPLICATE_DROP

  • INTERPOLATE

H264GopBReference

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

  • DISABLED

  • ENABLED

H264GopSizeUnits

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

  • FRAMES

  • SECONDS

H264InterlaceMode

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

  • PROGRESSIVE

  • TOP_FIELD

  • BOTTOM_FIELD

  • FOLLOW_TOP_FIELD

  • FOLLOW_BOTTOM_FIELD

H264ParControl

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264QualityTuningLevel

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

  • SINGLE_PASS

  • SINGLE_PASS_HQ

  • MULTI_PASS_HQ

H264QvbrSettings

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

Property Type Required Description
qvbrQualityLevel

integer

Minimum: 1

Maximum: 10

False

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

maxAverageBitrate

integer

Minimum: 1000

Maximum: 1152000000

False

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

H264RateControlMode

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

  • VBR

  • CBR

  • QVBR

H264RepeatPps

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

  • DISABLED

  • ENABLED

H264SceneChangeDetect

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

  • DISABLED

  • ENABLED

H264Settings

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

Property Type Required Description
interlaceMode

H264InterlaceMode

False

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

parNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio numerator.

numberReferenceFrames

integer

Minimum: 1

Maximum: 6

False

Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.

syntax

H264Syntax

False

Produces a bitstream compliant with SMPTE RP-2027.

softness

integer

Minimum: 0

Maximum: 128

False

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

framerateDenominator

integer

Minimum: 1

Maximum: 2147483647

False

When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.

gopClosedCadence

integer

Minimum: 0

Maximum: 2147483647

False

Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.

hrdBufferInitialFillPercentage

integer

Minimum: 0

Maximum: 100

False

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

gopSize

number

Format: float

Minimum: 0.0

False

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

slices

integer

Minimum: 1

Maximum: 32

False

Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.

gopBReference

H264GopBReference

False

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

hrdBufferSize

integer

Minimum: 0

Maximum: 1152000000

False

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

maxBitrate

integer

Minimum: 1000

Maximum: 1152000000

False

Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.

slowPal

H264SlowPal

False

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

parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

spatialAdaptiveQuantization

H264SpatialAdaptiveQuantization

False

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

temporalAdaptiveQuantization

H264TemporalAdaptiveQuantization

False

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

flickerAdaptiveQuantization

H264FlickerAdaptiveQuantization

False

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

entropyEncoding

H264EntropyEncoding

False

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

bitrate

integer

Minimum: 1000

Maximum: 1152000000

False

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

framerateControl

H264FramerateControl

False

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

rateControlMode

H264RateControlMode

False

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

qvbrSettings

H264QvbrSettings

False

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

codecProfile

H264CodecProfile

False

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

telecine

H264Telecine

False

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

framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

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

minIInterval

integer

Minimum: 0

Maximum: 30

False

Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1

adaptiveQuantization

H264AdaptiveQuantization

False

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

codecLevel

H264CodecLevel

False

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

fieldEncoding

H264FieldEncoding

False

Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.

sceneChangeDetect

H264SceneChangeDetect

False

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

qualityTuningLevel

H264QualityTuningLevel

False

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

framerateConversionAlgorithm

H264FramerateConversionAlgorithm

False

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

unregisteredSeiTimecode

H264UnregisteredSeiTimecode

False

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

gopSizeUnits

H264GopSizeUnits

False

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

parControl

H264ParControl

False

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

numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

repeatPps

H264RepeatPps

False

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

dynamicSubGop

H264DynamicSubGop

False

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

H264SlowPal

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

  • DISABLED

  • ENABLED

H264SpatialAdaptiveQuantization

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

  • DISABLED

  • ENABLED

H264Syntax

Produces a bitstream compliant with SMPTE RP-2027.

  • DEFAULT

  • RP2027

H264Telecine

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

  • NONE

  • SOFT

  • HARD

H264TemporalAdaptiveQuantization

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

  • DISABLED

  • ENABLED

H264UnregisteredSeiTimecode

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

  • DISABLED

  • ENABLED

H265AdaptiveQuantization

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

  • HIGHER

  • MAX

H265AlternateTransferFunctionSei

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

  • DISABLED

  • ENABLED

H265CodecLevel

H.265 Level.

  • AUTO

  • LEVEL_1

  • LEVEL_2

  • LEVEL_2_1

  • LEVEL_3

  • LEVEL_3_1

  • LEVEL_4

  • LEVEL_4_1

  • LEVEL_5

  • LEVEL_5_1

  • LEVEL_5_2

  • LEVEL_6

  • LEVEL_6_1

  • LEVEL_6_2

H265CodecProfile

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

  • MAIN_MAIN

  • MAIN_HIGH

  • MAIN10_MAIN

  • MAIN10_HIGH

  • MAIN_422_8BIT_MAIN

  • MAIN_422_8BIT_HIGH

  • MAIN_422_10BIT_MAIN

  • MAIN_422_10BIT_HIGH

H265DynamicSubGop

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

  • ADAPTIVE

  • STATIC

H265FlickerAdaptiveQuantization

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

  • DISABLED

  • ENABLED

H265FramerateControl

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H265FramerateConversionAlgorithm

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

  • DUPLICATE_DROP

  • INTERPOLATE

H265GopBReference

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

  • DISABLED

  • ENABLED

H265GopSizeUnits

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

  • FRAMES

  • SECONDS

H265InterlaceMode

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

  • PROGRESSIVE

  • TOP_FIELD

  • BOTTOM_FIELD

  • FOLLOW_TOP_FIELD

  • FOLLOW_BOTTOM_FIELD

H265ParControl

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H265QualityTuningLevel

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

  • SINGLE_PASS

  • SINGLE_PASS_HQ

  • MULTI_PASS_HQ

H265QvbrSettings

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

Property Type Required Description
qvbrQualityLevel

integer

Minimum: 1

Maximum: 10

False

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

maxAverageBitrate

integer

Minimum: 1000

Maximum: 1466400000

False

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

H265RateControlMode

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

  • VBR

  • CBR

  • QVBR

H265SampleAdaptiveOffsetFilterMode

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

  • DEFAULT

  • ADAPTIVE

  • OFF

H265SceneChangeDetect

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

  • DISABLED

  • ENABLED

H265Settings

Settings for H265 codec

Property Type Required Description
interlaceMode

H265InterlaceMode

False

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

parNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio numerator.

numberReferenceFrames

integer

Minimum: 1

Maximum: 6

False

Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.

framerateDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Frame rate denominator.

gopClosedCadence

integer

Minimum: 0

Maximum: 2147483647

False

Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.

alternateTransferFunctionSei

H265AlternateTransferFunctionSei

False

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

hrdBufferInitialFillPercentage

integer

Minimum: 0

Maximum: 100

False

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

gopSize

number

Format: float

Minimum: 0.0

False

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

slices

integer

Minimum: 1

Maximum: 32

False

Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.

gopBReference

H265GopBReference

False

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

hrdBufferSize

integer

Minimum: 0

Maximum: 1466400000

False

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

maxBitrate

integer

Minimum: 1000

Maximum: 1466400000

False

Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.

slowPal

H265SlowPal

False

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

parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

spatialAdaptiveQuantization

H265SpatialAdaptiveQuantization

False

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

temporalAdaptiveQuantization

H265TemporalAdaptiveQuantization

False

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

flickerAdaptiveQuantization

H265FlickerAdaptiveQuantization

False

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

bitrate

integer

Minimum: 1000

Maximum: 1466400000

False

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

framerateControl

H265FramerateControl

False

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

rateControlMode

H265RateControlMode

False

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

qvbrSettings

H265QvbrSettings

False

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

codecProfile

H265CodecProfile

False

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

tiles

H265Tiles

False

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

telecine

H265Telecine

False

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

framerateNumerator

integer

Minimum: 1

Maximum: 2147483647

False

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

minIInterval

integer

Minimum: 0

Maximum: 30

False

Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1

adaptiveQuantization

H265AdaptiveQuantization

False

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

codecLevel

H265CodecLevel

False

H.265 Level.

sceneChangeDetect

H265SceneChangeDetect

False

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

qualityTuningLevel

H265QualityTuningLevel

False

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

framerateConversionAlgorithm

H265FramerateConversionAlgorithm

False

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

unregisteredSeiTimecode

H265UnregisteredSeiTimecode

False

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

gopSizeUnits

H265GopSizeUnits

False

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

parControl

H265ParControl

False

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

numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

temporalIds

H265TemporalIds

False

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

sampleAdaptiveOffsetFilterMode

H265SampleAdaptiveOffsetFilterMode

False

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

writeMp4PackagingType

H265WriteMp4PackagingType

False

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

dynamicSubGop

H265DynamicSubGop

False

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

H265SlowPal

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

  • DISABLED

  • ENABLED

H265SpatialAdaptiveQuantization

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

  • DISABLED

  • ENABLED

H265Telecine

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

  • NONE

  • SOFT

  • HARD

H265TemporalAdaptiveQuantization

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

  • DISABLED

  • ENABLED

H265TemporalIds

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

  • DISABLED

  • ENABLED

H265Tiles

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

  • DISABLED

  • ENABLED

H265UnregisteredSeiTimecode

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

  • DISABLED

  • ENABLED

H265WriteMp4PackagingType

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

  • HVC1

  • HEV1

Hdr10Metadata

Use the "HDR master display information" (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. These values vary depending on the input video and must be provided by a color grader. Range is 0 to 50,000; each increment represents 0.00002 in CIE1931 color coordinate. Note that these settings are not color correction. Note that if you are creating HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, you must use the following settings. Set "MP4 packaging type" (writeMp4PackagingType) to HVC1 (HVC1). Set "Profile" (H265Settings > codecProfile) to Main10/High (MAIN10_HIGH). Set "Level" (H265Settings > codecLevel) to 5 (LEVEL_5).

Property Type Required Description
redPrimaryX

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

redPrimaryY

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

greenPrimaryX

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

greenPrimaryY

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

bluePrimaryX

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

bluePrimaryY

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

whitePointX

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

whitePointY

integer

Minimum: 0

Maximum: 50000

False

HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.

maxFrameAverageLightLevel

integer

Minimum: 0

Maximum: 65535

False

Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter.

maxContentLightLevel

integer

Minimum: 0

Maximum: 65535

False

Maximum light level among all samples in the coded video sequence, in units of candelas per square meter.

maxLuminance

integer

Minimum: 0

Maximum: 2147483647

False

Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter.

minLuminance

integer

Minimum: 0

Maximum: 2147483647

False

Nominal minimum mastering display luminance in units of of 0.0001 candelas per square meter

HlsAdMarkers

  • ELEMENTAL

  • ELEMENTAL_SCTE35

HlsAudioTrackType

Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO

  • ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT

  • ALTERNATE_AUDIO_AUTO_SELECT

  • ALTERNATE_AUDIO_NOT_AUTO_SELECT

  • AUDIO_ONLY_VARIANT_STREAM

HlsCaptionLanguageMapping

Caption Language Mapping

Property Type Required Description
captionChannel

integer

Minimum: -2147483648

Maximum: 2147483647

False

Caption channel.

customLanguageCode

string

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

MinLength: 3

MaxLength: 3

False

Specify the language for this caption channel, using the ISO 639-2 or ISO 639-3 three-letter language code

languageCode

LanguageCode

False

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

languageDescription

string

False

Caption language description.

HlsCaptionLanguageSetting

Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

  • 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

Property Type Required Description
encryptionMethod

HlsEncryptionType

False

Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.

constantInitializationVector

string

Pattern: ^[0-9a-fA-F]{32}$

MinLength: 32

MaxLength: 32

False

This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default.

initializationVectorInManifest

HlsInitializationVectorInManifest

False

The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.

offlineEncrypted

HlsOfflineEncrypted

False

Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.

spekeKeyProvider

SpekeKeyProvider

False

Settings for use with a SPEKE key provider

staticKeyProvider

StaticKeyProvider

False

Use these settings to set up encryption with a static key provider.

type

HlsKeyProviderType

False

Indicates which type of key provider is used for 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

HlsManifestDurationFormat

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

HlsCaptionLanguageSetting

False

Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

captionLanguageMappings

Array of type HlsCaptionLanguageMapping

False

Language to be used on Caption outputs

destination

string

Pattern: ^s3:\/\/

False

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

destinationSettings

DestinationSettings

False

Settings associated with the destination. Will vary based on the type of destination

encryption

HlsEncryptionSettings

False

DRM settings.

timedMetadataId3Frame

HlsTimedMetadataId3Frame

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

HlsCodecSpecification

False

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

outputSelection

HlsOutputSelection

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: 2147483647

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

HlsDirectoryStructure

False

Indicates whether segments should be placed in subdirectories.

programDateTime

HlsProgramDateTime

False

Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

adMarkers

Array of type HlsAdMarkers

False

Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

segmentControl

HlsSegmentControl

False

When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

timestampDeltaMilliseconds

integer

Minimum: -2147483648

Maximum: 2147483647

False

Provides an extra millisecond delta offset to fine tune the timestamps.

manifestCompression

HlsManifestCompression

False

When set to GZIP, compresses HLS playlist.

clientCache

HlsClientCache

False

When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.

streamInfResolution

HlsStreamInfResolution

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

Indicates which type of key provider is used for encryption.

  • 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

Property Type Required Description
audioGroupId

string

False

Specifies the group to which the audio Rendition belongs.

audioRenditionSets

string

False

List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.

audioTrackType

HlsAudioTrackType

False

Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO

iFrameOnlyManifest

HlsIFrameOnlyManifest

False

When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest

segmentModifier

string

False

String concatenated to end of segment filenames. Accepts "Format Identifiers":#format_identifier_parameters.

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

Property Type Required Description
timecode

string

Format: timecode

Pattern: ^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$

False

Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format.

id3

string

Pattern: ^[A-Za-z0-9+\/]+={0,2}$

False

Use ID3 tag (Id3) to provide a tag value in base64-encode format.

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.

Input

Specifies media input

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

VideoSelector

False

Selector for video.

filterEnable

InputFilterEnable

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

InputPsiControl

False

Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.

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

InputDeblockFilter

False

Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully controllable for MPEG2 and uncompressed video inputs.

denoiseFilter

InputDenoiseFilter

False

Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.

timecodeSource

InputTimecodeSource

False

Timecode source under input settings (InputTimecodeSource) only affects the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Use this setting to specify whether the service counts frames by timecodes embedded in the video (EMBEDDED) or by starting the first frame at zero (ZEROBASED). In both cases, the timecode format is HH:MM:SS:FF or HH:MM:SS;FF, where FF is the frame number. Only set this to EMBEDDED if your source video has embedded timecodes.

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

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.

fileInput

string

Pattern: ^(s3:\/\/)([^\/]+\/)+([^\/\.]+|(([^\/]*)\.([mM]2[vV]|[mM][pP][eE][gG]|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL])))$

False

Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, "s3://bucket/vf/cpl.xml". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL.

decryptionSettings

InputDecryptionSettings

False

Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content.

supplementalImps

Array of type string

Pattern: ^s3:\/\/.*\/(ASSETMAP.xml)?$

False

Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you're using for your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the ASSETMAP.xml files. For example ["s3://bucket/ov/", "s3://bucket/vf2/ASSETMAP.xml"]. You don't need to specify the IMP that contains your input CPL, because the service automatically detects it.

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.

Property Type Required Description
endTimecode

string

Format: timecode

Pattern: ^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$

False

Set End timecode (EndTimecode) to the end of the portion of the input you are clipping. The frame corresponding to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for timecode source under input settings (InputTimecodeSource). For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end six minutes into the video, use 01:06:00:00.

startTimecode

string

Format: timecode

Pattern: ^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$

False

Set Start timecode (StartTimecode) to the beginning of the portion of the input you are clipping. The frame corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:05:00:00.

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

InputDecryptionSettings

Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content.

Property Type Required Description
decryptionMode

DecryptionMode

False

Specify the encryption mode that you used to encrypt your input files.

encryptedDecryptionKey

string

Pattern: ^[A-Za-z0-9+\/]+={0,2}$

MinLength: 24

MaxLength: 512

False

Warning! Don't provide your encryption key in plaintext. Your job settings could be intercepted, making your encrypted content vulnerable. Specify the encrypted version of the data key that you used to encrypt your content. The data key must be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or 256 bits.

initializationVector

string

Pattern: ^[A-Za-z0-9+\/]{22}==$|^[A-Za-z0-9+\/]{16}$

MinLength: 16

MaxLength: 24

False

Specify the initialization vector that you used when you encrypted your content before uploading it to Amazon S3. You can use a 16-byte initialization vector with any encryption mode. Or, you can use a 12-byte initialization vector with GCM or CTR. MediaConvert accepts only initialization vectors that are base64-encoded.

kmsKeyRegion

string

Pattern: ^[a-z-]{2,6}-(east|west|central|((north|south)(east|west)?))-[1-9]{1,2}$

MinLength: 9

MaxLength: 19

False

Specify the AWS Region for AWS Key Management Service (KMS) that you used to encrypt your data key, if that Region is different from the one you are using for AWS Elemental MediaConvert.

InputDenoiseFilter

Enable Denoise (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

InputTimecodeSource

Timecode source under input settings (InputTimecodeSource) only affects the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Use this setting to specify whether the service counts frames by timecodes embedded in the video (EMBEDDED) or by starting the first frame at zero (ZEROBASED). In both cases, the timecode format is HH:MM:SS:FF or HH:MM:SS;FF, where FF is the frame number. Only set this to EMBEDDED if your source video has embedded timecodes.

  • EMBEDDED

  • ZEROBASED

  • SPECIFIEDSTART

InsertableImage

Settings that specify how your still graphic overlay appears.

Property Type Required Description
width

integer

Minimum: 0

Maximum: 2147483647

False

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

height

integer

Minimum: 0

Maximum: 2147483647

False

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

imageX

integer

Minimum: 0

Maximum: 2147483647

False

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

imageY

integer

Minimum: 0

Maximum: 2147483647

False

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

duration

integer

Minimum: 0

Maximum: 2147483647

False

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

fadeIn

integer

Minimum: 0

Maximum: 2147483647

False

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

layer

integer

Minimum: 0

Maximum: 99

False

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

imageInserterInput

string

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

MinLength: 14

False

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

startTime

string

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

False

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

fadeOut

integer

Minimum: 0

Maximum: 2147483647

False

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

opacity

integer

Minimum: 0

Maximum: 100

False

Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50.

Job

Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Property Type Required Description
arn

string

False

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

id

string

False

A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources

createdAt

string

Format: date-time

False

The time, in Unix epoch format in seconds, when the job got created.

jobTemplate

string

False

The job template that the job is created from, if it is created from a job template.

queue

string

False

Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

userMetadata

object

False

User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

role

string

True

The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html

settings

JobSettings

True

JobSettings contains all the transcode settings for a job.

status

JobStatus

False

A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

errorCode

integer

Format: int32

False

Error code for the job

errorMessage

string

False

Error message of Job

timing

Timing

False

Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.

outputGroupDetails

Array of type OutputGroupDetail

False

List of output group details

billingTagsSource

BillingTagsSource

False

Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.

accelerationSettings

AccelerationSettings

False

Accelerated transcoding can significantly speed up jobs with long, visually complex content.

statusUpdateInterval

StatusUpdateInterval

False

Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.

jobPercentComplete

integer

False

An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, including audio-only jobs and jobs that use input clipping, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.

currentPhase

JobPhase

False

A job's phase can be PROBING, TRANSCODING OR UPLOADING

retryCount

integer

False

The number of times that the service automatically attempted to process your job after encountering an error.

JobPhase

A job's phase can be PROBING, TRANSCODING OR UPLOADING

  • PROBING

  • TRANSCODING

  • UPLOADING

JobSettings

JobSettings contains all the transcode settings for a job.

Property Type Required Description
timecodeConfig

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

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

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

NielsenConfiguration

False

Settings for Nielsen Configuration

motionImageInserter

MotionImageInserter

False

Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups.

esam

EsamSettings

False

Settings for Event Signaling And Messaging (ESAM).

inputs

Array of type Input

False

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

JobStatus

A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

  • SUBMITTED

  • PROGRESSING

  • COMPLETE

  • CANCELED

  • ERROR

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

ListJobsRequest

You can send list jobs requests with an empty body. Optionally, you can filter the response by queue and/or job status by specifying them in your request body. You can also optionally specify the maximum number, up to twenty, of jobs to be returned.

Property Type Required Description
queue

string

False

Provide a queue name to get back only jobs from that queue.

status

JobStatus

False

A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

order

Order

False

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

nextToken

string

False

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

maxResults

integer

Format: int32

Minimum: 1

Maximum: 20

False

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

ListJobsResponse

Successful list jobs requests return a JSON array of jobs. If you don't specify how they are ordered, you will receive the most recently created first.

Property Type Required Description
jobs

Array of type Job

False

List of jobs

nextToken

string

False

Use this string to request the next batch of jobs.

M2tsAudioBufferModel

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

  • DVB

  • ATSC

M2tsBufferModel

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

  • MULTIPLEX

  • NONE

M2tsEbpAudioInterval

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

  • VIDEO_AND_FIXED_INTERVALS

  • VIDEO_INTERVAL

M2tsEbpPlacement

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

  • VIDEO_AND_AUDIO_PIDS

  • VIDEO_PID

M2tsEsRateInPes

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

  • INCLUDE

  • EXCLUDE

M2tsForceTsVideoEbpOrder

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

  • FORCE

  • DEFAULT

M2tsNielsenId3

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

  • INSERT

  • NONE

M2tsPcrControl

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

  • PCR_EVERY_PES_PACKET

  • CONFIGURED_PCR_PERIOD

M2tsRateMode

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

  • VBR

  • CBR

M2tsScte35Esam

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

Property Type Required Description
scte35EsamPid

integer

Minimum: 32

Maximum: 8182

False

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

M2tsScte35Source

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

  • PASSTHROUGH

  • NONE

M2tsSegmentationMarkers

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

  • NONE

  • RAI_SEGSTART

  • RAI_ADAPT

  • PSI_SEGSTART

  • EBP

  • EBP_LEGACY

M2tsSegmentationStyle

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

  • MAINTAIN_CADENCE

  • RESET_CADENCE

M2tsSettings

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

Property Type Required Description
audioBufferModel

M2tsAudioBufferModel

False

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

minEbpInterval

integer

Minimum: 0

Maximum: 10000

False

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

esRateInPes

M2tsEsRateInPes

False

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

patInterval

integer

Minimum: 0

Maximum: 1000

False

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

dvbNitSettings

DvbNitSettings

False

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

dvbSdtSettings

DvbSdtSettings

False

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

scte35Source

M2tsScte35Source

False

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

scte35Pid

integer

Minimum: 32

Maximum: 8182

False

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

scte35Esam

M2tsScte35Esam

False

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

videoPid

integer

Minimum: 32

Maximum: 8182

False

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

dvbTdtSettings

DvbTdtSettings

False

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

pmtInterval

integer

Minimum: 0

Maximum: 1000

False

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

segmentationStyle

M2tsSegmentationStyle

False

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

segmentationTime

number

Format: float

Minimum: 0.0

False

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

pmtPid

integer

Minimum: 32

Maximum: 8182

False

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

bitrate

integer

Minimum: 0

Maximum: 2147483647

False

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

audioPids

Array of type integer

Minimum: 32

Maximum: 8182

False

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

privateMetadataPid

integer

Minimum: 32

Maximum: 8182

False

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

nielsenId3

M2tsNielsenId3

False

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

timedMetadataPid

integer

Minimum: 32

Maximum: 8182

False

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

maxPcrInterval

integer

Minimum: 0

Maximum: 500

False

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

transportStreamId

integer

Minimum: 0

Maximum: 65535

False

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

dvbSubPids

Array of type integer

Minimum: 32

Maximum: 8182

False

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

rateMode

M2tsRateMode

False

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

audioFramesPerPes

integer

Minimum: 0

Maximum: 2147483647

False

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

pcrControl

M2tsPcrControl

False

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

segmentationMarkers

M2tsSegmentationMarkers

False

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

ebpAudioInterval

M2tsEbpAudioInterval

False

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

forceTsVideoEbpOrder

M2tsForceTsVideoEbpOrder

False

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

programNumber

integer

Minimum: 0

Maximum: 65535

False

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

pcrPid

integer

Minimum: 32

Maximum: 8182

False

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

bufferModel

M2tsBufferModel

False

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

dvbTeletextPid

integer

Minimum: 32

Maximum: 8182

False

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

fragmentTime

number

Format: float

Minimum: 0.0

False

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

ebpPlacement

M2tsEbpPlacement

False

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

nullPacketBitrate

number

Format: float

Minimum: 0.0

False

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

M3u8NielsenId3

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

  • INSERT

  • NONE

M3u8PcrControl

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

  • PCR_EVERY_PES_PACKET

  • CONFIGURED_PCR_PERIOD

M3u8Scte35Source

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

  • PASSTHROUGH

  • NONE

M3u8Settings

Settings for TS segments in HLS

Property Type Required Description
audioFramesPerPes

integer

Minimum: 0

Maximum: 2147483647

False

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

pcrControl

M3u8PcrControl

False

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

pcrPid

integer

Minimum: 32

Maximum: 8182

False

Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID.

pmtPid

integer

Minimum: 32

Maximum: 8182

False

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

privateMetadataPid

integer

Minimum: 32

Maximum: 8182

False

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

programNumber

integer

Minimum: 0

Maximum: 65535

False

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

patInterval

integer

Minimum: 0

Maximum: 1000

False

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

pmtInterval

integer

Minimum: 0

Maximum: 1000

False

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

scte35Source

M3u8Scte35Source

False

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

scte35Pid

integer

Minimum: 32

Maximum: 8182

False

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

nielsenId3

M3u8NielsenId3

False

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

timedMetadata

TimedMetadata

False

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

timedMetadataPid

integer

Minimum: 32

Maximum: 8182

False

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

transportStreamId

integer

Minimum: 0

Maximum: 65535

False

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

videoPid

integer

Minimum: 32

Maximum: 8182

False

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

audioPids

Array of type integer

Minimum: 32

Maximum: 8182

False

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

MotionImageInserter

Overlay motion graphics on top of your video at the time that you specify.

Property Type Required Description
insertionMode

MotionImageInsertionMode

False

Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files.

input

string

Pattern: ^(s3:\/\/)(.*)(\.mov|[0-9]+\.png)$

MinLength: 14

MaxLength: 1285

False

Specify the .mov file or series of .png files that you want to overlay on your video. For .png files, provide the file name of the first file in the series. Make sure that the names of the .png files end with sequential numbers that specify the order that they are played in. For example, overlay_000.png, overlay_001.png, overlay_002.png, and so on. The sequence must start at zero, and each image file name must have the same number of digits. Pad your initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png, there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is overlay_00.png, there can be 100 images in the sequence.

offset

MotionImageInsertionOffset

False

Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling.

startTime

string

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

MinLength: 11

MaxLength: 11

False

Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource.

playback

MotionImagePlayback

False

Specify whether your motion graphic overlay repeats on a loop or plays only once.

framerate

MotionImageInsertionFramerate

False

If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video.

MotionImageInsertionFramerate

For motion overlays that don't have a built-in frame rate, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. The overlay frame rate doesn't need to match the frame rate of the underlying video.

Property Type Required Description
framerateNumerator

integer

Minimum: 1

Maximum: 2147483640

False

The top of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 24.

framerateDenominator

integer

Minimum: 1

Maximum: 17895697

False

The bottom of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 1.

MotionImageInsertionMode

Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files.

  • MOV

  • PNG

MotionImageInsertionOffset

Specify the offset between the upper-left corner of the video frame and the top left corner of the overlay.

Property Type Required Description
imageX

integer

Minimum: 0

Maximum: 2147483647

False

Set the distance, in pixels, between the overlay and the left edge of the video frame.

imageY

integer

Minimum: 0

Maximum: 2147483647

False

Set the distance, in pixels, between the overlay and the top edge of the video frame.

MotionImagePlayback

Specify whether your motion graphic overlay repeats on a loop or plays only once.

  • ONCE

  • REPEAT

MovClapAtom

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

  • INCLUDE

  • EXCLUDE

MovCslgAtom

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

  • INCLUDE

  • EXCLUDE

MovMpeg2FourCCControl

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

  • XDCAM

  • MPEG

MovPaddingControl

If set to OMNEON, inserts Omneon-compatible padding

  • OMNEON

  • NONE

MovReference

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

  • SELF_CONTAINED

  • EXTERNAL

MovSettings

Settings for MOV Container.

Property Type Required Description
clapAtom

MovClapAtom

False

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

cslgAtom

MovCslgAtom

False

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

paddingControl

MovPaddingControl

False

If set to OMNEON, inserts Omneon-compatible padding

reference

MovReference

False

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

mpeg2FourCCControl

MovMpeg2FourCCControl

False

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

Mp2Settings

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

Property Type Required Description
bitrate

integer

Minimum: 32000

Maximum: 384000

False

Average bitrate in bits/second.

channels

integer

Minimum: 1

Maximum: 2

False

Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2.

sampleRate

integer

Minimum: 32000

Maximum: 48000

False

Sample rate in hz.

Mp4CslgAtom

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

  • INCLUDE

  • EXCLUDE

Mp4FreeSpaceBox

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

  • INCLUDE

  • EXCLUDE

Mp4MoovPlacement

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

  • PROGRESSIVE_DOWNLOAD

  • NORMAL

Mp4Settings

Settings for MP4 Container

Property Type Required Description
cslgAtom

Mp4CslgAtom

False

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

freeSpaceBox

Mp4FreeSpaceBox

False

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

mp4MajorBrand

string

False

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

moovPlacement

Mp4MoovPlacement

False

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

Mpeg2AdaptiveQuantization

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

  • OFF

  • LOW

  • MEDIUM

  • HIGH

Mpeg2CodecLevel

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

  • AUTO

  • LOW

  • MAIN

  • HIGH1440

  • HIGH

Mpeg2CodecProfile

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

  • MAIN

  • PROFILE_422

Mpeg2DynamicSubGop

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

  • ADAPTIVE

  • STATIC

Mpeg2FramerateControl

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

Mpeg2FramerateConversionAlgorithm

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

  • DUPLICATE_DROP

  • INTERPOLATE

Mpeg2GopSizeUnits

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

  • FRAMES

  • SECONDS

Mpeg2InterlaceMode

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

  • PROGRESSIVE

  • TOP_FIELD

  • BOTTOM_FIELD

  • FOLLOW_TOP_FIELD

  • FOLLOW_BOTTOM_FIELD

Mpeg2IntraDcPrecision

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

  • AUTO

  • INTRA_DC_PRECISION_8

  • INTRA_DC_PRECISION_9

  • INTRA_DC_PRECISION_10

  • INTRA_DC_PRECISION_11

Mpeg2ParControl

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

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

Mpeg2QualityTuningLevel

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

  • SINGLE_PASS

  • MULTI_PASS

Mpeg2RateControlMode

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

  • VBR

  • CBR

Mpeg2SceneChangeDetect

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

  • DISABLED

  • ENABLED

Mpeg2Settings

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

Property Type Required Description
interlaceMode

Mpeg2InterlaceMode

False

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

parNumerator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio numerator.

syntax

Mpeg2Syntax

False

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

softness

integer

Minimum: 0

Maximum: 128

False

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

framerateDenominator

integer

Minimum: 1

Maximum: 1001

False

Frame rate denominator.

gopClosedCadence

integer

Minimum: 0

Maximum: 2147483647

False

Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.

hrdBufferInitialFillPercentage

integer

Minimum: 0

Maximum: 100

False

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

gopSize

number

Format: float

Minimum: 0.0

False

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

hrdBufferSize

integer

Minimum: 0

Maximum: 47185920

False

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

maxBitrate

integer

Minimum: 1000

Maximum: 300000000

False

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

slowPal

Mpeg2SlowPal

False

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

parDenominator

integer

Minimum: 1

Maximum: 2147483647

False

Pixel Aspect Ratio denominator.

spatialAdaptiveQuantization

Mpeg2SpatialAdaptiveQuantization

False

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

temporalAdaptiveQuantization

Mpeg2TemporalAdaptiveQuantization

False

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

bitrate

integer

Minimum: 1000

Maximum: 288000000

False

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

intraDcPrecision

Mpeg2IntraDcPrecision

False

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

framerateControl

Mpeg2FramerateControl

False

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

rateControlMode

Mpeg2RateControlMode

False

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

codecProfile

Mpeg2CodecProfile

False

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

telecine

Mpeg2Telecine

False

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

framerateNumerator

integer

Minimum: 24

Maximum: 60000

False

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

minIInterval

integer

Minimum: 0

Maximum: 30

False

Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1

adaptiveQuantization

Mpeg2AdaptiveQuantization

False

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

codecLevel

Mpeg2CodecLevel

False

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

sceneChangeDetect

Mpeg2SceneChangeDetect

False

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

qualityTuningLevel

Mpeg2QualityTuningLevel

False

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

framerateConversionAlgorithm

Mpeg2FramerateConversionAlgorithm

False

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

gopSizeUnits

Mpeg2GopSizeUnits

False

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

parControl

Mpeg2ParControl

False

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

numberBFramesBetweenReferenceFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

dynamicSubGop

Mpeg2DynamicSubGop

False

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

Mpeg2SlowPal

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

  • DISABLED

  • ENABLED

Mpeg2SpatialAdaptiveQuantization

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

  • DISABLED

  • ENABLED

Mpeg2Syntax

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

  • DEFAULT

  • D_10

Mpeg2Telecine

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

  • NONE

  • SOFT

  • HARD

Mpeg2TemporalAdaptiveQuantization

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

  • DISABLED

  • ENABLED

MsSmoothAudioDeduplication

COMBINE_DUPLICATE_STREAMS combines identical audio encoding settings across a Microsoft Smooth output group into a single audio stream.

  • COMBINE_DUPLICATE_STREAMS

  • NONE

MsSmoothEncryptionSettings

If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.

Property Type Required Description
spekeKeyProvider

SpekeKeyProvider

False

Settings for use with a SPEKE key provider

MsSmoothGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS.

Property Type Required Description
destination

string

Pattern: ^s3:\/\/

False

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

destinationSettings

DestinationSettings

False

Settings associated with the destination. Will vary based on the type of destination

fragmentLength

integer

Minimum: 1

Maximum: 2147483647

False

Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in seconds. Fragment length must be compatible with GOP size and frame rate.

encryption

MsSmoothEncryptionSettings

False

If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.

manifestEncoding

MsSmoothManifestEncoding

False

Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. Valid options are utf8 and utf16.

audioDeduplication

MsSmoothAudioDeduplication

False

COMBINE_DUPLICATE_STREAMS combines identical audio encoding settings across a Microsoft Smooth output group into a single audio stream.

MsSmoothManifestEncoding

Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. Valid options are utf8 and utf16.

  • UTF8

  • UTF16

NielsenConfiguration

Settings for Nielsen Configuration

Property Type Required Description
breakoutCode

integer

Minimum: 0

Maximum: 9

False

Use Nielsen Configuration (NielsenConfiguration) to set the Nielsen measurement system breakout code. Supported values are 0, 3, 7, and 9.

distributorId

string

False

Use Distributor ID (DistributorID) to specify the distributor ID that is assigned to your organization by Neilsen.

NoiseReducer

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

Property Type Required Description
filter

NoiseReducerFilter

False

Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain filter based on JND principles.

filterSettings

NoiseReducerFilterSettings

False

Settings for a noise reducer filter

spatialFilterSettings

NoiseReducerSpatialFilterSettings

False

Noise reducer filter settings for spatial filter.

NoiseReducerFilter

Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain filter based on JND principles.

  • BILATERAL

  • MEAN

  • GAUSSIAN

  • LANCZOS

  • SHARPEN

  • CONSERVE

  • SPATIAL

NoiseReducerFilterSettings

Settings for a noise reducer filter

Property Type Required Description
strength

integer

Minimum: 0

Maximum: 3

False

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

NoiseReducerSpatialFilterSettings

Noise reducer filter settings for spatial filter.

Property Type Required Description
strength

integer

Minimum: 0

Maximum: 16

False

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

speed

integer

Minimum: -2

Maximum: 3

False

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

postFilterSharpenStrength

integer

Minimum: 0

Maximum: 3

False

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

Order

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

  • ASCENDING

  • DESCENDING

Output

An output object describes the settings for a single output file or stream in an output group.

Property Type Required Description
containerSettings

ContainerSettings

False

Container specific settings.

preset

string

MinLength: 0

False

Use Preset (Preset) to specifiy a preset for your transcoding settings. Provide the system or custom preset name. You can specify either Preset (Preset) or Container settings (ContainerSettings), but not both.

videoDescription

VideoDescription

False

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

audioDescriptions

Array of type AudioDescription

False

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

outputSettings

OutputSettings

False

Specific settings for this type of output.

extension

string

False

Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)

nameModifier

string

MinLength: 1

False

Use Name modifier (NameModifier) to have the service add a string to the end of each output filename. You specify the base filename as part of your destination URI. When you create multiple outputs in the same output group, Name modifier (NameModifier) is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the output group.

captionDescriptions

Array of type CaptionDescription

False

(CaptionDescriptions) contains groups of captions settings. For each output that has captions, include one instance of (CaptionDescriptions). (CaptionDescriptions) can contain multiple groups of captions settings.

OutputChannelMapping

OutputChannel mapping settings.

Property Type Required Description
inputChannels

Array of type integer

Minimum: -60

Maximum: 6

False

List of input channels

OutputDetail

Details regarding output

Property Type Required Description
durationInMs

integer

False

Duration in milliseconds

videoDetails

VideoDetail

False

Contains details about the output's video stream

OutputGroup

Group of outputs

Property Type Required Description
customName

string

False

Use Custom Group Name (CustomName) to specify a name for the output group. This value is displayed on the console and can make your job settings JSON more human-readable. It does not affect your outputs. Use up to twelve characters that are either letters, numbers, spaces, or underscores.

name

string

False

Name of the output group

outputs

Array of type Output

False

This object holds groups of encoding settings, one group of settings per output.

outputGroupSettings

OutputGroupSettings

False

Output Group settings, including type

OutputGroupDetail

Contains details about the output groups specified in the job settings.

Property Type Required Description
outputDetails

Array of type OutputDetail

False

Details about the output

OutputGroupSettings

Output Group settings, including type

Property Type Required Description
type

OutputGroupType

False

Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)

hlsGroupSettings

HlsGroupSettings

False

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.

dashIsoGroupSettings

DashIsoGroupSettings

False

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS.

fileGroupSettings

FileGroupSettings

False

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILE_GROUP_SETTINGS.

msSmoothGroupSettings

MsSmoothGroupSettings

False