A Specific Job Template
URI
/2017-08-29/jobTemplates/
name
HTTP Methods
GET
Operation ID: GetJobTemplate
Retrieve the JSON for a specific job template.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name
|
String | True |
Responses
| Status Code | Response Model | Description |
|---|---|---|
200
|
GetJobTemplateResponse
|
200: |
400
|
ExceptionBody
|
400: The conditional request failed. The service can't process your request because of a problem in the request. Please check your request form and syntax. |
500
|
ExceptionBody
|
500: The service encountered an unexpected condition and cannot fulfill your request. |
403
|
ExceptionBody
|
403: You don't have permissions for this action with the credentials you sent. Please check your authorization credentials. You should be sending credentials using the AWS Signature Version 4 signing process. |
404
|
ExceptionBody
|
404: The resource you requested does not exist. |
429
|
ExceptionBody
|
429: Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. For example, you may be hitting your account limits for preset creation or job submission. |
409
|
ExceptionBody
|
409: The service could not complete your request because there is a conflict with the current state of the resource. For example, you may be trying to delete a Queue that has jobs processing. |
PUT
Operation ID: UpdateJobTemplate
Modify one of your existing job templates.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name
|
String | True |
Responses
| Status Code | Response Model | Description |
|---|---|---|
200
|
UpdateJobTemplateResponse
|
200: |
400
|
ExceptionBody
|
400: The conditional request failed. The service can't process your request because of a problem in the request. Please check your request form and syntax. |
500
|
ExceptionBody
|
500: The service encountered an unexpected condition and cannot fulfill your request. |
403
|
ExceptionBody
|
403: You don't have permissions for this action with the credentials you sent. Please check your authorization credentials. You should be sending credentials using the AWS Signature Version 4 signing process. |
404
|
ExceptionBody
|
404: The resource you requested does not exist. |
429
|
ExceptionBody
|
429: Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. For example, you may be hitting your account limits for preset creation or job submission. |
409
|
ExceptionBody
|
409: The service could not complete your request because there is a conflict with the current state of the resource. For example, you may be trying to delete a Queue that has jobs processing. |
DELETE
Operation ID: DeleteJobTemplate
Permanently delete a job template you have created.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name
|
String | True |
Responses
| Status Code | Response Model | Description |
|---|---|---|
400
|
ExceptionBody
|
400: The conditional request failed. The service can't process your request because of a problem in the request. Please check your request form and syntax. |
202
|
DeleteJobTemplateResponse
|
202: Your request has been accepted. Processing has not yet begun. |
500
|
ExceptionBody
|
500: The service encountered an unexpected condition and cannot fulfill your request. |
403
|
ExceptionBody
|
403: You don't have permissions for this action with the credentials you sent. Please check your authorization credentials. You should be sending credentials using the AWS Signature Version 4 signing process. |
404
|
ExceptionBody
|
404: The resource you requested does not exist. |
429
|
ExceptionBody
|
429: Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. For example, you may be hitting your account limits for preset creation or job submission. |
409
|
ExceptionBody
|
409: The service could not complete your request because there is a conflict with the current state of the resource. For example, you may be trying to delete a Queue that has jobs processing. |
Schemas
Request Bodies
Example GET
{ "name": "string" }
Example PUT
{ "settings": { "timecodeConfig": { "timestampOffset": "string", "anchor": "string", "start": "string", "source": enum }, "adAvailOffset": integer, "nielsenConfiguration": { "distributorId": "string", "breakoutCode": integer }, "inputs": [ { "audioSelectors": { }, "audioSelectorGroups": { }, "filterEnable": enum, "deblockFilter": enum, "videoSelector": { "colorSpace": enum, "hdr10Metadata": { "redPrimaryY": integer, "greenPrimaryY": integer, "whitePointX": integer, "maxLuminance": integer, "greenPrimaryX": integer, "whitePointY": integer, "redPrimaryX": integer, "bluePrimaryX": integer, "maxFrameAverageLightLevel": integer, "bluePrimaryY": integer, "maxContentLightLevel": integer, "minLuminance": integer }, "programNumber": integer, "pid": integer, "colorSpaceUsage": enum }, "filterStrength": integer, "programNumber": integer, "timecodeSource": enum, "captionSelectors": { }, "denoiseFilter": enum, "psiControl": enum, "inputClippings": [ { "startTimecode": "string", "endTimecode": "string" } ] } ], "outputGroups": [ { "outputs": [ { "extension": "string", "videoDescription": { "fixedAfd": integer, "scalingBehavior": enum, "respondToAfd": enum, "codecSettings": { "h265Settings": { "slices": integer, "minIInterval": integer, "parNumerator": integer, "flickerAdaptiveQuantization": enum, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "sampleAdaptiveOffsetFilterMode": enum, "temporalIds": enum, "slowPal": enum, "tiles": enum, "codecProfile": enum, "alternateTransferFunctionSei": enum, "unregisteredSeiTimecode": enum, "framerateControl": enum, "telecine": enum, "framerateConversionAlgorithm": enum, "codecLevel": enum, "numberReferenceFrames": integer, "temporalAdaptiveQuantization": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "numberBFramesBetweenReferenceFrames": integer, "gopClosedCadence": integer, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "gopBReference": enum, "sceneChangeDetect": enum, "parDenominator": integer, "parControl": enum, "rateControlMode": enum }, "codec": enum, "proresSettings": { "slowPal": enum, "framerateControl": enum, "telecine": enum, "framerateDenominator": integer, "framerateConversionAlgorithm": enum, "interlaceMode": enum, "codecProfile": enum, "parNumerator": integer, "parControl": enum, "parDenominator": integer, "framerateNumerator": integer }, "mpeg2Settings": { "minIInterval": integer, "parNumerator": integer, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "slowPal": enum, "codecProfile": enum, "intraDcPrecision": enum, "softness": integer, "framerateControl": enum, "telecine": enum, "framerateConversionAlgorithm": enum, "codecLevel": enum, "temporalAdaptiveQuantization": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "numberBFramesBetweenReferenceFrames": integer, "gopClosedCadence": integer, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "sceneChangeDetect": enum, "parDenominator": integer, "parControl": enum, "syntax": enum, "rateControlMode": enum }, "h264Settings": { "slices": integer, "minIInterval": integer, "parNumerator": integer, "flickerAdaptiveQuantization": enum, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "slowPal": enum, "codecProfile": enum, "unregisteredSeiTimecode": enum, "softness": integer, "framerateControl": enum, "telecine": enum, "framerateConversionAlgorithm": enum, "codecLevel": enum, "numberReferenceFrames": integer, "temporalAdaptiveQuantization": enum, "repeatPps": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "numberBFramesBetweenReferenceFrames": integer, "gopClosedCadence": integer, "fieldEncoding": enum, "entropyEncoding": enum, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "gopBReference": enum, "sceneChangeDetect": enum, "parDenominator": integer, "parControl": enum, "syntax": enum, "rateControlMode": enum }, "frameCaptureSettings": { "framerateDenominator": integer, "maxCaptures": integer, "framerateNumerator": integer, "quality": integer } }, "afdSignaling": enum, "colorMetadata": enum, "timecodeInsertion": enum, "width": integer, "sharpness": integer, "antiAlias": enum, "videoPreprocessors": { "timecodeBurnin": { "prefix": "string", "fontSize": integer, "position": enum }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "postFilterSharpenStrength": integer, "speed": integer } }, "colorCorrector": { "saturation": integer, "brightness": integer, "hdr10Metadata": { "redPrimaryY": integer, "greenPrimaryY": integer, "whitePointX": integer, "maxLuminance": integer, "greenPrimaryX": integer, "whitePointY": integer, "redPrimaryX": integer, "bluePrimaryX": integer, "maxFrameAverageLightLevel": integer, "bluePrimaryY": integer, "maxContentLightLevel": integer, "minLuminance": integer }, "contrast": integer, "hue": integer, "colorSpaceConversion": enum }, "imageInserter": { "insertableImages": [ { "duration": integer, "fadeOut": integer, "imageY": integer, "fadeIn": integer, "imageX": integer, "width": integer, "startTime": "string", "opacity": integer, "layer": integer, "height": integer, "imageInserterInput": "string" } ] }, "deinterlacer": { "mode": enum, "control": enum, "algorithm": enum } }, "position": { "width": integer, "x": integer, "y": integer, "height": integer }, "dropFrameTimecode": enum, "crop": { "width": integer, "x": integer, "y": integer, "height": integer }, "height": integer }, "audioDescriptions": [ { "languageCodeControl": enum, "audioTypeControl": enum, "remixSettings": { "channelsOut": integer, "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer }, "audioType": integer, "audioSourceName": "string", "codecSettings": { "codec": enum, "wavSettings": { "channels": integer, "bitDepth": integer, "sampleRate": integer }, "ac3Settings": { "dynamicRangeCompressionProfile": enum, "dialnorm": integer, "codingMode": enum, "metadataControl": enum, "lfeFilter": enum, "bitrate": integer, "bitstreamMode": enum, "sampleRate": integer }, "aacSettings": { "vbrQuality": enum, "codecProfile": enum, "codingMode": enum, "specification": enum, "bitrate": integer, "rawFormat": enum, "rateControlMode": enum, "sampleRate": integer, "audioDescriptionBroadcasterMix": enum }, "aiffSettings": { "channels": integer, "bitDepth": integer, "sampleRate": integer }, "eac3Settings": { "dialnorm": integer, "passthroughControl": enum, "metadataControl": enum, "bitrate": integer, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "ltRtSurroundMixLevel": number, "surroundExMode": enum, "dynamicRangeCompressionLine": enum, "lfeControl": enum, "codingMode": enum, "surroundMode": enum, "attenuationControl": enum, "lfeFilter": enum, "phaseControl": enum, "ltRtCenterMixLevel": number, "dcFilter": enum, "stereoDownmix": enum, "bitstreamMode": enum, "loRoSurroundMixLevel": number, "loRoCenterMixLevel": number }, "mp2Settings": { "channels": integer, "bitrate": integer, "sampleRate": integer } }, "languageCode": enum, "streamName": "string", "audioNormalizationSettings": { "targetLkfs": number, "algorithmControl": enum, "peakCalculation": enum, "loudnessLogging": enum, "correctionGateLevel": integer, "algorithm": enum } } ], "containerSettings": { "container": enum, "mp4Settings": { "mp4MajorBrand": "string", "moovPlacement": enum, "cslgAtom": enum, "freeSpaceBox": enum }, "m3u8Settings": { "pmtPid": integer, "pcrPid": integer, "audioPids": [ integer ], "audioFramesPerPes": integer, "scte35Pid": integer, "transportStreamId": integer, "videoPid": integer, "pcrControl": enum, "privateMetadataPid": integer, "pmtInterval": integer, "patInterval": integer, "programNumber": integer, "timedMetadataPid": integer, "timedMetadata": enum, "scte35Source": enum }, "m2tsSettings": { "dvbTeletextPid": integer, "bitrate": integer, "segmentationTime": number, "audioPids": [ integer ], "rateMode": enum, "ebpAudioInterval": enum, "fragmentTime": number, "audioFramesPerPes": integer, "maxPcrInterval": integer, "scte35Pid": integer, "privateMetadataPid": integer, "pmtInterval": integer, "segmentationStyle": enum, "audioBufferModel": enum, "programNumber": integer, "dvbNitSettings": { "networkName": "string", "networkId": integer, "nitInterval": integer }, "scte35Source": enum, "pmtPid": integer, "bufferModel": enum, "ebpPlacement": enum, "dvbSdtSettings": { "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string", "outputSdt": enum }, "nullPacketBitrate": number, "pcrPid": integer, "minEbpInterval": integer, "transportStreamId": integer, "pcrControl": enum, "videoPid": integer, "esRateInPes": enum, "segmentationMarkers": enum, "dvbTdtSettings": { "tdtInterval": integer }, "patInterval": integer, "dvbSubPids": [ integer ] }, "movSettings": { "reference": enum, "paddingControl": enum, "mpeg2FourCCControl": enum, "cslgAtom": enum, "clapAtom": enum }, "f4vSettings": { "moovPlacement": enum } }, "preset": "string", "outputSettings": { "hlsSettings": { "iFrameOnlyManifest": enum, "segmentModifier": "string", "audioTrackType": enum, "audioRenditionSets": "string", "audioGroupId": "string" } }, "captionDescriptions": [ { "captionSelectorName": "string", "languageDescription": "string", "languageCode": enum, "destinationSettings": { "burninDestinationSettings": { "xPosition": integer, "backgroundColor": enum, "teletextSpacing": enum, "yPosition": integer, "backgroundOpacity": integer, "fontOpacity": integer, "shadowOpacity": integer, "fontResolution": integer, "shadowYOffset": integer, "outlineSize": integer, "outlineColor": enum, "fontSize": integer, "shadowXOffset": integer, "alignment": enum, "shadowColor": enum, "fontColor": enum }, "teletextDestinationSettings": { "pageNumber": "string" }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "destinationType": enum, "dvbSubDestinationSettings": { "xPosition": integer, "backgroundColor": enum, "teletextSpacing": enum, "yPosition": integer, "backgroundOpacity": integer, "fontOpacity": integer, "shadowOpacity": integer, "fontResolution": integer, "shadowYOffset": integer, "outlineSize": integer, "outlineColor": enum, "fontSize": integer, "shadowXOffset": integer, "alignment": enum, "shadowColor": enum, "fontColor": enum }, "sccDestinationSettings": { "framerate": enum } } } ], "nameModifier": "string" } ], "outputGroupSettings": { "dashIsoGroupSettings": { "fragmentLength": integer, "baseUrl": "string", "minBufferTime": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" } }, "destination": "string", "segmentLength": integer, "segmentControl": enum, "hbbtvCompliance": enum }, "fileGroupSettings": { "destination": "string" }, "msSmoothGroupSettings": { "fragmentLength": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" } }, "audioDeduplication": enum, "manifestEncoding": enum, "destination": "string" }, "type": enum, "hlsGroupSettings": { "segmentsPerSubdirectory": integer, "streamInfResolution": enum, "timestampDeltaMilliseconds": integer, "outputSelection": enum, "captionLanguageMappings": [ { "languageDescription": "string", "captionChannel": integer, "languageCode": enum } ], "clientCache": enum, "codecSpecification": enum, "destination": "string", "segmentControl": enum, "timedMetadataId3Frame": enum, "timedMetadataId3Period": integer, "captionLanguageSetting": enum, "minSegmentLength": integer, "directoryStructure": enum, "programDateTime": enum, "baseUrl": "string", "encryption": { "initializationVectorInManifest": enum, "constantInitializationVector": "string", "staticKeyProvider": { "keyFormatVersions": "string", "keyFormat": "string", "staticKeyValue": "string", "url": "string" }, "type": enum, "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" }, "encryptionMethod": enum }, "adMarkers": [ enum ], "programDateTimePeriod": integer, "manifestCompression": enum, "segmentLength": integer, "manifestDurationFormat": enum } }, "name": "string", "customName": "string" } ], "timedMetadataInsertion": { "id3Insertions": [ { "id3": "string", "timecode": "string" } ] }, "availBlanking": { "availBlankingImage": "string" } }, "name": "string", "description": "string", "category": "string", "queue": "string" }
Example DELETE
{ "name": "string" }
Response Bodies
Example GetJobTemplateResponse
{ "jobTemplate": { "settings": { "timecodeConfig": { "timestampOffset": "string", "anchor": "string", "start": "string", "source": enum }, "adAvailOffset": integer, "nielsenConfiguration": { "distributorId": "string", "breakoutCode": integer }, "inputs": [ { "audioSelectors": { }, "audioSelectorGroups": { }, "filterEnable": enum, "deblockFilter": enum, "videoSelector": { "colorSpace": enum, "hdr10Metadata": { "redPrimaryY": integer, "greenPrimaryY": integer, "whitePointX": integer, "maxLuminance": integer, "greenPrimaryX": integer, "whitePointY": integer, "redPrimaryX": integer, "bluePrimaryX": integer, "maxFrameAverageLightLevel": integer, "bluePrimaryY": integer, "maxContentLightLevel": integer, "minLuminance": integer }, "programNumber": integer, "pid": integer, "colorSpaceUsage": enum }, "filterStrength": integer, "programNumber": integer, "timecodeSource": enum, "captionSelectors": { }, "denoiseFilter": enum, "psiControl": enum, "inputClippings": [ { "startTimecode": "string", "endTimecode": "string" } ] } ], "outputGroups": [ { "outputs": [ { "extension": "string", "videoDescription": { "fixedAfd": integer, "scalingBehavior": enum, "respondToAfd": enum, "codecSettings": { "h265Settings": { "slices": integer, "minIInterval": integer, "parNumerator": integer, "flickerAdaptiveQuantization": enum, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "sampleAdaptiveOffsetFilterMode": enum, "temporalIds": enum, "slowPal": enum, "tiles": enum, "codecProfile": enum, "alternateTransferFunctionSei": enum, "unregisteredSeiTimecode": enum, "framerateControl": enum, "telecine": enum, "framerateConversionAlgorithm": enum, "codecLevel": enum, "numberReferenceFrames": integer, "temporalAdaptiveQuantization": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "numberBFramesBetweenReferenceFrames": integer, "gopClosedCadence": integer, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "gopBReference": enum, "sceneChangeDetect": enum, "parDenominator": integer, "parControl": enum, "rateControlMode": enum }, "codec": enum, "proresSettings": { "slowPal": enum, "framerateControl": enum, "telecine": enum, "framerateDenominator": integer, "framerateConversionAlgorithm": enum, "interlaceMode": enum, "codecProfile": enum, "parNumerator": integer, "parControl": enum, "parDenominator": integer, "framerateNumerator": integer }, "mpeg2Settings": { "minIInterval": integer, "parNumerator": integer, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "slowPal": enum, "codecProfile": enum, "intraDcPrecision": enum, "softness": integer, "framerateControl": enum, "telecine": enum, "framerateConversionAlgorithm": enum, "codecLevel": enum, "temporalAdaptiveQuantization": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "numberBFramesBetweenReferenceFrames": integer, "gopClosedCadence": integer, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "sceneChangeDetect": enum, "parDenominator": integer, "parControl": enum, "syntax": enum, "rateControlMode": enum }, "h264Settings": { "slices": integer, "minIInterval": integer, "parNumerator": integer, "flickerAdaptiveQuantization": enum, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "slowPal": enum, "codecProfile": enum, "unregisteredSeiTimecode": enum, "softness": integer, "framerateControl": enum, "telecine": enum, "framerateConversionAlgorithm": enum, "codecLevel": enum, "numberReferenceFrames": integer, "temporalAdaptiveQuantization": enum, "repeatPps": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "numberBFramesBetweenReferenceFrames": integer, "gopClosedCadence": integer, "fieldEncoding": enum, "entropyEncoding": enum, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "gopBReference": enum, "sceneChangeDetect": enum, "parDenominator": integer, "parControl": enum, "syntax": enum, "rateControlMode": enum }, "frameCaptureSettings": { "framerateDenominator": integer, "maxCaptures": integer, "framerateNumerator": integer, "quality": integer } }, "afdSignaling": enum, "colorMetadata": enum, "timecodeInsertion": enum, "width": integer, "sharpness": integer, "antiAlias": enum, "videoPreprocessors": { "timecodeBurnin": { "prefix": "string", "fontSize": integer, "position": enum }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "postFilterSharpenStrength": integer, "speed": integer } }, "colorCorrector": { "saturation": integer, "brightness": integer, "hdr10Metadata": { "redPrimaryY": integer, "greenPrimaryY": integer, "whitePointX": integer, "maxLuminance": integer, "greenPrimaryX": integer, "whitePointY": integer, "redPrimaryX": integer, "bluePrimaryX": integer, "maxFrameAverageLightLevel": integer, "bluePrimaryY": integer, "maxContentLightLevel": integer, "minLuminance": integer }, "contrast": integer, "hue": integer, "colorSpaceConversion": enum }, "imageInserter": { "insertableImages": [ { "duration": integer, "fadeOut": integer, "imageY": integer, "fadeIn": integer, "imageX": integer, "width": integer, "startTime": "string", "opacity": integer, "layer": integer, "height": integer, "imageInserterInput": "string" } ] }, "deinterlacer": { "mode": enum, "control": enum, "algorithm": enum } }, "position": { "width": integer, "x": integer, "y": integer, "height": integer }, "dropFrameTimecode": enum, "crop": { "width": integer, "x": integer, "y": integer, "height": integer }, "height": integer }, "audioDescriptions": [ { "languageCodeControl": enum, "audioTypeControl": enum, "remixSettings": { "channelsOut": integer, "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer }, "audioType": integer, "audioSourceName": "string", "codecSettings": { "codec": enum, "wavSettings": { "channels": integer, "bitDepth": integer, "sampleRate": integer }, "ac3Settings": { "dynamicRangeCompressionProfile": enum, "dialnorm": integer, "codingMode": enum, "metadataControl": enum, "lfeFilter": enum, "bitrate": integer, "bitstreamMode": enum, "sampleRate": integer }, "aacSettings": { "vbrQuality": enum, "codecProfile": enum, "codingMode": enum, "specification": enum, "bitrate": integer, "rawFormat": enum, "rateControlMode": enum, "sampleRate": integer, "audioDescriptionBroadcasterMix": enum }, "aiffSettings": { "channels": integer, "bitDepth": integer, "sampleRate": integer }, "eac3Settings": { "dialnorm": integer, "passthroughControl": enum, "metadataControl": enum, "bitrate": integer, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "ltRtSurroundMixLevel": number, "surroundExMode": enum, "dynamicRangeCompressionLine": enum, "lfeControl": enum, "codingMode": enum, "surroundMode": enum, "attenuationControl": enum, "lfeFilter": enum, "phaseControl": enum, "ltRtCenterMixLevel": number, "dcFilter": enum, "stereoDownmix": enum, "bitstreamMode": enum, "loRoSurroundMixLevel": number, "loRoCenterMixLevel": number }, "mp2Settings": { "channels": integer, "bitrate": integer, "sampleRate": integer } }, "languageCode": enum, "streamName": "string", "audioNormalizationSettings": { "targetLkfs": number, "algorithmControl": enum, "peakCalculation": enum, "loudnessLogging": enum, "correctionGateLevel": integer, "algorithm": enum } } ], "containerSettings": { "container": enum, "mp4Settings": { "mp4MajorBrand": "string", "moovPlacement": enum, "cslgAtom": enum, "freeSpaceBox": enum }, "m3u8Settings": { "pmtPid": integer, "pcrPid": integer, "audioPids": [ integer ], "audioFramesPerPes": integer, "scte35Pid": integer, "transportStreamId": integer, "videoPid": integer, "pcrControl": enum, "privateMetadataPid": integer, "pmtInterval": integer, "patInterval": integer, "programNumber": integer, "timedMetadataPid": integer, "timedMetadata": enum, "scte35Source": enum }, "m2tsSettings": { "dvbTeletextPid": integer, "bitrate": integer, "segmentationTime": number, "audioPids": [ integer ], "rateMode": enum, "ebpAudioInterval": enum, "fragmentTime": number, "audioFramesPerPes": integer, "maxPcrInterval": integer, "scte35Pid": integer, "privateMetadataPid": integer, "pmtInterval": integer, "segmentationStyle": enum, "audioBufferModel": enum, "programNumber": integer, "dvbNitSettings": { "networkName": "string", "networkId": integer, "nitInterval": integer }, "scte35Source": enum, "pmtPid": integer, "bufferModel": enum, "ebpPlacement": enum, "dvbSdtSettings": { "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string", "outputSdt": enum }, "nullPacketBitrate": number, "pcrPid": integer, "minEbpInterval": integer, "transportStreamId": integer, "pcrControl": enum, "videoPid": integer, "esRateInPes": enum, "segmentationMarkers": enum, "dvbTdtSettings": { "tdtInterval": integer }, "patInterval": integer, "dvbSubPids": [ integer ] }, "movSettings": { "reference": enum, "paddingControl": enum, "mpeg2FourCCControl": enum, "cslgAtom": enum, "clapAtom": enum }, "f4vSettings": { "moovPlacement": enum } }, "preset": "string", "outputSettings": { "hlsSettings": { "iFrameOnlyManifest": enum, "segmentModifier": "string", "audioTrackType": enum, "audioRenditionSets": "string", "audioGroupId": "string" } }, "captionDescriptions": [ { "captionSelectorName": "string", "languageDescription": "string", "languageCode": enum, "destinationSettings": { "burninDestinationSettings": { "xPosition": integer, "backgroundColor": enum, "teletextSpacing": enum, "yPosition": integer, "backgroundOpacity": integer, "fontOpacity": integer, "shadowOpacity": integer, "fontResolution": integer, "shadowYOffset": integer, "outlineSize": integer, "outlineColor": enum, "fontSize": integer, "shadowXOffset": integer, "alignment": enum, "shadowColor": enum, "fontColor": enum }, "teletextDestinationSettings": { "pageNumber": "string" }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "destinationType": enum, "dvbSubDestinationSettings": { "xPosition": integer, "backgroundColor": enum, "teletextSpacing": enum, "yPosition": integer, "backgroundOpacity": integer, "fontOpacity": integer, "shadowOpacity": integer, "fontResolution": integer, "shadowYOffset": integer, "outlineSize": integer, "outlineColor": enum, "fontSize": integer, "shadowXOffset": integer, "alignment": enum, "shadowColor": enum, "fontColor": enum }, "sccDestinationSettings": { "framerate": enum } } } ], "nameModifier": "string" } ], "outputGroupSettings": { "dashIsoGroupSettings": { "fragmentLength": integer, "baseUrl": "string", "minBufferTime": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" } }, "destination": "string", "segmentLength": integer, "segmentControl": enum, "hbbtvCompliance": enum }, "fileGroupSettings": { "destination": "string" }, "msSmoothGroupSettings": { "fragmentLength": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" } }, "audioDeduplication": enum, "manifestEncoding": enum, "destination": "string" }, "type": enum, "hlsGroupSettings": { "segmentsPerSubdirectory": integer, "streamInfResolution": enum, "timestampDeltaMilliseconds": integer, "outputSelection": enum, "captionLanguageMappings": [ { "languageDescription": "string", "captionChannel": integer, "languageCode": enum } ], "clientCache": enum, "codecSpecification": enum, "destination": "string", "segmentControl": enum, "timedMetadataId3Frame": enum, "timedMetadataId3Period": integer, "captionLanguageSetting": enum, "minSegmentLength": integer, "directoryStructure": enum, "programDateTime": enum, "baseUrl": "string", "encryption": { "initializationVectorInManifest": enum, "constantInitializationVector": "string", "staticKeyProvider": { "keyFormatVersions": "string", "keyFormat": "string", "staticKeyValue": "string", "url": "string" }, "type": enum, "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" }, "encryptionMethod": enum }, "adMarkers": [ enum ], "programDateTimePeriod": integer, "manifestCompression": enum, "segmentLength": integer, "manifestDurationFormat": enum } }, "name": "string", "customName": "string" } ], "timedMetadataInsertion": { "id3Insertions": [ { "id3": "string", "timecode": "string" } ] }, "availBlanking": { "availBlankingImage": "string" } }, "lastUpdated": "string", "createdAt": "string", "name": "string", "description": "string", "category": "string", "type": enum, "arn": "string", "queue": "string" } }
Example UpdateJobTemplateResponse
{ "jobTemplate": { "settings": { "timecodeConfig": { "timestampOffset": "string", "anchor": "string", "start": "string", "source": enum }, "adAvailOffset": integer, "nielsenConfiguration": { "distributorId": "string", "breakoutCode": integer }, "inputs": [ { "audioSelectors": { }, "audioSelectorGroups": { }, "filterEnable": enum, "deblockFilter": enum, "videoSelector": { "colorSpace": enum, "hdr10Metadata": { "redPrimaryY": integer, "greenPrimaryY": integer, "whitePointX": integer, "maxLuminance": integer, "greenPrimaryX": integer, "whitePointY": integer, "redPrimaryX": integer, "bluePrimaryX": integer, "maxFrameAverageLightLevel": integer, "bluePrimaryY": integer, "maxContentLightLevel": integer, "minLuminance": integer }, "programNumber": integer, "pid": integer, "colorSpaceUsage": enum }, "filterStrength": integer, "programNumber": integer, "timecodeSource": enum, "captionSelectors": { }, "denoiseFilter": enum, "psiControl": enum, "inputClippings": [ { "startTimecode": "string", "endTimecode": "string" } ] } ], "outputGroups": [ { "outputs": [ { "extension": "string", "videoDescription": { "fixedAfd": integer, "scalingBehavior": enum, "respondToAfd": enum, "codecSettings": { "h265Settings": { "slices": integer, "minIInterval": integer, "parNumerator": integer, "flickerAdaptiveQuantization": enum, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "sampleAdaptiveOffsetFilterMode": enum, "temporalIds": enum, "slowPal": enum, "tiles": enum, "codecProfile": enum, "alternateTransferFunctionSei": enum, "unregisteredSeiTimecode": enum, "framerateControl": enum, "telecine": enum, "framerateConversionAlgorithm": enum, "codecLevel": enum, "numberReferenceFrames": integer, "temporalAdaptiveQuantization": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "numberBFramesBetweenReferenceFrames": integer, "gopClosedCadence": integer, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "gopBReference": enum, "sceneChangeDetect": enum, "parDenominator": integer, "parControl": enum, "rateControlMode": enum }, "codec": enum, "proresSettings": { "slowPal": enum, "framerateControl": enum, "telecine": enum, "framerateDenominator": integer, "framerateConversionAlgorithm": enum, "interlaceMode": enum, "codecProfile": enum, "parNumerator": integer, "parControl": enum, "parDenominator": integer, "framerateNumerator": integer }, "mpeg2Settings": { "minIInterval": integer, "parNumerator": integer, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "slowPal": enum, "codecProfile": enum, "intraDcPrecision": enum, "softness": integer, "framerateControl": enum, "telecine": enum, "framerateConversionAlgorithm": enum, "codecLevel": enum, "temporalAdaptiveQuantization": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "numberBFramesBetweenReferenceFrames": integer, "gopClosedCadence": integer, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "sceneChangeDetect": enum, "parDenominator": integer, "parControl": enum, "syntax": enum, "rateControlMode": enum }, "h264Settings": { "slices": integer, "minIInterval": integer, "parNumerator": integer, "flickerAdaptiveQuantization": enum, "gopSizeUnits": enum, "hrdBufferSize": integer, "qualityTuningLevel": enum, "maxBitrate": integer, "bitrate": integer, "spatialAdaptiveQuantization": enum, "slowPal": enum, "codecProfile": enum, "unregisteredSeiTimecode": enum, "softness": integer, "framerateControl": enum, "telecine": enum, "framerateConversionAlgorithm": enum, "codecLevel": enum, "numberReferenceFrames": integer, "temporalAdaptiveQuantization": enum, "repeatPps": enum, "hrdBufferInitialFillPercentage": integer, "framerateNumerator": integer, "numberBFramesBetweenReferenceFrames": integer, "gopClosedCadence": integer, "fieldEncoding": enum, "entropyEncoding": enum, "framerateDenominator": integer, "adaptiveQuantization": enum, "interlaceMode": enum, "gopSize": number, "gopBReference": enum, "sceneChangeDetect": enum, "parDenominator": integer, "parControl": enum, "syntax": enum, "rateControlMode": enum }, "frameCaptureSettings": { "framerateDenominator": integer, "maxCaptures": integer, "framerateNumerator": integer, "quality": integer } }, "afdSignaling": enum, "colorMetadata": enum, "timecodeInsertion": enum, "width": integer, "sharpness": integer, "antiAlias": enum, "videoPreprocessors": { "timecodeBurnin": { "prefix": "string", "fontSize": integer, "position": enum }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "postFilterSharpenStrength": integer, "speed": integer } }, "colorCorrector": { "saturation": integer, "brightness": integer, "hdr10Metadata": { "redPrimaryY": integer, "greenPrimaryY": integer, "whitePointX": integer, "maxLuminance": integer, "greenPrimaryX": integer, "whitePointY": integer, "redPrimaryX": integer, "bluePrimaryX": integer, "maxFrameAverageLightLevel": integer, "bluePrimaryY": integer, "maxContentLightLevel": integer, "minLuminance": integer }, "contrast": integer, "hue": integer, "colorSpaceConversion": enum }, "imageInserter": { "insertableImages": [ { "duration": integer, "fadeOut": integer, "imageY": integer, "fadeIn": integer, "imageX": integer, "width": integer, "startTime": "string", "opacity": integer, "layer": integer, "height": integer, "imageInserterInput": "string" } ] }, "deinterlacer": { "mode": enum, "control": enum, "algorithm": enum } }, "position": { "width": integer, "x": integer, "y": integer, "height": integer }, "dropFrameTimecode": enum, "crop": { "width": integer, "x": integer, "y": integer, "height": integer }, "height": integer }, "audioDescriptions": [ { "languageCodeControl": enum, "audioTypeControl": enum, "remixSettings": { "channelsOut": integer, "channelMapping": { "outputChannels": [ { "inputChannels": [ integer ] } ] }, "channelsIn": integer }, "audioType": integer, "audioSourceName": "string", "codecSettings": { "codec": enum, "wavSettings": { "channels": integer, "bitDepth": integer, "sampleRate": integer }, "ac3Settings": { "dynamicRangeCompressionProfile": enum, "dialnorm": integer, "codingMode": enum, "metadataControl": enum, "lfeFilter": enum, "bitrate": integer, "bitstreamMode": enum, "sampleRate": integer }, "aacSettings": { "vbrQuality": enum, "codecProfile": enum, "codingMode": enum, "specification": enum, "bitrate": integer, "rawFormat": enum, "rateControlMode": enum, "sampleRate": integer, "audioDescriptionBroadcasterMix": enum }, "aiffSettings": { "channels": integer, "bitDepth": integer, "sampleRate": integer }, "eac3Settings": { "dialnorm": integer, "passthroughControl": enum, "metadataControl": enum, "bitrate": integer, "dynamicRangeCompressionRf": enum, "sampleRate": integer, "ltRtSurroundMixLevel": number, "surroundExMode": enum, "dynamicRangeCompressionLine": enum, "lfeControl": enum, "codingMode": enum, "surroundMode": enum, "attenuationControl": enum, "lfeFilter": enum, "phaseControl": enum, "ltRtCenterMixLevel": number, "dcFilter": enum, "stereoDownmix": enum, "bitstreamMode": enum, "loRoSurroundMixLevel": number, "loRoCenterMixLevel": number }, "mp2Settings": { "channels": integer, "bitrate": integer, "sampleRate": integer } }, "languageCode": enum, "streamName": "string", "audioNormalizationSettings": { "targetLkfs": number, "algorithmControl": enum, "peakCalculation": enum, "loudnessLogging": enum, "correctionGateLevel": integer, "algorithm": enum } } ], "containerSettings": { "container": enum, "mp4Settings": { "mp4MajorBrand": "string", "moovPlacement": enum, "cslgAtom": enum, "freeSpaceBox": enum }, "m3u8Settings": { "pmtPid": integer, "pcrPid": integer, "audioPids": [ integer ], "audioFramesPerPes": integer, "scte35Pid": integer, "transportStreamId": integer, "videoPid": integer, "pcrControl": enum, "privateMetadataPid": integer, "pmtInterval": integer, "patInterval": integer, "programNumber": integer, "timedMetadataPid": integer, "timedMetadata": enum, "scte35Source": enum }, "m2tsSettings": { "dvbTeletextPid": integer, "bitrate": integer, "segmentationTime": number, "audioPids": [ integer ], "rateMode": enum, "ebpAudioInterval": enum, "fragmentTime": number, "audioFramesPerPes": integer, "maxPcrInterval": integer, "scte35Pid": integer, "privateMetadataPid": integer, "pmtInterval": integer, "segmentationStyle": enum, "audioBufferModel": enum, "programNumber": integer, "dvbNitSettings": { "networkName": "string", "networkId": integer, "nitInterval": integer }, "scte35Source": enum, "pmtPid": integer, "bufferModel": enum, "ebpPlacement": enum, "dvbSdtSettings": { "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string", "outputSdt": enum }, "nullPacketBitrate": number, "pcrPid": integer, "minEbpInterval": integer, "transportStreamId": integer, "pcrControl": enum, "videoPid": integer, "esRateInPes": enum, "segmentationMarkers": enum, "dvbTdtSettings": { "tdtInterval": integer }, "patInterval": integer, "dvbSubPids": [ integer ] }, "movSettings": { "reference": enum, "paddingControl": enum, "mpeg2FourCCControl": enum, "cslgAtom": enum, "clapAtom": enum }, "f4vSettings": { "moovPlacement": enum } }, "preset": "string", "outputSettings": { "hlsSettings": { "iFrameOnlyManifest": enum, "segmentModifier": "string", "audioTrackType": enum, "audioRenditionSets": "string", "audioGroupId": "string" } }, "captionDescriptions": [ { "captionSelectorName": "string", "languageDescription": "string", "languageCode": enum, "destinationSettings": { "burninDestinationSettings": { "xPosition": integer, "backgroundColor": enum, "teletextSpacing": enum, "yPosition": integer, "backgroundOpacity": integer, "fontOpacity": integer, "shadowOpacity": integer, "fontResolution": integer, "shadowYOffset": integer, "outlineSize": integer, "outlineColor": enum, "fontSize": integer, "shadowXOffset": integer, "alignment": enum, "shadowColor": enum, "fontColor": enum }, "teletextDestinationSettings": { "pageNumber": "string" }, "ttmlDestinationSettings": { "stylePassthrough": enum }, "destinationType": enum, "dvbSubDestinationSettings": { "xPosition": integer, "backgroundColor": enum, "teletextSpacing": enum, "yPosition": integer, "backgroundOpacity": integer, "fontOpacity": integer, "shadowOpacity": integer, "fontResolution": integer, "shadowYOffset": integer, "outlineSize": integer, "outlineColor": enum, "fontSize": integer, "shadowXOffset": integer, "alignment": enum, "shadowColor": enum, "fontColor": enum }, "sccDestinationSettings": { "framerate": enum } } } ], "nameModifier": "string" } ], "outputGroupSettings": { "dashIsoGroupSettings": { "fragmentLength": integer, "baseUrl": "string", "minBufferTime": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" } }, "destination": "string", "segmentLength": integer, "segmentControl": enum, "hbbtvCompliance": enum }, "fileGroupSettings": { "destination": "string" }, "msSmoothGroupSettings": { "fragmentLength": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" } }, "audioDeduplication": enum, "manifestEncoding": enum, "destination": "string" }, "type": enum, "hlsGroupSettings": { "segmentsPerSubdirectory": integer, "streamInfResolution": enum, "timestampDeltaMilliseconds": integer, "outputSelection": enum, "captionLanguageMappings": [ { "languageDescription": "string", "captionChannel": integer, "languageCode": enum } ], "clientCache": enum, "codecSpecification": enum, "destination": "string", "segmentControl": enum, "timedMetadataId3Frame": enum, "timedMetadataId3Period": integer, "captionLanguageSetting": enum, "minSegmentLength": integer, "directoryStructure": enum, "programDateTime": enum, "baseUrl": "string", "encryption": { "initializationVectorInManifest": enum, "constantInitializationVector": "string", "staticKeyProvider": { "keyFormatVersions": "string", "keyFormat": "string", "staticKeyValue": "string", "url": "string" }, "type": enum, "spekeKeyProvider": { "resourceId": "string", "systemIds": [ "string" ], "url": "string" }, "encryptionMethod": enum }, "adMarkers": [ enum ], "programDateTimePeriod": integer, "manifestCompression": enum, "segmentLength": integer, "manifestDurationFormat": enum } }, "name": "string", "customName": "string" } ], "timedMetadataInsertion": { "id3Insertions": [ { "id3": "string", "timecode": "string" } ] }, "availBlanking": { "availBlankingImage": "string" } }, "lastUpdated": "string", "createdAt": "string", "name": "string", "description": "string", "category": "string", "type": enum, "arn": "string", "queue": "string" } }
Example DeleteJobTemplateResponse
{ }
Example ExceptionBody
{ "message": "string" }
Properties
AacAudioDescriptionBroadcasterMix (enum)
Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType.
-
BROADCASTER_MIXED_AD
-
NORMAL
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
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
Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
-
MPEG2
-
MPEG4
VBR quality level. Only used if the rate control mode (AacRateControlMode) is VBR.
-
LOW
-
MEDIUM_LOW
-
MEDIUM_HIGH
-
HIGH
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
Dolby Digital coding mode. Determines number of channels.
-
CODING_MODE_1_0
-
CODING_MODE_1_1
-
CODING_MODE_2_0
-
CODING_MODE_3_2_LFE
Ac3DynamicRangeCompressionProfile (enum)
If set to FILM_STANDARD, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
-
FILM_STANDARD
-
NONE
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.
-
ENABLED
-
DISABLED
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
This setting only applies to H.264 and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to whether there are 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
Enable Anti-alias (AntiAlias) to enhance sharp edges in video output when your input resolution is much larger than your output resolution. Default is enabled.
-
DISABLED
-
ENABLED
When an "Audio Description":#audio_description specifies an AudioSelector or AudioSelectorGroup for which no matching source is found in the input, then the audio selector marked as DEFAULT will be used. If none are marked as default, silence will be inserted for the duration of the input.
-
DEFAULT
-
NOT_DEFAULT
AudioLanguageCodeControl (enum)
Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The language specified for languageCode' will be used when USE_CONFIGURED is selected or when FOLLOW_INPUT is selected but there is no ISO 639 language code specified by the input.
-
FOLLOW_INPUT
-
USE_CONFIGURED
AudioNormalizationAlgorithm (enum)
Audio normalization algorithm to use. 1770-1 conforms to the CALM Act specification, 1770-2 conforms to the EBU R-128 specification.
-
ITU_BS_1770_1
-
ITU_BS_1770_2
AudioNormalizationAlgorithmControl (enum)
When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.
-
CORRECT_AUDIO
-
MEASURE_ONLY
AudioNormalizationLoudnessLogging (enum)
If set to LOG, log each output's audio track loudness to a CSV file.
-
LOG
-
DONT_LOG
AudioNormalizationPeakCalculation (enum)
If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.
-
TRUE_PEAK
-
NONE
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
BurninSubtitleAlignment (enum)
If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
CENTERED
-
LEFT
BurninSubtitleBackgroundColor (enum)
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
-
NONE
-
BLACK
-
WHITE
BurninSubtitleFontColor (enum)
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
WHITE
-
BLACK
-
YELLOW
-
RED
-
GREEN
-
BLUE
BurninSubtitleOutlineColor (enum)
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
BLACK
-
WHITE
-
YELLOW
-
RED
-
GREEN
-
BLUE
BurninSubtitleShadowColor (enum)
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
-
NONE
-
BLACK
-
WHITE
BurninSubtitleTeletextSpacing (enum)
Controls whether a fixed grid size or proportional font spacing will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
-
FIXED_GRID
-
PROPORTIONAL
Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.
-
ANCILLARY
-
DVB_SUB
-
EMBEDDED
-
SCC
-
TTML
-
STL
-
SRT
-
TELETEXT
-
NULL_SOURCE
| Property | Type | Required | Description |
|---|---|---|---|
outputChannels
|
Array of type OutputChannelMapping |
True |
Enable Insert color metadata (ColorMetadata) to include color metadata in this output. This setting is enabled by default.
-
IGNORE
-
INSERT
Specifies the colorspace of an input. This setting works in tandem with "Color Corrector":#color_corrector > color_space_conversion to determine if any conversion will be performed.
-
FOLLOW
-
REC_601
-
REC_709
-
HDR10
-
HLG_2020
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
There are two sources for color metadata, the input file and the job configuration. This enum controls which takes precedence. FORCE: 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: 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
Container for this output. Some containers require a container settings object. If not specified, the default object will be created.
-
F4V
-
ISMV
-
M2TS
-
M3U8
-
MOV
-
MP4
-
MPD
-
MXF
-
RAW
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
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
- 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
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
| Property | Type | Required | Description |
|---|---|---|---|
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
If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
CENTERED
-
LEFT
DvbSubtitleBackgroundColor (enum)
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
-
NONE
-
BLACK
-
WHITE
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
WHITE
-
BLACK
-
YELLOW
-
RED
-
GREEN
-
BLUE
DvbSubtitleOutlineColor (enum)
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
-
BLACK
-
WHITE
-
YELLOW
-
RED
-
GREEN
-
BLUE
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
-
NONE
-
BLACK
-
WHITE
DvbSubtitleTeletextSpacing (enum)
Controls whether a fixed grid size or proportional font spacing will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
-
FIXED_GRID
-
PROPORTIONAL
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
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
Dolby Digital Plus coding mode. Determines number of channels.
-
CODING_MODE_1_0
-
CODING_MODE_2_0
-
CODING_MODE_3_2
Eac3DynamicRangeCompressionLine (enum)
Enables Dynamic Range Compression that restricts the absolute peak level for a signal.
-
NONE
-
FILM_STANDARD
-
FILM_LIGHT
-
MUSIC_STANDARD
-
MUSIC_LIGHT
-
SPEECH
Eac3DynamicRangeCompressionRf (enum)
Enables Heavy Dynamic Range Compression, ensures that the instantaneous signal peaks do not exceed specified levels.
-
NONE
-
FILM_STANDARD
-
FILM_LIGHT
-
MUSIC_STANDARD
-
MUSIC_LIGHT
-
SPEECH
When encoding 3/2 audio, controls whether the LFE channel is enabled
-
LFE
-
NO_LFE
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.
-
ENABLED
-
DISABLED
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
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
Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode.
-
SHIFT_90_DEGREES
-
NO_SHIFT
Stereo downmix preference. Only used for 3/2 coding mode.
-
NOT_INDICATED
-
LO_RO
-
LT_RT
-
DPL2
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
When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
-
NOT_INDICATED
-
ENABLED
-
DISABLED
EmbeddedConvert608To708 (enum)
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
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
FileSourceConvert608To708 (enum)
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
H264AdaptiveQuantization (enum)
Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
-
OFF
-
LOW
-
MEDIUM
-
HIGH
-
HIGHER
-
MAX
H.264 Level.
-
AUTO
-
LEVEL_1
-
LEVEL_1_1
-
LEVEL_1_2
-
LEVEL_1_3
-
LEVEL_2
-
LEVEL_2_1
-
LEVEL_2_2
-
LEVEL_3
-
LEVEL_3_1
-
LEVEL_3_2
-
LEVEL_4
-
LEVEL_4_1
-
LEVEL_4_2
-
LEVEL_5
-
LEVEL_5_1
-
LEVEL_5_2
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
Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC.
-
CABAC
-
CAVLC
Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.
-
PAFF
-
FORCE_FIELD
H264FlickerAdaptiveQuantization (enum)
Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
-
DISABLED
-
ENABLED
Using the API, set FramerateControl to INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Using the console, do this by choosing INITIALIZE_FROM_SOURCE for Framerate.
-
INITIALIZE_FROM_SOURCE
-
SPECIFIED
H264FramerateConversionAlgorithm (enum)
When set to INTERPOLATE, produces smoother motion during framerate conversion.
-
DUPLICATE_DROP
-
INTERPOLATE
If enable, use reference B frames for GOP structures that have B frames > 1.
-
DISABLED
-
ENABLED
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
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
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
Use Quality tuning level (H264QualityTuningLevel) to specify whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding.
-
SINGLE_PASS
-
SINGLE_PASS_HQ
-
MULTI_PASS_HQ
Rate control mode. CQ uses constant quantizer (qp), ABR (average bitrate) does not write HRD parameters.
-
VBR
-
CBR
Places a PPS header on each encoded picture, even if repeated.
-
DISABLED
-
ENABLED
Scene change detection (inserts I-frames on scene changes).
-
DISABLED
-
ENABLED
Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.
-
DISABLED
-
ENABLED
H264SpatialAdaptiveQuantization (enum)
Adjust quantization within each frame based on spatial variation of content complexity.
-
DISABLED
-
ENABLED
This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.
-
NONE
-
SOFT
-
HARD
H264TemporalAdaptiveQuantization (enum)
Adjust quantization within each frame based on temporal variation of content complexity.
-
DISABLED
-
ENABLED
H264UnregisteredSeiTimecode (enum)
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.
-
DISABLED
-
ENABLED
H265AdaptiveQuantization (enum)
Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
-
OFF
-
LOW
-
MEDIUM
-
HIGH
-
HIGHER
-
MAX
H265AlternateTransferFunctionSei (enum)
Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF).
-
DISABLED
-
ENABLED
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
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
H265FlickerAdaptiveQuantization (enum)
Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
-
DISABLED
-
ENABLED
Using the API, set FramerateControl to INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Using the console, do this by choosing INITIALIZE_FROM_SOURCE for Framerate.
-
INITIALIZE_FROM_SOURCE
-
SPECIFIED
H265FramerateConversionAlgorithm (enum)
When set to INTERPOLATE, produces smoother motion during framerate conversion.
-
DUPLICATE_DROP
-
INTERPOLATE
If enable, use reference B frames for GOP structures that have B frames > 1.
-
DISABLED
-
ENABLED
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
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
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
Use Quality tuning level (H265QualityTuningLevel) to specify whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding.
-
SINGLE_PASS
-
SINGLE_PASS_HQ
-
MULTI_PASS_HQ
Rate control mode. CQ uses constant quantizer (qp), ABR (average bitrate) does not write HRD parameters.
-
VBR
-
CBR
H265SampleAdaptiveOffsetFilterMode (enum)
Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content
-
DEFAULT
-
ADAPTIVE
-
OFF
Scene change detection (inserts I-frames on scene changes).
-
DISABLED
-
ENABLED
Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.
-
DISABLED
-
ENABLED
H265SpatialAdaptiveQuantization (enum)
Adjust quantization within each frame based on spatial variation of content complexity.
-
DISABLED
-
ENABLED
This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.
-
NONE
-
SOFT
-
HARD
H265TemporalAdaptiveQuantization (enum)
Adjust quantization within each frame based on temporal variation of content complexity.
-
DISABLED
-
ENABLED
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
Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures.
-
DISABLED
-
ENABLED
H265UnregisteredSeiTimecode (enum)
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.
-
DISABLED
-
ENABLED
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
HlsCaptionLanguageSetting (enum)
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
When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.
-
DISABLED
-
ENABLED
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
-
RFC_6381
-
RFC_4281
Indicates whether segments should be placed in subdirectories.
-
SINGLE_DIRECTORY
-
SUBDIRECTORY_PER_STREAM
Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.
-
AES128
-
SAMPLE_AES
| Property | Type | Required | Description |
|---|---|---|---|
segmentsPerSubdirectory
|
integer Minimum: 1 Maximum: 2147483647 |
False |
Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect. |
streamInfResolution
|
string |
False | |
timestampDeltaMilliseconds
|
integer Minimum: -2147483648 Maximum: 2147483647 |
False |
Provides an extra millisecond delta offset to fine tune the timestamps. |
outputSelection
|
string |
False | |
captionLanguageMappings
|
Array of type HlsCaptionLanguageMapping |
False | |
clientCache
|
string |
False | |
codecSpecification
|
string |
False | |
destination
|
string
Pattern: |
True |
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. |
segmentControl
|
string |
False | |
timedMetadataId3Frame
|
string |
False | |
timedMetadataId3Period
|
integer Minimum: -2147483648 Maximum: 2147483647 |
False |
Timed Metadata interval in seconds. |
captionLanguageSetting
|
string |
False | |
minSegmentLength
|
integer Minimum: 0 Maximum: 2147483647 |
True |
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. |
directoryStructure
|
string |
False | |
programDateTime
|
string |
False | |
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. |
encryption
|
False |
DRM settings. |
|
adMarkers
|
Array of type string |
False |
Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs. |
programDateTimePeriod
|
integer Minimum: 0 Maximum: 3600 |
False |
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. |
manifestCompression
|
string |
False | |
segmentLength
|
integer Minimum: 1 Maximum: 2147483647 |
True |
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. |
manifestDurationFormat
|
string |
False |
When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest
-
INCLUDE
-
EXCLUDE
HlsInitializationVectorInManifest (enum)
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
Indicates which type of key provider is used for encryption.
-
SPEKE
-
STATIC_KEY
HlsManifestDurationFormat (enum)
Indicates whether the output manifest should use floating point values for segment duration.
-
FLOATING_POINT
-
INTEGER
Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
-
MANIFESTS_AND_SEGMENTS
-
SEGMENTS_ONLY
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
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
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
-
INCLUDE
-
EXCLUDE
| Property | Type | Required | Description |
|---|---|---|---|
insertableImages
|
Array of type InsertableImage |
True |
Image to insert. Must be 32 bit windows BMP, PNG, or TGA file. Must not be larger than the output frames. |
Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully controllable for MPEG2 and uncompressed video inputs.
-
ENABLED
-
DISABLED
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
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 input is filtered regardless of input type.
-
AUTO
-
DISABLE
-
FORCE
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
| Property | Type | Required | Description |
|---|---|---|---|
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. |
filterEnable
|
string |
False | |
deblockFilter
|
string |
False | |
videoSelector
|
False | ||
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. |
programNumber
|
integer Minimum: -2147483648 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. |
timecodeSource
|
string |
False | |
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. |
denoiseFilter
|
string |
False | |
psiControl
|
string |
False | |
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. |
Use Timecode source (InputTimecodeSource) to specify how timecode information from your input is adjusted and encoded in all outputs for the job. Default is embedded. Set to Embedded (EMBEDDED) to use the timecode that is in the input video. If no embedded timecode is in the source, will set the timecode for the first frame to 00:00:00:00. Set to Start at 0 (ZEROBASED) to set the timecode of the initial frame to 00:00:00:00. Set to Specified start (SPECIFIEDSTART) to provide the initial timecode yourself the setting (Start).
-
EMBEDDED
-
ZEROBASED
-
SPECIFIEDSTART
| Property | Type | Required | Description |
|---|---|---|---|
timecodeConfig
|
False |
Contains settings used to acquire and adjust timecode information from inputs. |
|
adAvailOffset
|
integer Minimum: -1000 Maximum: 1000 |
False |
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. |
nielsenConfiguration
|
False |
Nielsen configuration settings |
|
inputs
|
Array of type InputTemplate |
False |
Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template. |
outputGroups
|
Array of type OutputGroup |
True |
(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 |
timedMetadataInsertion
|
False | ||
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. |
Code to specify the language, following the specification "ISO 639-2 three-digit code":http://www.loc.gov/standards/iso639-2/
-
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
Selects between the DVB and ATSC buffer models for Dolby Digital audio.
-
DVB
-
ATSC
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
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
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
Controls whether to include the ES Rate field in the PES header.
-
INCLUDE
-
EXCLUDE
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
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
Enables SCTE-35 passthrough (scte35Source) to pass any SCTE-35 signals from input to output. This is only available for certain containers.
-
PASSTHROUGH
-
NONE
M2tsSegmentationMarkers (enum)
Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.
-
NONE
-
RAI_SEGSTART
-
RAI_ADAPT
-
PSI_SEGSTART
-
EBP
-
EBP_LEGACY
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
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
Enables SCTE-35 passthrough (scte35Source) to pass any SCTE-35 signals from input to output. This is only available for certain containers.
-
PASSTHROUGH
-
NONE
When enabled, include 'clap' atom if appropriate for the video output settings.
-
INCLUDE
-
EXCLUDE
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