Channels
URI
/prod/channels
HTTP methods
GET
Operation ID: ListChannels
| Name | Type | Required | Description |
|---|---|---|---|
sortOrder | String | False | |
nextToken | String | False | |
maxResults | String | False | |
sortBy | String | False | |
filterQuery | String | False |
| Status code | Response model | Description |
|---|---|---|
200 | ListChannelsResultModel | 200 response |
400 | InvalidRequest | 400 response |
403 | AccessDenied | 403 response |
429 | LimitExceeded | 429 response |
500 | InternalServiceError | 500 response |
502 | BadGatewayException | 502 response |
504 | GatewayTimeoutException | 504 response |
POST
Operation ID: CreateChannel
| Status code | Response model | Description |
|---|---|---|
201 | CreateChannelResultModel | 201 response |
400 | InvalidRequest | 400 response |
403 | AccessDenied | 403 response |
409 | ResourceConflict | 409 response |
422 | ChannelConfigurationValidationError | 422 response |
429 | LimitExceeded | 429 response |
500 | InternalServiceError | 500 response |
502 | BadGatewayException | 502 response |
504 | GatewayTimeoutException | 504 response |
Schemas
Request bodies
{ "cdiInputSpecification": { "resolution": enum }, "channelClass": enum, "destinations": [ { "id": "string", "mediaPackageSettings": [ { "channelId": "string" } ], "multiplexSettings": { "multiplexId": "string", "programName": "string" }, "settings": [ { "passwordParam": "string", "streamName": "string", "url": "string", "username": "string" } ] } ], "encoderSettings": { "audioDescriptions": [ { "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "targetLkfs": number }, "audioSelectorName": "string", "audioType": enum, "audioTypeControl": enum, "audioWatermarkingSettings": { "nielsenWatermarksSettings": { "nielsenCbetSettings": { "cbetCheckDigitString": "string", "cbetStepaside": enum, "csid": "string" }, "nielsenDistributionType": enum, "nielsenNaesIiNwSettings": { "checkDigitString": "string", "sid": number } } }, "codecSettings": { "aacSettings": { "bitrate": number, "codingMode": enum, "inputType": enum, "profile": enum, "rateControlMode": enum, "rawFormat": enum, "sampleRate": number, "spec": enum, "vbrQuality": enum }, "ac3Settings": { "bitrate": number, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "drcProfile": enum, "lfeFilter": enum, "metadataControl": enum }, "eac3Settings": { "attenuationControl": enum, "bitrate": number, "bitstreamMode": enum, "codingMode": enum, "dcFilter": enum, "dialnorm": integer, "drcLine": enum, "drcRf": enum, "lfeControl": enum, "lfeFilter": enum, "loRoCenterMixLevel": number, "loRoSurroundMixLevel": number, "ltRtCenterMixLevel": number, "ltRtSurroundMixLevel": number, "metadataControl": enum, "passthroughControl": enum, "phaseControl": enum, "stereoDownmix": enum, "surroundExMode": enum, "surroundMode": enum }, "mp2Settings": { "bitrate": number, "codingMode": enum, "sampleRate": number }, "passThroughSettings": { }, "wavSettings": { "bitDepth": number, "codingMode": enum, "sampleRate": number } }, "languageCode": "string", "languageCodeControl": enum, "name": "string", "remixSettings": { "channelMappings": [ { "inputChannelLevels": [ { "gain": integer, "inputChannel": integer } ], "outputChannel": integer } ], "channelsIn": integer, "channelsOut": integer }, "streamName": "string" } ], "availBlanking": { "availBlankingImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "state": enum }, "availConfiguration": { "availSettings": { "scte35SpliceInsert": { "adAvailOffset": integer, "noRegionalBlackoutFlag": enum, "webDeliveryAllowedFlag": enum }, "scte35TimeSignalApos": { "adAvailOffset": integer, "noRegionalBlackoutFlag": enum, "webDeliveryAllowedFlag": enum } } }, "blackoutSlate": { "blackoutSlateImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "networkEndBlackout": enum, "networkEndBlackoutImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "networkId": "string", "state": enum }, "captionDescriptions": [ { "captionSelectorName": "string", "destinationSettings": { "aribDestinationSettings": { }, "burnInDestinationSettings": { "alignment": enum, "backgroundColor": enum, "backgroundOpacity": integer, "font": { "passwordParam": "string", "uri": "string", "username": "string" }, "fontColor": enum, "fontOpacity": integer, "fontResolution": integer, "fontSize": "string", "outlineColor": enum, "outlineSize": integer, "shadowColor": enum, "shadowOpacity": integer, "shadowXOffset": integer, "shadowYOffset": integer, "teletextGridControl": enum, "xPosition": integer, "yPosition": integer }, "dvbSubDestinationSettings": { "alignment": enum, "backgroundColor": enum, "backgroundOpacity": integer, "font": { "passwordParam": "string", "uri": "string", "username": "string" }, "fontColor": enum, "fontOpacity": integer, "fontResolution": integer, "fontSize": "string", "outlineColor": enum, "outlineSize": integer, "shadowColor": enum, "shadowOpacity": integer, "shadowXOffset": integer, "shadowYOffset": integer, "teletextGridControl": enum, "xPosition": integer, "yPosition": integer }, "ebuTtDDestinationSettings": { "copyrightHolder": "string", "fillLineGap": enum, "fontFamily": "string", "styleControl": enum }, "embeddedDestinationSettings": { }, "embeddedPlusScte20DestinationSettings": { }, "rtmpCaptionInfoDestinationSettings": { }, "scte20PlusEmbeddedDestinationSettings": { }, "scte27DestinationSettings": { }, "smpteTtDestinationSettings": { }, "teletextDestinationSettings": { }, "ttmlDestinationSettings": { "styleControl": enum }, "webvttDestinationSettings": { "styleControl": enum } }, "languageCode": "string", "languageDescription": "string", "name": "string" } ], "featureActivations": { "inputPrepareScheduleActions": enum }, "globalConfiguration": { "initialAudioGain": integer, "inputEndAction": enum, "inputLossBehavior": { "blackFrameMsec": integer, "inputLossImageColor": "string", "inputLossImageSlate": { "passwordParam": "string", "uri": "string", "username": "string" }, "inputLossImageType": enum, "repeatFrameMsec": integer }, "outputLockingMode": enum, "outputTimingSource": enum, "supportLowFramerateInputs": enum }, "motionGraphicsConfiguration": { "motionGraphicsInsertion": enum, "motionGraphicsSettings": { "htmlMotionGraphicsSettings": { } } }, "nielsenConfiguration": { "distributorId": "string", "nielsenPcmToId3Tagging": enum }, "outputGroups": [ { "name": "string", "outputGroupSettings": { "archiveGroupSettings": { "archiveCdnSettings": { "archiveS3Settings": { "cannedAcl": enum, "logUploads": enum } }, "destination": { "destinationRefId": "string" }, "rolloverInterval": integer }, "frameCaptureGroupSettings": { "destination": { "destinationRefId": "string" }, "frameCaptureCdnSettings": { "frameCaptureS3Settings": { "cannedAcl": enum, "logUploads": enum } } }, "hlsGroupSettings": { "adMarkers": [ enum ], "baseUrlContent": "string", "baseUrlContent1": "string", "baseUrlManifest": "string", "baseUrlManifest1": "string", "captionLanguageMappings": [ { "captionChannel": integer, "languageCode": "string", "languageDescription": "string" } ], "captionLanguageSetting": enum, "clientCache": enum, "codecSpecification": enum, "constantIv": "string", "destination": { "destinationRefId": "string" }, "directoryStructure": enum, "discontinuityTags": enum, "encryptionType": enum, "hlsCdnSettings": { "hlsAkamaiSettings": { "connectionRetryInterval": integer, "filecacheDuration": integer, "httpTransferMode": enum, "numRetries": integer, "restartDelay": integer, "salt": "string", "token": "string" }, "hlsBasicPutSettings": { "connectionRetryInterval": integer, "filecacheDuration": integer, "numRetries": integer, "restartDelay": integer }, "hlsMediaStoreSettings": { "connectionRetryInterval": integer, "filecacheDuration": integer, "mediaStoreStorageClass": enum, "numRetries": integer, "restartDelay": integer }, "hlsS3Settings": { "cannedAcl": enum, "logUploads": enum }, "hlsWebdavSettings": { "connectionRetryInterval": integer, "filecacheDuration": integer, "httpTransferMode": enum, "numRetries": integer, "restartDelay": integer } }, "hlsId3SegmentTagging": enum, "iFrameOnlyPlaylists": enum, "incompleteSegmentBehavior": enum, "indexNSegments": integer, "inputLossAction": enum, "ivInManifest": enum, "ivSource": enum, "keepSegments": integer, "keyFormat": "string", "keyFormatVersions": "string", "keyProviderSettings": { "staticKeySettings": { "keyProviderServer": { "passwordParam": "string", "uri": "string", "username": "string" }, "staticKeyValue": "string" } }, "manifestCompression": enum, "manifestDurationFormat": enum, "minSegmentLength": integer, "mode": enum, "outputSelection": enum, "programDateTime": enum, "programDateTimeClock": enum, "programDateTimePeriod": integer, "redundantManifest": enum, "segmentLength": integer, "segmentationMode": enum, "segmentsPerSubdirectory": integer, "streamInfResolution": enum, "timedMetadataId3Frame": enum, "timedMetadataId3Period": integer, "timestampDeltaMilliseconds": integer, "tsFileMode": enum }, "mediaPackageGroupSettings": { "destination": { "destinationRefId": "string" } }, "msSmoothGroupSettings": { "acquisitionPointId": "string", "audioOnlyTimecodeControl": enum, "certificateMode": enum, "connectionRetryInterval": integer, "destination": { "destinationRefId": "string" }, "eventId": "string", "eventIdMode": enum, "eventStopBehavior": enum, "filecacheDuration": integer, "fragmentLength": integer, "inputLossAction": enum, "numRetries": integer, "restartDelay": integer, "segmentationMode": enum, "sendDelayMs": integer, "sparseTrackType": enum, "streamManifestBehavior": enum, "timestampOffset": "string", "timestampOffsetMode": enum }, "multiplexGroupSettings": { }, "rtmpGroupSettings": { "adMarkers": [ enum ], "authenticationScheme": enum, "cacheFullBehavior": enum, "cacheLength": integer, "captionData": enum, "inputLossAction": enum, "restartDelay": integer }, "udpGroupSettings": { "inputLossAction": enum, "timedMetadataId3Frame": enum, "timedMetadataId3Period": integer } }, "outputs": [ { "audioDescriptionNames": [ "string" ], "captionDescriptionNames": [ "string" ], "outputName": "string", "outputSettings": { "archiveOutputSettings": { "containerSettings": { "m2tsSettings": { "absentInputAudioBehavior": enum, "arib": enum, "aribCaptionsPid": "string", "aribCaptionsPidControl": enum, "audioBufferModel": enum, "audioFramesPerPes": integer, "audioPids": "string", "audioStreamType": enum, "bitrate": integer, "bufferModel": enum, "ccDescriptor": enum, "dvbNitSettings": { "networkId": integer, "networkName": "string", "repInterval": integer }, "dvbSdtSettings": { "outputSdt": enum, "repInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "dvbSubPids": "string", "dvbTdtSettings": { "repInterval": integer }, "dvbTeletextPid": "string", "ebif": enum, "ebpAudioInterval": enum, "ebpLookaheadMs": integer, "ebpPlacement": enum, "ecmPid": "string", "esRateInPes": enum, "etvPlatformPid": "string", "etvSignalPid": "string", "fragmentTime": number, "klv": enum, "klvDataPids": "string", "nielsenId3Behavior": enum, "nullPacketBitrate": number, "patInterval": integer, "pcrControl": enum, "pcrPeriod": integer, "pcrPid": "string", "pmtInterval": integer, "pmtPid": "string", "programNum": integer, "rateMode": enum, "scte27Pids": "string", "scte35Control": enum, "scte35Pid": "string", "segmentationMarkers": enum, "segmentationStyle": enum, "segmentationTime": number, "timedMetadataBehavior": enum, "timedMetadataPid": "string", "transportStreamId": integer, "videoPid": "string" }, "rawSettings": { } }, "extension": "string", "nameModifier": "string" }, "frameCaptureOutputSettings": { "nameModifier": "string" }, "hlsOutputSettings": { "h265PackagingType": enum, "hlsSettings": { "audioOnlyHlsSettings": { "audioGroupId": "string", "audioOnlyImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "audioTrackType": enum, "segmentType": enum }, "fmp4HlsSettings": { "audioRenditionSets": "string", "nielsenId3Behavior": enum, "timedMetadataBehavior": enum }, "frameCaptureHlsSettings": { }, "standardHlsSettings": { "audioRenditionSets": "string", "m3u8Settings": { "audioFramesPerPes": integer, "audioPids": "string", "ecmPid": "string", "nielsenId3Behavior": enum, "patInterval": integer, "pcrControl": enum, "pcrPeriod": integer, "pcrPid": "string", "pmtInterval": integer, "pmtPid": "string", "programNum": integer, "scte35Behavior": enum, "scte35Pid": "string", "timedMetadataBehavior": enum, "timedMetadataPid": "string", "transportStreamId": integer, "videoPid": "string" } } }, "nameModifier": "string", "segmentModifier": "string" }, "mediaPackageOutputSettings": { }, "msSmoothOutputSettings": { "h265PackagingType": enum, "nameModifier": "string" }, "multiplexOutputSettings": { "destination": { "destinationRefId": "string" } }, "rtmpOutputSettings": { "certificateMode": enum, "connectionRetryInterval": integer, "destination": { "destinationRefId": "string" }, "numRetries": integer }, "udpOutputSettings": { "bufferMsec": integer, "containerSettings": { "m2tsSettings": { "absentInputAudioBehavior": enum, "arib": enum, "aribCaptionsPid": "string", "aribCaptionsPidControl": enum, "audioBufferModel": enum, "audioFramesPerPes": integer, "audioPids": "string", "audioStreamType": enum, "bitrate": integer, "bufferModel": enum, "ccDescriptor": enum, "dvbNitSettings": { "networkId": integer, "networkName": "string", "repInterval": integer }, "dvbSdtSettings": { "outputSdt": enum, "repInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "dvbSubPids": "string", "dvbTdtSettings": { "repInterval": integer }, "dvbTeletextPid": "string", "ebif": enum, "ebpAudioInterval": enum, "ebpLookaheadMs": integer, "ebpPlacement": enum, "ecmPid": "string", "esRateInPes": enum, "etvPlatformPid": "string", "etvSignalPid": "string", "fragmentTime": number, "klv": enum, "klvDataPids": "string", "nielsenId3Behavior": enum, "nullPacketBitrate": number, "patInterval": integer, "pcrControl": enum, "pcrPeriod": integer, "pcrPid": "string", "pmtInterval": integer, "pmtPid": "string", "programNum": integer, "rateMode": enum, "scte27Pids": "string", "scte35Control": enum, "scte35Pid": "string", "segmentationMarkers": enum, "segmentationStyle": enum, "segmentationTime": number, "timedMetadataBehavior": enum, "timedMetadataPid": "string", "transportStreamId": integer, "videoPid": "string" } }, "destination": { "destinationRefId": "string" }, "fecOutputSettings": { "columnDepth": integer, "includeFec": enum, "rowLength": integer } } }, "videoDescriptionName": "string" } ] } ], "timecodeConfig": { "source": enum, "syncThreshold": integer }, "videoDescriptions": [ { "codecSettings": { "frameCaptureSettings": { "captureInterval": integer, "captureIntervalUnits": enum }, "h264Settings": { "adaptiveQuantization": enum, "afdSignaling": enum, "bitrate": integer, "bufFillPct": integer, "bufSize": integer, "colorMetadata": enum, "colorSpaceSettings": { "colorSpacePassthroughSettings": { }, "rec601Settings": { }, "rec709Settings": { } }, "entropyEncoding": enum, "filterSettings": { "temporalFilterSettings": { "postFilterSharpening": enum, "strength": enum } }, "fixedAfd": enum, "flickerAq": enum, "forceFieldPictures": enum, "framerateControl": enum, "framerateDenominator": integer, "framerateNumerator": integer, "gopBReference": enum, "gopClosedCadence": integer, "gopNumBFrames": integer, "gopSize": number, "gopSizeUnits": enum, "level": enum, "lookAheadRateControl": enum, "maxBitrate": integer, "minIInterval": integer, "numRefFrames": integer, "parControl": enum, "parDenominator": integer, "parNumerator": integer, "profile": enum, "qualityLevel": enum, "qvbrQualityLevel": integer, "rateControlMode": enum, "scanType": enum, "sceneChangeDetect": enum, "slices": integer, "softness": integer, "spatialAq": enum, "subgopLength": enum, "syntax": enum, "temporalAq": enum, "timecodeInsertion": enum }, "h265Settings": { "adaptiveQuantization": enum, "afdSignaling": enum, "alternativeTransferFunction": enum, "bitrate": integer, "bufSize": integer, "colorMetadata": enum, "colorSpaceSettings": { "colorSpacePassthroughSettings": { }, "hdr10Settings": { "maxCll": integer, "maxFall": integer }, "rec601Settings": { }, "rec709Settings": { } }, "filterSettings": { "temporalFilterSettings": { "postFilterSharpening": enum, "strength": enum } }, "fixedAfd": enum, "flickerAq": enum, "framerateDenominator": integer, "framerateNumerator": integer, "gopClosedCadence": integer, "gopSize": number, "gopSizeUnits": enum, "level": enum, "lookAheadRateControl": enum, "maxBitrate": integer, "minIInterval": integer, "parDenominator": integer, "parNumerator": integer, "profile": enum, "qvbrQualityLevel": integer, "rateControlMode": enum, "scanType": enum, "sceneChangeDetect": enum, "slices": integer, "tier": enum, "timecodeInsertion": enum }, "mpeg2Settings": { "adaptiveQuantization": enum, "afdSignaling": enum, "colorMetadata": enum, "colorSpace": enum, "displayAspectRatio": enum, "filterSettings": { "temporalFilterSettings": { "postFilterSharpening": enum, "strength": enum } }, "fixedAfd": enum, "framerateDenominator": integer, "framerateNumerator": integer, "gopClosedCadence": integer, "gopNumBFrames": integer, "gopSize": number, "gopSizeUnits": enum, "scanType": enum, "subgopLength": enum, "timecodeInsertion": enum } }, "height": integer, "name": "string", "respondToAfd": enum, "scalingBehavior": enum, "sharpness": integer, "width": integer } ] }, "inputAttachments": [ { "automaticInputFailoverSettings": { "errorClearTimeMsec": integer, "failoverConditions": [ { "failoverConditionSettings": { "audioSilenceSettings": { "audioSelectorName": "string", "audioSilenceThresholdMsec": integer }, "inputLossSettings": { "inputLossThresholdMsec": integer }, "videoBlackSettings": { "blackDetectThreshold": number, "videoBlackThresholdMsec": integer } } } ], "inputPreference": enum, "secondaryInputId": "string" }, "inputAttachmentName": "string", "inputId": "string", "inputSettings": { "audioSelectors": [ { "name": "string", "selectorSettings": { "audioHlsRenditionSelection": { "groupId": "string", "name": "string" }, "audioLanguageSelection": { "languageCode": "string", "languageSelectionPolicy": enum }, "audioPidSelection": { "pid": integer }, "audioTrackSelection": { "tracks": [ { "track": integer } ] } } } ], "captionSelectors": [ { "languageCode": "string", "name": "string", "selectorSettings": { "ancillarySourceSettings": { "sourceAncillaryChannelNumber": integer }, "aribSourceSettings": { }, "dvbSubSourceSettings": { "ocrLanguage": enum, "pid": integer }, "embeddedSourceSettings": { "convert608To708": enum, "scte20Detection": enum, "source608ChannelNumber": integer, "source608TrackNumber": integer }, "scte20SourceSettings": { "convert608To708": enum, "source608ChannelNumber": integer }, "scte27SourceSettings": { "ocrLanguage": enum, "pid": integer }, "teletextSourceSettings": { "outputRectangle": { "height": number, "leftOffset": number, "topOffset": number, "width": number }, "pageNumber": "string" } } } ], "deblockFilter": enum, "denoiseFilter": enum, "filterStrength": integer, "inputFilter": enum, "networkInputSettings": { "hlsInputSettings": { "bandwidth": integer, "bufferSegments": integer, "retries": integer, "retryInterval": integer, "scte35Source": enum }, "serverValidation": enum }, "smpte2038DataPreference": enum, "sourceEndBehavior": enum, "videoSelector": { "colorSpace": enum, "colorSpaceSettings": { "hdr10Settings": { "maxCll": integer, "maxFall": integer } }, "colorSpaceUsage": enum, "selectorSettings": { "videoSelectorPid": { "pid": integer }, "videoSelectorProgramId": { "programId": integer } } } } } ], "inputSpecification": { "codec": enum, "maximumBitrate": enum, "resolution": enum }, "logLevel": enum, "maintenance": { "maintenanceDay": enum, "maintenanceStartTime": "string" }, "name": "string", "requestId": "string", "reserved": "string", "roleArn": "string", "tags": { }, "vpc": { "publicAddressAllocationIds": [ "string" ], "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } }
Response bodies
{ "channels": [ { "arn": "string", "cdiInputSpecification": { "resolution": enum }, "channelClass": enum, "destinations": [ { "id": "string", "mediaPackageSettings": [ { "channelId": "string" } ], "multiplexSettings": { "multiplexId": "string", "programName": "string" }, "settings": [ { "passwordParam": "string", "streamName": "string", "url": "string", "username": "string" } ] } ], "egressEndpoints": [ { "sourceIp": "string" } ], "id": "string", "inputAttachments": [ { "automaticInputFailoverSettings": { "errorClearTimeMsec": integer, "failoverConditions": [ { "failoverConditionSettings": { "audioSilenceSettings": { "audioSelectorName": "string", "audioSilenceThresholdMsec": integer }, "inputLossSettings": { "inputLossThresholdMsec": integer }, "videoBlackSettings": { "blackDetectThreshold": number, "videoBlackThresholdMsec": integer } } } ], "inputPreference": enum, "secondaryInputId": "string" }, "inputAttachmentName": "string", "inputId": "string", "inputSettings": { "audioSelectors": [ { "name": "string", "selectorSettings": { "audioHlsRenditionSelection": { "groupId": "string", "name": "string" }, "audioLanguageSelection": { "languageCode": "string", "languageSelectionPolicy": enum }, "audioPidSelection": { "pid": integer }, "audioTrackSelection": { "tracks": [ { "track": integer } ] } } } ], "captionSelectors": [ { "languageCode": "string", "name": "string", "selectorSettings": { "ancillarySourceSettings": { "sourceAncillaryChannelNumber": integer }, "aribSourceSettings": { }, "dvbSubSourceSettings": { "ocrLanguage": enum, "pid": integer }, "embeddedSourceSettings": { "convert608To708": enum, "scte20Detection": enum, "source608ChannelNumber": integer, "source608TrackNumber": integer }, "scte20SourceSettings": { "convert608To708": enum, "source608ChannelNumber": integer }, "scte27SourceSettings": { "ocrLanguage": enum, "pid": integer }, "teletextSourceSettings": { "outputRectangle": { "height": number, "leftOffset": number, "topOffset": number, "width": number }, "pageNumber": "string" } } } ], "deblockFilter": enum, "denoiseFilter": enum, "filterStrength": integer, "inputFilter": enum, "networkInputSettings": { "hlsInputSettings": { "bandwidth": integer, "bufferSegments": integer, "retries": integer, "retryInterval": integer, "scte35Source": enum }, "serverValidation": enum }, "smpte2038DataPreference": enum, "sourceEndBehavior": enum, "videoSelector": { "colorSpace": enum, "colorSpaceSettings": { "hdr10Settings": { "maxCll": integer, "maxFall": integer } }, "colorSpaceUsage": enum, "selectorSettings": { "videoSelectorPid": { "pid": integer }, "videoSelectorProgramId": { "programId": integer } } } } } ], "inputSpecification": { "codec": enum, "maximumBitrate": enum, "resolution": enum }, "logLevel": enum, "maintenance": { "maintenanceDay": enum, "maintenanceDeadline": "string", "maintenanceScheduledDate": "string", "maintenanceStartTime": "string" }, "name": "string", "pipelinesRunningCount": integer, "roleArn": "string", "state": enum, "tags": { }, "vpc": { "availabilityZones": [ "string" ], "networkInterfaceIds": [ "string" ], "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } ], "nextToken": "string" }
{ "channel": { "arn": "string", "cdiInputSpecification": { "resolution": enum }, "channelClass": enum, "destinations": [ { "id": "string", "mediaPackageSettings": [ { "channelId": "string" } ], "multiplexSettings": { "multiplexId": "string", "programName": "string" }, "settings": [ { "passwordParam": "string", "streamName": "string", "url": "string", "username": "string" } ] } ], "egressEndpoints": [ { "sourceIp": "string" } ], "encoderSettings": { "audioDescriptions": [ { "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "targetLkfs": number }, "audioSelectorName": "string", "audioType": enum, "audioTypeControl": enum, "audioWatermarkingSettings": { "nielsenWatermarksSettings": { "nielsenCbetSettings": { "cbetCheckDigitString": "string", "cbetStepaside": enum, "csid": "string" }, "nielsenDistributionType": enum, "nielsenNaesIiNwSettings": { "checkDigitString": "string", "sid": number } } }, "codecSettings": { "aacSettings": { "bitrate": number, "codingMode": enum, "inputType": enum, "profile": enum, "rateControlMode": enum, "rawFormat": enum, "sampleRate": number, "spec": enum, "vbrQuality": enum }, "ac3Settings": { "bitrate": number, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "drcProfile": enum, "lfeFilter": enum, "metadataControl": enum }, "eac3Settings": { "attenuationControl": enum, "bitrate": number, "bitstreamMode": enum, "codingMode": enum, "dcFilter": enum, "dialnorm": integer, "drcLine": enum, "drcRf": enum, "lfeControl": enum, "lfeFilter": enum, "loRoCenterMixLevel": number, "loRoSurroundMixLevel": number, "ltRtCenterMixLevel": number, "ltRtSurroundMixLevel": number, "metadataControl": enum, "passthroughControl": enum, "phaseControl": enum, "stereoDownmix": enum, "surroundExMode": enum, "surroundMode": enum }, "mp2Settings": { "bitrate": number, "codingMode": enum, "sampleRate": number }, "passThroughSettings": { }, "wavSettings": { "bitDepth": number, "codingMode": enum, "sampleRate": number } }, "languageCode": "string", "languageCodeControl": enum, "name": "string", "remixSettings": { "channelMappings": [ { "inputChannelLevels": [ { "gain": integer, "inputChannel": integer } ], "outputChannel": integer } ], "channelsIn": integer, "channelsOut": integer }, "streamName": "string" } ], "availBlanking": { "availBlankingImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "state": enum }, "availConfiguration": { "availSettings": { "scte35SpliceInsert": { "adAvailOffset": integer, "noRegionalBlackoutFlag": enum, "webDeliveryAllowedFlag": enum }, "scte35TimeSignalApos": { "adAvailOffset": integer, "noRegionalBlackoutFlag": enum, "webDeliveryAllowedFlag": enum } } }, "blackoutSlate": { "blackoutSlateImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "networkEndBlackout": enum, "networkEndBlackoutImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "networkId": "string", "state": enum }, "captionDescriptions": [ { "captionSelectorName": "string", "destinationSettings": { "aribDestinationSettings": { }, "burnInDestinationSettings": { "alignment": enum, "backgroundColor": enum, "backgroundOpacity": integer, "font": { "passwordParam": "string", "uri": "string", "username": "string" }, "fontColor": enum, "fontOpacity": integer, "fontResolution": integer, "fontSize": "string", "outlineColor": enum, "outlineSize": integer, "shadowColor": enum, "shadowOpacity": integer, "shadowXOffset": integer, "shadowYOffset": integer, "teletextGridControl": enum, "xPosition": integer, "yPosition": integer }, "dvbSubDestinationSettings": { "alignment": enum, "backgroundColor": enum, "backgroundOpacity": integer, "font": { "passwordParam": "string", "uri": "string", "username": "string" }, "fontColor": enum, "fontOpacity": integer, "fontResolution": integer, "fontSize": "string", "outlineColor": enum, "outlineSize": integer, "shadowColor": enum, "shadowOpacity": integer, "shadowXOffset": integer, "shadowYOffset": integer, "teletextGridControl": enum, "xPosition": integer, "yPosition": integer }, "ebuTtDDestinationSettings": { "copyrightHolder": "string", "fillLineGap": enum, "fontFamily": "string", "styleControl": enum }, "embeddedDestinationSettings": { }, "embeddedPlusScte20DestinationSettings": { }, "rtmpCaptionInfoDestinationSettings": { }, "scte20PlusEmbeddedDestinationSettings": { }, "scte27DestinationSettings": { }, "smpteTtDestinationSettings": { }, "teletextDestinationSettings": { }, "ttmlDestinationSettings": { "styleControl": enum }, "webvttDestinationSettings": { "styleControl": enum } }, "languageCode": "string", "languageDescription": "string", "name": "string" } ], "featureActivations": { "inputPrepareScheduleActions": enum }, "globalConfiguration": { "initialAudioGain": integer, "inputEndAction": enum, "inputLossBehavior": { "blackFrameMsec": integer, "inputLossImageColor": "string", "inputLossImageSlate": { "passwordParam": "string", "uri": "string", "username": "string" }, "inputLossImageType": enum, "repeatFrameMsec": integer }, "outputLockingMode": enum, "outputTimingSource": enum, "supportLowFramerateInputs": enum }, "motionGraphicsConfiguration": { "motionGraphicsInsertion": enum, "motionGraphicsSettings": { "htmlMotionGraphicsSettings": { } } }, "nielsenConfiguration": { "distributorId": "string", "nielsenPcmToId3Tagging": enum }, "outputGroups": [ { "name": "string", "outputGroupSettings": { "archiveGroupSettings": { "archiveCdnSettings": { "archiveS3Settings": { "cannedAcl": enum, "logUploads": enum } }, "destination": { "destinationRefId": "string" }, "rolloverInterval": integer }, "frameCaptureGroupSettings": { "destination": { "destinationRefId": "string" }, "frameCaptureCdnSettings": { "frameCaptureS3Settings": { "cannedAcl": enum, "logUploads": enum } } }, "hlsGroupSettings": { "adMarkers": [ enum ], "baseUrlContent": "string", "baseUrlContent1": "string", "baseUrlManifest": "string", "baseUrlManifest1": "string", "captionLanguageMappings": [ { "captionChannel": integer, "languageCode": "string", "languageDescription": "string" } ], "captionLanguageSetting": enum, "clientCache": enum, "codecSpecification": enum, "constantIv": "string", "destination": { "destinationRefId": "string" }, "directoryStructure": enum, "discontinuityTags": enum, "encryptionType": enum, "hlsCdnSettings": { "hlsAkamaiSettings": { "connectionRetryInterval": integer, "filecacheDuration": integer, "httpTransferMode": enum, "numRetries": integer, "restartDelay": integer, "salt": "string", "token": "string" }, "hlsBasicPutSettings": { "connectionRetryInterval": integer, "filecacheDuration": integer, "numRetries": integer, "restartDelay": integer }, "hlsMediaStoreSettings": { "connectionRetryInterval": integer, "filecacheDuration": integer, "mediaStoreStorageClass": enum, "numRetries": integer, "restartDelay": integer }, "hlsS3Settings": { "cannedAcl": enum, "logUploads": enum }, "hlsWebdavSettings": { "connectionRetryInterval": integer, "filecacheDuration": integer, "httpTransferMode": enum, "numRetries": integer, "restartDelay": integer } }, "hlsId3SegmentTagging": enum, "iFrameOnlyPlaylists": enum, "incompleteSegmentBehavior": enum, "indexNSegments": integer, "inputLossAction": enum, "ivInManifest": enum, "ivSource": enum, "keepSegments": integer, "keyFormat": "string", "keyFormatVersions": "string", "keyProviderSettings": { "staticKeySettings": { "keyProviderServer": { "passwordParam": "string", "uri": "string", "username": "string" }, "staticKeyValue": "string" } }, "manifestCompression": enum, "manifestDurationFormat": enum, "minSegmentLength": integer, "mode": enum, "outputSelection": enum, "programDateTime": enum, "programDateTimeClock": enum, "programDateTimePeriod": integer, "redundantManifest": enum, "segmentLength": integer, "segmentationMode": enum, "segmentsPerSubdirectory": integer, "streamInfResolution": enum, "timedMetadataId3Frame": enum, "timedMetadataId3Period": integer, "timestampDeltaMilliseconds": integer, "tsFileMode": enum }, "mediaPackageGroupSettings": { "destination": { "destinationRefId": "string" } }, "msSmoothGroupSettings": { "acquisitionPointId": "string", "audioOnlyTimecodeControl": enum, "certificateMode": enum, "connectionRetryInterval": integer, "destination": { "destinationRefId": "string" }, "eventId": "string", "eventIdMode": enum, "eventStopBehavior": enum, "filecacheDuration": integer, "fragmentLength": integer, "inputLossAction": enum, "numRetries": integer, "restartDelay": integer, "segmentationMode": enum, "sendDelayMs": integer, "sparseTrackType": enum, "streamManifestBehavior": enum, "timestampOffset": "string", "timestampOffsetMode": enum }, "multiplexGroupSettings": { }, "rtmpGroupSettings": { "adMarkers": [ enum ], "authenticationScheme": enum, "cacheFullBehavior": enum, "cacheLength": integer, "captionData": enum, "inputLossAction": enum, "restartDelay": integer }, "udpGroupSettings": { "inputLossAction": enum, "timedMetadataId3Frame": enum, "timedMetadataId3Period": integer } }, "outputs": [ { "audioDescriptionNames": [ "string" ], "captionDescriptionNames": [ "string" ], "outputName": "string", "outputSettings": { "archiveOutputSettings": { "containerSettings": { "m2tsSettings": { "absentInputAudioBehavior": enum, "arib": enum, "aribCaptionsPid": "string", "aribCaptionsPidControl": enum, "audioBufferModel": enum, "audioFramesPerPes": integer, "audioPids": "string", "audioStreamType": enum, "bitrate": integer, "bufferModel": enum, "ccDescriptor": enum, "dvbNitSettings": { "networkId": integer, "networkName": "string", "repInterval": integer }, "dvbSdtSettings": { "outputSdt": enum, "repInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "dvbSubPids": "string", "dvbTdtSettings": { "repInterval": integer }, "dvbTeletextPid": "string", "ebif": enum, "ebpAudioInterval": enum, "ebpLookaheadMs": integer, "ebpPlacement": enum, "ecmPid": "string", "esRateInPes": enum, "etvPlatformPid": "string", "etvSignalPid": "string", "fragmentTime": number, "klv": enum, "klvDataPids": "string", "nielsenId3Behavior": enum, "nullPacketBitrate": number, "patInterval": integer, "pcrControl": enum, "pcrPeriod": integer, "pcrPid": "string", "pmtInterval": integer, "pmtPid": "string", "programNum": integer, "rateMode": enum, "scte27Pids": "string", "scte35Control": enum, "scte35Pid": "string", "segmentationMarkers": enum, "segmentationStyle": enum, "segmentationTime": number, "timedMetadataBehavior": enum, "timedMetadataPid": "string", "transportStreamId": integer, "videoPid": "string" }, "rawSettings": { } }, "extension": "string", "nameModifier": "string" }, "frameCaptureOutputSettings": { "nameModifier": "string" }, "hlsOutputSettings": { "h265PackagingType": enum, "hlsSettings": { "audioOnlyHlsSettings": { "audioGroupId": "string", "audioOnlyImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "audioTrackType": enum, "segmentType": enum }, "fmp4HlsSettings": { "audioRenditionSets": "string", "nielsenId3Behavior": enum, "timedMetadataBehavior": enum }, "frameCaptureHlsSettings": { }, "standardHlsSettings": { "audioRenditionSets": "string", "m3u8Settings": { "audioFramesPerPes": integer, "audioPids": "string", "ecmPid": "string", "nielsenId3Behavior": enum, "patInterval": integer, "pcrControl": enum, "pcrPeriod": integer, "pcrPid": "string", "pmtInterval": integer, "pmtPid": "string", "programNum": integer, "scte35Behavior": enum, "scte35Pid": "string", "timedMetadataBehavior": enum, "timedMetadataPid": "string", "transportStreamId": integer, "videoPid": "string" } } }, "nameModifier": "string", "segmentModifier": "string" }, "mediaPackageOutputSettings": { }, "msSmoothOutputSettings": { "h265PackagingType": enum, "nameModifier": "string" }, "multiplexOutputSettings": { "destination": { "destinationRefId": "string" } }, "rtmpOutputSettings": { "certificateMode": enum, "connectionRetryInterval": integer, "destination": { "destinationRefId": "string" }, "numRetries": integer }, "udpOutputSettings": { "bufferMsec": integer, "containerSettings": { "m2tsSettings": { "absentInputAudioBehavior": enum, "arib": enum, "aribCaptionsPid": "string", "aribCaptionsPidControl": enum, "audioBufferModel": enum, "audioFramesPerPes": integer, "audioPids": "string", "audioStreamType": enum, "bitrate": integer, "bufferModel": enum, "ccDescriptor": enum, "dvbNitSettings": { "networkId": integer, "networkName": "string", "repInterval": integer }, "dvbSdtSettings": { "outputSdt": enum, "repInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "dvbSubPids": "string", "dvbTdtSettings": { "repInterval": integer }, "dvbTeletextPid": "string", "ebif": enum, "ebpAudioInterval": enum, "ebpLookaheadMs": integer, "ebpPlacement": enum, "ecmPid": "string", "esRateInPes": enum, "etvPlatformPid": "string", "etvSignalPid": "string", "fragmentTime": number, "klv": enum, "klvDataPids": "string", "nielsenId3Behavior": enum, "nullPacketBitrate": number, "patInterval": integer, "pcrControl": enum, "pcrPeriod": integer, "pcrPid": "string", "pmtInterval": integer, "pmtPid": "string", "programNum": integer, "rateMode": enum, "scte27Pids": "string", "scte35Control": enum, "scte35Pid": "string", "segmentationMarkers": enum, "segmentationStyle": enum, "segmentationTime": number, "timedMetadataBehavior": enum, "timedMetadataPid": "string", "transportStreamId": integer, "videoPid": "string" } }, "destination": { "destinationRefId": "string" }, "fecOutputSettings": { "columnDepth": integer, "includeFec": enum, "rowLength": integer } } }, "videoDescriptionName": "string" } ] } ], "timecodeConfig": { "source": enum, "syncThreshold": integer }, "videoDescriptions": [ { "codecSettings": { "frameCaptureSettings": { "captureInterval": integer, "captureIntervalUnits": enum }, "h264Settings": { "adaptiveQuantization": enum, "afdSignaling": enum, "bitrate": integer, "bufFillPct": integer, "bufSize": integer, "colorMetadata": enum, "colorSpaceSettings": { "colorSpacePassthroughSettings": { }, "rec601Settings": { }, "rec709Settings": { } }, "entropyEncoding": enum, "filterSettings": { "temporalFilterSettings": { "postFilterSharpening": enum, "strength": enum } }, "fixedAfd": enum, "flickerAq": enum, "forceFieldPictures": enum, "framerateControl": enum, "framerateDenominator": integer, "framerateNumerator": integer, "gopBReference": enum, "gopClosedCadence": integer, "gopNumBFrames": integer, "gopSize": number, "gopSizeUnits": enum, "level": enum, "lookAheadRateControl": enum, "maxBitrate": integer, "minIInterval": integer, "numRefFrames": integer, "parControl": enum, "parDenominator": integer, "parNumerator": integer, "profile": enum, "qualityLevel": enum, "qvbrQualityLevel": integer, "rateControlMode": enum, "scanType": enum, "sceneChangeDetect": enum, "slices": integer, "softness": integer, "spatialAq": enum, "subgopLength": enum, "syntax": enum, "temporalAq": enum, "timecodeInsertion": enum }, "h265Settings": { "adaptiveQuantization": enum, "afdSignaling": enum, "alternativeTransferFunction": enum, "bitrate": integer, "bufSize": integer, "colorMetadata": enum, "colorSpaceSettings": { "colorSpacePassthroughSettings": { }, "hdr10Settings": { "maxCll": integer, "maxFall": integer }, "rec601Settings": { }, "rec709Settings": { } }, "filterSettings": { "temporalFilterSettings": { "postFilterSharpening": enum, "strength": enum } }, "fixedAfd": enum, "flickerAq": enum, "framerateDenominator": integer, "framerateNumerator": integer, "gopClosedCadence": integer, "gopSize": number, "gopSizeUnits": enum, "level": enum, "lookAheadRateControl": enum, "maxBitrate": integer, "minIInterval": integer, "parDenominator": integer, "parNumerator": integer, "profile": enum, "qvbrQualityLevel": integer, "rateControlMode": enum, "scanType": enum, "sceneChangeDetect": enum, "slices": integer, "tier": enum, "timecodeInsertion": enum }, "mpeg2Settings": { "adaptiveQuantization": enum, "afdSignaling": enum, "colorMetadata": enum, "colorSpace": enum, "displayAspectRatio": enum, "filterSettings": { "temporalFilterSettings": { "postFilterSharpening": enum, "strength": enum } }, "fixedAfd": enum, "framerateDenominator": integer, "framerateNumerator": integer, "gopClosedCadence": integer, "gopNumBFrames": integer, "gopSize": number, "gopSizeUnits": enum, "scanType": enum, "subgopLength": enum, "timecodeInsertion": enum } }, "height": integer, "name": "string", "respondToAfd": enum, "scalingBehavior": enum, "sharpness": integer, "width": integer } ] }, "id": "string", "inputAttachments": [ { "automaticInputFailoverSettings": { "errorClearTimeMsec": integer, "failoverConditions": [ { "failoverConditionSettings": { "audioSilenceSettings": { "audioSelectorName": "string", "audioSilenceThresholdMsec": integer }, "inputLossSettings": { "inputLossThresholdMsec": integer }, "videoBlackSettings": { "blackDetectThreshold": number, "videoBlackThresholdMsec": integer } } } ], "inputPreference": enum, "secondaryInputId": "string" }, "inputAttachmentName": "string", "inputId": "string", "inputSettings": { "audioSelectors": [ { "name": "string", "selectorSettings": { "audioHlsRenditionSelection": { "groupId": "string", "name": "string" }, "audioLanguageSelection": { "languageCode": "string", "languageSelectionPolicy": enum }, "audioPidSelection": { "pid": integer }, "audioTrackSelection": { "tracks": [ { "track": integer } ] } } } ], "captionSelectors": [ { "languageCode": "string", "name": "string", "selectorSettings": { "ancillarySourceSettings": { "sourceAncillaryChannelNumber": integer }, "aribSourceSettings": { }, "dvbSubSourceSettings": { "ocrLanguage": enum, "pid": integer }, "embeddedSourceSettings": { "convert608To708": enum, "scte20Detection": enum, "source608ChannelNumber": integer, "source608TrackNumber": integer }, "scte20SourceSettings": { "convert608To708": enum, "source608ChannelNumber": integer }, "scte27SourceSettings": { "ocrLanguage": enum, "pid": integer }, "teletextSourceSettings": { "outputRectangle": { "height": number, "leftOffset": number, "topOffset": number, "width": number }, "pageNumber": "string" } } } ], "deblockFilter": enum, "denoiseFilter": enum, "filterStrength": integer, "inputFilter": enum, "networkInputSettings": { "hlsInputSettings": { "bandwidth": integer, "bufferSegments": integer, "retries": integer, "retryInterval": integer, "scte35Source": enum }, "serverValidation": enum }, "smpte2038DataPreference": enum, "sourceEndBehavior": enum, "videoSelector": { "colorSpace": enum, "colorSpaceSettings": { "hdr10Settings": { "maxCll": integer, "maxFall": integer } }, "colorSpaceUsage": enum, "selectorSettings": { "videoSelectorPid": { "pid": integer }, "videoSelectorProgramId": { "programId": integer } } } } } ], "inputSpecification": { "codec": enum, "maximumBitrate": enum, "resolution": enum }, "logLevel": enum, "maintenance": { "maintenanceDay": enum, "maintenanceDeadline": "string", "maintenanceScheduledDate": "string", "maintenanceStartTime": "string" }, "name": "string", "pipelineDetails": [ { "activeInputAttachmentName": "string", "activeInputSwitchActionName": "string", "activeMotionGraphicsActionName": "string", "activeMotionGraphicsUri": "string", "pipelineId": "string" } ], "pipelinesRunningCount": integer, "roleArn": "string", "state": enum, "tags": { }, "vpc": { "availabilityZones": [ "string" ], "networkInterfaceIds": [ "string" ], "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string", "validationErrors": [ { "elementPath": "string", "errorMessage": "string" } ] }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
Properties
AacCodingMode
Aac Coding Mode
AD_RECEIVER_MIXCODING_MODE_1_0CODING_MODE_1_1CODING_MODE_2_0CODING_MODE_5_1
AacInputType
Aac Input Type
BROADCASTER_MIXED_ADNORMAL
AacProfile
Aac Profile
HEV1HEV2LC
AacRateControlMode
Aac Rate Control Mode
CBRVBR
AacRawFormat
Aac Raw Format
LATM_LOASNONE
AacSettings
Aac Settings
| Property | Type | Required | Description |
|---|---|---|---|
bitrate | number | False | Average bitrate in bits/second. Valid values depend on rate control mode and profile. |
codingMode | False | Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix 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. | |
inputType | False | Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (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. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD. | |
profile | False | AAC Profile. | |
rateControlMode | False | Rate Control Mode. | |
rawFormat | False | Sets LATM / LOAS AAC output for raw containers. | |
sampleRate | number | False | Sample rate in Hz. Valid values depend on rate control mode and profile. |
spec | False | Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. | |
vbrQuality | False | VBR Quality Level - Only used if rateControlMode is VBR. |
AacSpec
Aac Spec
MPEG2MPEG4
AacVbrQuality
Aac Vbr Quality
HIGHLOWMEDIUM_HIGHMEDIUM_LOW
Ac3BitstreamMode
Ac3 Bitstream Mode
COMMENTARYCOMPLETE_MAINDIALOGUEEMERGENCYHEARING_IMPAIREDMUSIC_AND_EFFECTSVISUALLY_IMPAIREDVOICE_OVER
Ac3CodingMode
Ac3 Coding Mode
CODING_MODE_1_0CODING_MODE_1_1CODING_MODE_2_0CODING_MODE_3_2_LFE
Ac3DrcProfile
Ac3 Drc Profile
FILM_STANDARDNONE
Ac3LfeFilter
Ac3 Lfe Filter
DISABLEDENABLED
Ac3MetadataControl
Ac3 Metadata Control
FOLLOW_INPUTUSE_CONFIGURED
Ac3Settings
Ac3 Settings
| Property | Type | Required | Description |
|---|---|---|---|
bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. |
bitstreamMode | False | Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. | |
codingMode | False | Dolby Digital coding mode. Determines number of channels. | |
dialnorm | integer Minimum: 1 Maximum: 31 | False | Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through. |
drcProfile | False | If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. | |
lfeFilter | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. | |
metadataControl | False | When set to "followInput", 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. |
AccessDenied
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
AfdSignaling
Afd Signaling
AUTOFIXEDNONE
AncillarySourceSettings
Ancillary Source Settings
| Property | Type | Required | Description |
|---|---|---|---|
sourceAncillaryChannelNumber | integer Minimum: 1 Maximum: 4 | False | Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field. |
ArchiveCdnSettings
Archive Cdn Settings
| Property | Type | Required | Description |
|---|---|---|---|
archiveS3Settings | False |
ArchiveContainerSettings
Archive Container Settings
| Property | Type | Required | Description |
|---|---|---|---|
m2tsSettings | False | ||
rawSettings | False |
ArchiveGroupSettings
Archive Group Settings
| Property | Type | Required | Description |
|---|---|---|---|
archiveCdnSettings | False | Parameters that control interactions with the CDN. | |
destination | True | A directory and base filename where archive files should be written. | |
rolloverInterval | integer Minimum: 1 | False | Number of seconds to write to archive file before closing and starting a new one. |
ArchiveOutputSettings
Archive Output Settings
| Property | Type | Required | Description |
|---|---|---|---|
containerSettings | True | Settings specific to the container type of the file. | |
extension | string | False | Output file extension. If excluded, this will be auto-selected from the container type. |
nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. |
ArchiveS3LogUploads
Archive S3 Log Uploads
DISABLEDENABLED
ArchiveS3Settings
Archive S3 Settings
| Property | Type | Required | Description |
|---|---|---|---|
cannedAcl | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | |
logUploads | False | When set to enabled, each upload to CDN or server will be logged. |
AribDestinationSettings
Arib Destination Settings
AribSourceSettings
Arib Source Settings
AudioChannelMapping
Audio Channel Mapping
| Property | Type | Required | Description |
|---|---|---|---|
inputChannelLevels | Array of type InputChannelLevel | True | Indices and gain values for each input channel that should be remixed into this output channel. |
outputChannel | integer Minimum: 0 Maximum: 7 | True | The index of the output channel being produced. |
AudioCodecSettings
Audio Codec Settings
| Property | Type | Required | Description |
|---|---|---|---|
aacSettings | False | ||
ac3Settings | False | ||
eac3Settings | False | ||
mp2Settings | False | ||
passThroughSettings | False | ||
wavSettings | False |
AudioDescription
Audio Description
| Property | Type | Required | Description |
|---|---|---|---|
audioNormalizationSettings | False | Advanced audio normalization settings. | |
audioSelectorName | string | True | The name of the AudioSelector used as the source for this AudioDescription. |
audioType | False | Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. | |
audioTypeControl | False | Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. | |
audioWatermarkingSettings | False | Settings to configure one or more solutions that insert audio watermarks in the audio encode | |
codecSettings | False | Audio codec settings. | |
languageCode | string MinLength: 1 MaxLength: 35 | False | RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input. |
languageCodeControl | False | Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. | |
name | string | True | The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event. |
remixSettings | False | Settings that control how input audio channels are remixed into the output audio channels. | |
streamName | string | False | Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). |
AudioDescriptionAudioTypeControl
Audio Description Audio Type Control
FOLLOW_INPUTUSE_CONFIGURED
AudioDescriptionLanguageCodeControl
Audio Description Language Code Control
FOLLOW_INPUTUSE_CONFIGURED
AudioHlsRenditionSelection
Audio Hls Rendition Selection
| Property | Type | Required | Description |
|---|---|---|---|
groupId | string MinLength: 1 | True | Specifies the GROUP-ID in the #EXT-X-MEDIA tag of the target HLS audio rendition. |
name | string MinLength: 1 | True | Specifies the NAME in the #EXT-X-MEDIA tag of the target HLS audio rendition. |
AudioLanguageSelection
Audio Language Selection
| Property | Type | Required | Description |
|---|---|---|---|
languageCode | string | True | Selects a specific three-letter language code from within an audio source. |
languageSelectionPolicy | False | When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. |
AudioLanguageSelectionPolicy
Audio Language Selection Policy
LOOSESTRICT
AudioNormalizationAlgorithm
Audio Normalization Algorithm
ITU_1770_1ITU_1770_2
AudioNormalizationAlgorithmControl
Audio Normalization Algorithm Control
CORRECT_AUDIO
AudioNormalizationSettings
Audio Normalization Settings
| Property | Type | Required | Description |
|---|---|---|---|
algorithm | False | Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. | |
algorithmControl | False | When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. | |
targetLkfs | number Minimum: -59 Maximum: 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. |
AudioOnlyHlsSegmentType
Audio Only Hls Segment Type
AACFMP4
AudioOnlyHlsSettings
Audio Only Hls Settings
| Property | Type | Required | Description |
|---|---|---|---|
audioGroupId | string | False | Specifies the group to which the audio Rendition belongs. |
audioOnlyImage | False | Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard. | |
audioTrackType | False | Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO | |
segmentType | False | Specifies the segment type. |
AudioOnlyHlsTrackType
Audio Only Hls Track Type
ALTERNATE_AUDIO_AUTO_SELECTALTERNATE_AUDIO_AUTO_SELECT_DEFAULTALTERNATE_AUDIO_NOT_AUTO_SELECTAUDIO_ONLY_VARIANT_STREAM
AudioPidSelection
Audio Pid Selection
| Property | Type | Required | Description |
|---|---|---|---|
pid | integer Minimum: 0 Maximum: 8191 | True | Selects a specific PID from within a source. |
AudioSelector
Audio Selector
| Property | Type | Required | Description |
|---|---|---|---|
name | string MinLength: 1 | True | The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input. |
selectorSettings | False | The audio selector settings. |
AudioSelectorSettings
Audio Selector Settings
| Property | Type | Required | Description |
|---|---|---|---|
audioHlsRenditionSelection | False | ||
audioLanguageSelection | False | ||
audioPidSelection | False | ||
audioTrackSelection | False |
AudioSilenceFailoverSettings
| Property | Type | Required | Description |
|---|---|---|---|
audioSelectorName | string | True | The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank. |
audioSilenceThresholdMsec | integer Minimum: 1000 | False | The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS. |
AudioTrack
Audio Track
| Property | Type | Required | Description |
|---|---|---|---|
track | integer Minimum: 1 | True | 1-based integer value that maps to a specific audio track |
AudioTrackSelection
Audio Track Selection
| Property | Type | Required | Description |
|---|---|---|---|
tracks | Array of type AudioTrack | True | Selects one or more unique audio tracks from within a source. |
AudioType
Audio Type
CLEAN_EFFECTSHEARING_IMPAIREDUNDEFINEDVISUAL_IMPAIRED_COMMENTARY
AudioWatermarkSettings
Audio Watermark Settings
| Property | Type | Required | Description |
|---|---|---|---|
nielsenWatermarksSettings | False | Settings to configure Nielsen Watermarks in the audio encode |
AuthenticationScheme
Authentication Scheme
AKAMAICOMMON
AutomaticInputFailoverSettings
The settings for Automatic Input Failover.
| Property | Type | Required | Description |
|---|---|---|---|
errorClearTimeMsec | integer Minimum: 1 | False | This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input. |
failoverConditions | Array of type FailoverCondition | False | A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input. |
inputPreference | False | Input preference when deciding which input to make active when a previously failed input has recovered. | |
secondaryInputId | string | True | The input ID of the secondary input in the automatic input failover pair. |
AvailBlanking
Avail Blanking
| Property | Type | Required | Description |
|---|---|---|---|
availBlankingImage | False | Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. | |
state | False | When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. |
AvailBlankingState
Avail Blanking State
DISABLEDENABLED
AvailConfiguration
Avail Configuration
| Property | Type | Required | Description |
|---|---|---|---|
availSettings | False | Ad avail settings. |
AvailSettings
Avail Settings
| Property | Type | Required | Description |
|---|---|---|---|
scte35SpliceInsert | False | ||
scte35TimeSignalApos | False |
BadGatewayException
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
BlackoutSlate
Blackout Slate
| Property | Type | Required | Description |
|---|---|---|---|
blackoutSlateImage | False | Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported. | |
networkEndBlackout | False | Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". | |
networkEndBlackoutImage | False | Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster. | |
networkId | string MinLength: 34 MaxLength: 34 | False | Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C"). |
state | False | When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. |
BlackoutSlateNetworkEndBlackout
Blackout Slate Network End Blackout
DISABLEDENABLED
BlackoutSlateState
Blackout Slate State
DISABLEDENABLED
BurnInAlignment
Burn In Alignment
CENTEREDLEFTSMART
BurnInBackgroundColor
Burn In Background Color
BLACKNONEWHITE
BurnInDestinationSettings
Burn In Destination Settings
| Property | Type | Required | Description |
|---|---|---|---|
alignment | False | If no explicit xPosition or yPosition 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. | |
backgroundColor | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | |
backgroundOpacity | integer Minimum: 0 Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. |
font | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | |
fontColor | 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. | |
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. |
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. |
fontSize | string | False | When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. |
outlineColor | 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. | |
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. |
shadowColor | False | Specifies the color of the shadow cast by the captions. 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 out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. |
shadowXOffset | integer | 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. |
shadowYOffset | integer | 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. |
teletextGridControl | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | |
xPosition | integer Minimum: 0 | 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 xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. |
yPosition | integer Minimum: 0 | 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 yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. |
BurnInFontColor
Burn In Font Color
BLACKBLUEGREENREDWHITEYELLOW
BurnInOutlineColor
Burn In Outline Color
BLACKBLUEGREENREDWHITEYELLOW
BurnInShadowColor
Burn In Shadow Color
BLACKNONEWHITE
BurnInTeletextGridControl
Burn In Teletext Grid Control
FIXEDSCALED
CaptionDescription
Caption Description
| Property | Type | Required | Description |
|---|---|---|---|
captionSelectorName | string | True | Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name. |
destinationSettings | False | Additional settings for captions destination that depend on the destination type. | |
languageCode | string | False | ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/ |
languageDescription | string | False | Human readable information to indicate captions available for players (eg. English, or Spanish). |
name | string | True | Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event. |
CaptionDestinationSettings
Caption Destination Settings
| Property | Type | Required | Description |
|---|---|---|---|
aribDestinationSettings | False | ||
burnInDestinationSettings | False | ||
dvbSubDestinationSettings | False | ||
ebuTtDDestinationSettings | False | ||
embeddedDestinationSettings | False | ||
embeddedPlusScte20DestinationSettings | False | ||
rtmpCaptionInfoDestinationSettings | False | ||
scte20PlusEmbeddedDestinationSettings | False | ||
scte27DestinationSettings | False | ||
smpteTtDestinationSettings | False | ||
teletextDestinationSettings | False | ||
ttmlDestinationSettings | False | ||
webvttDestinationSettings | False |
CaptionLanguageMapping
Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.
| Property | Type | Required | Description |
|---|---|---|---|
captionChannel | integer Minimum: 1 Maximum: 4 | True | The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4) |
languageCode | string MinLength: 3 MaxLength: 3 | True | Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2) |
languageDescription | string MinLength: 1 | True | Textual description of language |
CaptionRectangle
Caption Rectangle
| Property | Type | Required | Description |
|---|---|---|---|
height | number Minimum: 0 Maximum: 100 | True | See the description in leftOffset. For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \"80\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:extent - Y in the TTML standard. |
leftOffset | number Minimum: 0 Maximum: 100 | True | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them. For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard. |
topOffset | number Minimum: 0 Maximum: 100 | True | See the description in leftOffset. For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard. |
width | number Minimum: 0 Maximum: 100 | True | See the description in leftOffset. For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \"80\" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard. |
CaptionSelector
Output groups for this Live Event. Output groups contain information about where streams should be distributed.
| Property | Type | Required | Description |
|---|---|---|---|
languageCode | string | False | When specified this field indicates the three letter language code of the caption track to extract from the source. |
name | string MinLength: 1 | True | Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event. |
selectorSettings | False | Caption selector settings. |
CaptionSelectorSettings
Caption Selector Settings
| Property | Type | Required | Description |
|---|---|---|---|
ancillarySourceSettings | False | ||
aribSourceSettings | False | ||
dvbSubSourceSettings | False | ||
embeddedSourceSettings | False | ||
scte20SourceSettings | False | ||
scte27SourceSettings | False | ||
teletextSourceSettings | False |
CdiInputResolution
Maximum CDI input resolution; SD is 480i and 576i up to 30 frames-per-second (fps), HD is 720p up to 60 fps / 1080i up to 30 fps, FHD is 1080p up to 60 fps, UHD is 2160p up to 60 fps
SDHDFHDUHD
CdiInputSpecification
| Property | Type | Required | Description |
|---|---|---|---|
resolution | False | Maximum CDI input resolution |
Channel
| Property | Type | Required | Description |
|---|---|---|---|
arn | string | False | The unique arn of the channel. |
cdiInputSpecification | False | Specification of CDI inputs for this channel | |
channelClass | False | The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. | |
destinations | Array of type OutputDestination | False | A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager. |
egressEndpoints | Array of type ChannelEgressEndpoint | False | The endpoints where outgoing connections initiate from |
encoderSettings | False | ||
id | string | False | The unique ID of the channel. |
inputAttachments | Array of type InputAttachment | False | List of input attachments for channel. |
inputSpecification | False | Specification of network and file inputs for this channel | |
logLevel | False | The log level being written to CloudWatch Logs. | |
maintenance | False | Maintenance settings for this channel. | |
name | string | False | The name of the channel. (user-mutable) |
pipelineDetails | Array of type PipelineDetail | False | Runtime details for the pipelines of a running channel. |
pipelinesRunningCount | integer | False | The number of currently healthy pipelines. |
roleArn | string | False | The Amazon Resource Name (ARN) of the role assumed when running the Channel. |
state | False | ||
tags | False | A collection of key-value pairs. | |
vpc | False | Settings for VPC output |
ChannelClass
A standard channel has two encoding pipelines and a single pipeline channel only has one.
STANDARDSINGLE_PIPELINE
ChannelConfigurationValidationError
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False | |
validationErrors | Array of type ValidationError | False | A collection of validation error responses. |
ChannelEgressEndpoint
| Property | Type | Required | Description |
|---|---|---|---|
sourceIp | string | False | Public IP of where a channel's output comes from |
ChannelState
CREATINGCREATE_FAILEDIDLESTARTINGRUNNINGRECOVERINGSTOPPINGDELETINGDELETEDUPDATINGUPDATE_FAILED
ChannelSummary
| Property | Type | Required | Description |
|---|---|---|---|
arn | string | False | The unique arn of the channel. |
cdiInputSpecification | False | Specification of CDI inputs for this channel | |
channelClass | False | The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. | |
destinations | Array of type OutputDestination | False | A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager. |
egressEndpoints | Array of type ChannelEgressEndpoint | False | The endpoints where outgoing connections initiate from |
id | string | False | The unique id of the channel. |
inputAttachments | Array of type InputAttachment | False | List of input attachments for channel. |
inputSpecification | False | Specification of network and file inputs for this channel | |
logLevel | False | The log level being written to CloudWatch Logs. | |
maintenance | False | Maintenance settings for this channel. | |
name | string | False | The name of the channel. (user-mutable) |
pipelinesRunningCount | integer | False | The number of currently healthy pipelines. |
roleArn | string | False | The Amazon Resource Name (ARN) of the role assumed when running the Channel. |
state | False | ||
tags | False | A collection of key-value pairs. | |
vpc | False | Settings for any VPC outputs. |
ColorSpacePassthroughSettings
Passthrough applies no color space conversion to the output
CreateChannel
| Property | Type | Required | Description |
|---|---|---|---|
cdiInputSpecification | False | Specification of CDI inputs for this channel | |
channelClass | False | The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. | |
destinations | Array of type OutputDestination | False | |
encoderSettings | False | ||
inputAttachments | Array of type InputAttachment | False | List of input attachments for channel. |
inputSpecification | False | Specification of network and file inputs for this channel | |
logLevel | False | The log level to write to CloudWatch Logs. | |
maintenance | False | Maintenance settings for this channel. | |
name | string | False | Name of channel. |
requestId | string | False | Unique request ID to be specified. This is needed to prevent retries from creating multiple resources. |
reserved | string | False | Deprecated field that's only usable by whitelisted customers. |
roleArn | string | False | An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. |
tags | False | A collection of key-value pairs. | |
vpc | False | Settings for the VPC outputs |
CreateChannelResultModel
| Property | Type | Required | Description |
|---|---|---|---|
channel | False |
DvbNitSettings
DVB Network Information Table (NIT)
| Property | Type | Required | Description |
|---|---|---|---|
networkId | integer Minimum: 0 Maximum: 65536 | True | The numeric value placed in the Network Information Table (NIT). |
networkName | string MinLength: 1 MaxLength: 256 | True | The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters. |
repInterval | integer Minimum: 25 Maximum: 10000 | False | The number of milliseconds between instances of this table in the output transport stream. |
DvbSdtOutputSdt
Dvb Sdt Output Sdt
SDT_FOLLOWSDT_FOLLOW_IF_PRESENTSDT_MANUALSDT_NONE
DvbSdtSettings
DVB Service Description Table (SDT)
| Property | Type | Required | Description |
|---|---|---|---|
outputSdt | False | Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting 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. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. | |
repInterval | 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 serviceDescriptor in the Service Description Table. Maximum length is 256 characters. |
serviceProviderName | string MinLength: 1 MaxLength: 256 | False | The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. |
DvbSubDestinationAlignment
Dvb Sub Destination Alignment
CENTEREDLEFTSMART
DvbSubDestinationBackgroundColor
Dvb Sub Destination Background Color
BLACKNONEWHITE
DvbSubDestinationFontColor
Dvb Sub Destination Font Color
BLACKBLUEGREENREDWHITEYELLOW
DvbSubDestinationOutlineColor
Dvb Sub Destination Outline Color
BLACKBLUEGREENREDWHITEYELLOW
DvbSubDestinationSettings
Dvb Sub Destination Settings
| Property | Type | Required | Description |
|---|---|---|---|
alignment | False | If no explicit xPosition or yPosition 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. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | |
backgroundColor | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | |
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. |
font | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | |
fontColor | 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. | |
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. |
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. |
fontSize | string | False | When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. |
outlineColor | 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. | |
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. |
shadowColor | False | Specifies the color of the shadow cast by the captions. 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. |
shadowXOffset | integer | 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. |
shadowYOffset | integer | 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. |
teletextGridControl | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | |
xPosition | integer Minimum: 0 | 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 xPosition 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. |
yPosition | integer Minimum: 0 | 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 yPosition 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. |
DvbSubDestinationShadowColor
Dvb Sub Destination Shadow Color
BLACKNONEWHITE
DvbSubDestinationTeletextGridControl
Dvb Sub Destination Teletext Grid Control
FIXEDSCALED
DvbSubOcrLanguage
Dvb Sub Ocr Language
DEUENGFRANLDPORSPA
DvbSubSourceSettings
Dvb Sub Source Settings
| Property | Type | Required | Description |
|---|---|---|---|
ocrLanguage | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | |
pid | integer Minimum: 1 | 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. |
DvbTdtSettings
DVB Time and Date Table (SDT)
| Property | Type | Required | Description |
|---|---|---|---|
repInterval | integer Minimum: 1000 Maximum: 30000 | False | The number of milliseconds between instances of this table in the output transport stream. |
Eac3AttenuationControl
Eac3 Attenuation Control
ATTENUATE_3_DBNONE
Eac3BitstreamMode
Eac3 Bitstream Mode
COMMENTARYCOMPLETE_MAINEMERGENCYHEARING_IMPAIREDVISUALLY_IMPAIRED
Eac3CodingMode
Eac3 Coding Mode
CODING_MODE_1_0CODING_MODE_2_0CODING_MODE_3_2
Eac3DcFilter
Eac3 Dc Filter
DISABLEDENABLED
Eac3DrcLine
Eac3 Drc Line
FILM_LIGHTFILM_STANDARDMUSIC_LIGHTMUSIC_STANDARDNONESPEECH
Eac3DrcRf
Eac3 Drc Rf
FILM_LIGHTFILM_STANDARDMUSIC_LIGHTMUSIC_STANDARDNONESPEECH
Eac3LfeControl
Eac3 Lfe Control
LFENO_LFE
Eac3LfeFilter
Eac3 Lfe Filter
DISABLEDENABLED
Eac3MetadataControl
Eac3 Metadata Control
FOLLOW_INPUTUSE_CONFIGURED
Eac3PassthroughControl
Eac3 Passthrough Control
NO_PASSTHROUGHWHEN_POSSIBLE
Eac3PhaseControl
Eac3 Phase Control
NO_SHIFTSHIFT_90_DEGREES
Eac3Settings
Eac3 Settings
| Property | Type | Required | Description |
|---|---|---|---|
attenuationControl | False | When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. | |
bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. |
bitstreamMode | 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. | |
codingMode | False | Dolby Digital Plus coding mode. Determines number of channels. | |
dcFilter | False | When set to enabled, activates a DC highpass filter for all input channels. | |
dialnorm | integer Minimum: 1 Maximum: 31 | False | Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through. |
drcLine | False | Sets the Dolby dynamic range compression profile. | |
drcRf | False | Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. | |
lfeControl | False | When encoding 3/2 audio, setting to lfe enables the LFE channel | |
lfeFilter | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. | |
loRoCenterMixLevel | number | False | Left only/Right only center mix level. Only used for 3/2 coding mode. |
loRoSurroundMixLevel | number | False | Left only/Right only surround mix level. Only used for 3/2 coding mode. |
ltRtCenterMixLevel | number | False | Left total/Right total center mix level. Only used for 3/2 coding mode. |
ltRtSurroundMixLevel | number | False | Left total/Right total surround mix level. Only used for 3/2 coding mode. |
metadataControl | False | When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | |
passthroughControl | False | When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. | |
phaseControl | False | When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. | |
stereoDownmix | False | Stereo downmix preference. Only used for 3/2 coding mode. | |
surroundExMode | False | When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. | |
surroundMode | False | When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. |
Eac3StereoDownmix
Eac3 Stereo Downmix
DPL2LO_ROLT_RTNOT_INDICATED
Eac3SurroundExMode
Eac3 Surround Ex Mode
DISABLEDENABLEDNOT_INDICATED
Eac3SurroundMode
Eac3 Surround Mode
DISABLEDENABLEDNOT_INDICATED
EbuTtDDestinationSettings
Ebu Tt DDestination Settings
| Property | Type | Required | Description |
|---|---|---|---|
copyrightHolder | string MaxLength: 1000 | False | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML |
fillLineGap | False | Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled. | |
fontFamily | string | False | Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”. |
styleControl | False | Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information. |
EbuTtDDestinationStyleControl
Ebu Tt DDestination Style Control
EXCLUDEINCLUDE
EbuTtDFillLineGapControl
Ebu Tt DFill Line Gap Control
DISABLEDENABLED
EmbeddedConvert608To708
Embedded Convert608 To708
DISABLEDUPCONVERT
EmbeddedDestinationSettings
Embedded Destination Settings
EmbeddedPlusScte20DestinationSettings
Embedded Plus Scte20 Destination Settings
EmbeddedScte20Detection
Embedded Scte20 Detection
AUTOOFF
EmbeddedSourceSettings
Embedded Source Settings
| Property | Type | Required | Description |
|---|---|---|---|
convert608To708 | False | If 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. | |
scte20Detection | False | Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. | |
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: 5 | False | This field is unused and deprecated. |
EncoderSettings
Encoder Settings
| Property | Type | Required | Description |
|---|---|---|---|
audioDescriptions | Array of type AudioDescription | True | |
availBlanking | False | Settings for ad avail blanking. | |
availConfiguration | False | Event-wide configuration settings for ad avail insertion. | |
blackoutSlate | False | Settings for blackout slate. | |
captionDescriptions | Array of type CaptionDescription | False | Settings for caption decriptions |
featureActivations | False | Feature Activations | |
globalConfiguration | False | Configuration settings that apply to the event as a whole. | |
motionGraphicsConfiguration | False | Settings for motion graphics. | |
nielsenConfiguration | False | Nielsen configuration settings. | |
outputGroups | Array of type OutputGroup | True | |
timecodeConfig | True | Contains settings used to acquire and adjust timecode information from inputs. | |
videoDescriptions | Array of type VideoDescription | True |
FailoverCondition
Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings.
| Property | Type | Required | Description |
|---|---|---|---|
failoverConditionSettings | False | Failover condition type-specific settings. |
FailoverConditionSettings
Settings for one failover condition.
| Property | Type | Required | Description |
|---|---|---|---|
audioSilenceSettings | False | MediaLive will perform a failover if the specified audio selector is silent for the specified period. | |
inputLossSettings | False | MediaLive will perform a failover if content is not detected in this input for the specified period. | |
videoBlackSettings | False | MediaLive will perform a failover if content is considered black for the specified period. |
FeatureActivations
Feature Activations
| Property | Type | Required | Description |
|---|---|---|---|
inputPrepareScheduleActions | False | Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled. If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule. |
FeatureActivationsInputPrepareScheduleActions
Feature Activations Input Prepare Schedule Actions
DISABLEDENABLED
FecOutputIncludeFec
Fec Output Include Fec
COLUMNCOLUMN_AND_ROW
FecOutputSettings
Fec Output Settings
| Property | Type | Required | Description |
|---|---|---|---|
columnDepth | integer Minimum: 4 Maximum: 20 | False | Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive. |
includeFec | False | Enables column only or column and row based FEC | |
rowLength | integer Minimum: 1 Maximum: 20 | False | Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive. |
FixedAfd
Fixed Afd
AFD_0000AFD_0010AFD_0011AFD_0100AFD_1000AFD_1001AFD_1010AFD_1011AFD_1101AFD_1110AFD_1111
Fmp4HlsSettings
Fmp4 Hls Settings
| Property | Type | Required | Description |
|---|---|---|---|
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 ','. |
nielsenId3Behavior | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | |
timedMetadataBehavior | False | When set to passthrough, timed metadata is passed through from input to output. |
Fmp4NielsenId3Behavior
Fmp4 Nielsen Id3 Behavior
NO_PASSTHROUGHPASSTHROUGH
Fmp4TimedMetadataBehavior
Fmp4 Timed Metadata Behavior
NO_PASSTHROUGHPASSTHROUGH
FrameCaptureCdnSettings
Frame Capture Cdn Settings
| Property | Type | Required | Description |
|---|---|---|---|
frameCaptureS3Settings | False |
FrameCaptureGroupSettings
Frame Capture Group Settings
| Property | Type | Required | Description |
|---|---|---|---|
destination | True | The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, "curling-") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curling-low.00001.jpg | |
frameCaptureCdnSettings | False | Parameters that control interactions with the CDN. |
FrameCaptureHlsSettings
Frame Capture Hls Settings
FrameCaptureIntervalUnit
Frame Capture Interval Unit
MILLISECONDSSECONDS
FrameCaptureOutputSettings
Frame Capture Output Settings
| Property | Type | Required | Description |
|---|---|---|---|
nameModifier | string | False | Required if the output group contains more than one output. This modifier forms part of the output file name. |
FrameCaptureS3LogUploads
Frame Capture S3 Log Uploads
DISABLEDENABLED
FrameCaptureS3Settings
Frame Capture S3 Settings
| Property | Type | Required | Description |
|---|---|---|---|
cannedAcl | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | |
logUploads | False | When set to enabled, each upload to CDN or server will be logged. |
FrameCaptureSettings
Frame Capture Settings
| Property | Type | Required | Description |
|---|---|---|---|
captureInterval | integer Minimum: 1 Maximum: 3600000 | False | The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits. |
captureIntervalUnits | False | Unit for the frame capture interval. |
GatewayTimeoutException
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
GlobalConfiguration
Global Configuration
| Property | Type | Required | Description |
|---|---|---|---|
initialAudioGain | integer Minimum: -60 Maximum: 60 | False | Value to set the initial audio gain for the Live Event. |
inputEndAction | False | Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). | |
inputLossBehavior | False | Settings for system actions when input is lost. | |
outputLockingMode | False | Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. | |
outputTimingSource | False | Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. | |
supportLowFramerateInputs | False | Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. |
GlobalConfigurationInputEndAction
Global Configuration Input End Action
NONESWITCH_AND_LOOP_INPUTS
GlobalConfigurationLowFramerateInputs
Global Configuration Low Framerate Inputs
DISABLEDENABLED
GlobalConfigurationOutputLockingMode
Global Configuration Output Locking Mode
EPOCH_LOCKINGPIPELINE_LOCKING
GlobalConfigurationOutputTimingSource
Global Configuration Output Timing Source
INPUT_CLOCKSYSTEM_CLOCK
H264AdaptiveQuantization
H264 Adaptive Quantization
AUTOHIGHHIGHERLOWMAXMEDIUMOFF
H264ColorMetadata
H264 Color Metadata
IGNOREINSERT
H264ColorSpaceSettings
H264 Color Space Settings
| Property | Type | Required | Description |
|---|---|---|---|
colorSpacePassthroughSettings | False | ||
rec601Settings | False | ||
rec709Settings | False |
H264EntropyEncoding
H264 Entropy Encoding
CABACCAVLC
H264FilterSettings
H264 Filter Settings
| Property | Type | Required | Description |
|---|---|---|---|
temporalFilterSettings | False |
H264FlickerAq
H264 Flicker Aq
DISABLEDENABLED
H264ForceFieldPictures
H264 Force Field Pictures
DISABLEDENABLED
H264FramerateControl
H264 Framerate Control
INITIALIZE_FROM_SOURCESPECIFIED
H264GopBReference
H264 Gop BReference
DISABLEDENABLED
H264GopSizeUnits
H264 Gop Size Units
FRAMESSECONDS
H264Level
H264 Level
H264_LEVEL_1H264_LEVEL_1_1H264_LEVEL_1_2H264_LEVEL_1_3H264_LEVEL_2H264_LEVEL_2_1H264_LEVEL_2_2H264_LEVEL_3H264_LEVEL_3_1H264_LEVEL_3_2H264_LEVEL_4H264_LEVEL_4_1H264_LEVEL_4_2H264_LEVEL_5H264_LEVEL_5_1H264_LEVEL_5_2H264_LEVEL_AUTO
H264LookAheadRateControl
H264 Look Ahead Rate Control
HIGHLOWMEDIUM
H264ParControl
H264 Par Control
INITIALIZE_FROM_SOURCESPECIFIED
H264Profile
H264 Profile
BASELINEHIGHHIGH_10BITHIGH_422HIGH_422_10BITMAIN
H264QualityLevel
H264 Quality Level
ENHANCED_QUALITYSTANDARD_QUALITY
H264RateControlMode
H264 Rate Control Mode
CBRMULTIPLEXQVBRVBR
H264ScanType
H264 Scan Type
INTERLACEDPROGRESSIVE
H264SceneChangeDetect
H264 Scene Change Detect
DISABLEDENABLED
H264Settings
H264 Settings
| Property | Type | Required | Description |
|---|---|---|---|
adaptiveQuantization | False | Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization. | |
afdSignaling | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | |
bitrate | integer Minimum: 1000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. |
bufFillPct | integer Minimum: 0 Maximum: 100 | False | Percentage of the buffer that should initially be filled (HRD buffer model). |
bufSize | integer Minimum: 0 | False | Size of buffer (HRD buffer model) in bits. |
colorMetadata | False | Includes colorspace metadata in the output. | |
colorSpaceSettings | False | Color Space settings | |
entropyEncoding | False | Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. | |
filterSettings | False | Optional filters that you can apply to an encode. | |
fixedAfd | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | |
flickerAq | False | Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ. | |
forceFieldPictures | False | This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content. | |
framerateControl | False | This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. | |
framerateDenominator | integer Minimum: 1 | False | Framerate denominator. |
framerateNumerator | integer Minimum: 1 | False | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. |
gopBReference | False | If enabled, use reference B frames for GOP structures that have B frames > 1. | |
gopClosedCadence | integer Minimum: 0 | 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. |
gopNumBFrames | integer Minimum: 0 Maximum: 7 | False | Number of B-frames between reference frames. |
gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. |
gopSizeUnits | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | |
level | False | H.264 Level. | |
lookAheadRateControl | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | |
maxBitrate | integer Minimum: 1000 | False | For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video. |
minIInterval | integer Minimum: 0 Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. 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. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 |
numRefFrames | integer Minimum: 1 Maximum: 6 | False | Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding. |
parControl | False | This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. | |
parDenominator | integer Minimum: 1 | False | Pixel Aspect Ratio denominator. |
parNumerator | integer Minimum: 1 | False | Pixel Aspect Ratio numerator. |
profile | False | H.264 Profile. | |
qualityLevel | False | Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY. - STANDARD_QUALITY: Valid for any Rate control mode. | |
qvbrQualityLevel | integer Minimum: 1 Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide |
rateControlMode | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | |
scanType | False | Sets the scan type of the output to progressive or top-field-first interlaced. | |
sceneChangeDetect | False | Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. | |
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. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. |
softness | integer Minimum: 0 Maximum: 128 | False | Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15. |
spatialAq | False | Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ. | |
subgopLength | False | If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. | |
syntax | False | Produces a bitstream compliant with SMPTE RP-2027. | |
temporalAq | False | Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ. | |
timecodeInsertion | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config |
H264SpatialAq
H264 Spatial Aq
DISABLEDENABLED
H264SubGopLength
H264 Sub Gop Length
DYNAMICFIXED
H264Syntax
H264 Syntax
DEFAULTRP2027
H264TemporalAq
H264 Temporal Aq
DISABLEDENABLED
H264TimecodeInsertionBehavior
H264 Timecode Insertion Behavior
DISABLEDPIC_TIMING_SEI
H265AdaptiveQuantization
H265 Adaptive Quantization
AUTOHIGHHIGHERLOWMAXMEDIUMOFF
H265AlternativeTransferFunction
H265 Alternative Transfer Function
INSERTOMIT
H265ColorMetadata
H265 Color Metadata
IGNOREINSERT
H265ColorSpaceSettings
H265 Color Space Settings
| Property | Type | Required | Description |
|---|---|---|---|
colorSpacePassthroughSettings | False | ||
hdr10Settings | False | ||
rec601Settings | False | ||
rec709Settings | False |
H265FilterSettings
H265 Filter Settings
| Property | Type | Required | Description |
|---|---|---|---|
temporalFilterSettings | False |
H265FlickerAq
H265 Flicker Aq
DISABLEDENABLED
H265GopSizeUnits
H265 Gop Size Units
FRAMESSECONDS
H265Level
H265 Level
H265_LEVEL_1H265_LEVEL_2H265_LEVEL_2_1H265_LEVEL_3H265_LEVEL_3_1H265_LEVEL_4H265_LEVEL_4_1H265_LEVEL_5H265_LEVEL_5_1H265_LEVEL_5_2H265_LEVEL_6H265_LEVEL_6_1H265_LEVEL_6_2H265_LEVEL_AUTO
H265LookAheadRateControl
H265 Look Ahead Rate Control
HIGHLOWMEDIUM
H265Profile
H265 Profile
MAINMAIN_10BIT
H265RateControlMode
H265 Rate Control Mode
CBRMULTIPLEXQVBR
H265ScanType
H265 Scan Type
INTERLACEDPROGRESSIVE
H265SceneChangeDetect
H265 Scene Change Detect
DISABLEDENABLED
H265Settings
H265 Settings
| Property | Type | Required | Description |
|---|---|---|---|
adaptiveQuantization | False | Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. | |
afdSignaling | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | |
alternativeTransferFunction | False | Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays. | |
bitrate | integer Minimum: 100000 Maximum: 40000000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. |
bufSize | integer Minimum: 100000 Maximum: 80000000 | False | Size of buffer (HRD buffer model) in bits. |
colorMetadata | False | Includes colorspace metadata in the output. | |
colorSpaceSettings | False | Color Space settings | |
filterSettings | False | Optional filters that you can apply to an encode. | |
fixedAfd | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | |
flickerAq | False | If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. | |
framerateDenominator | integer Minimum: 1 Maximum: 3003 | True | Framerate denominator. |
framerateNumerator | integer Minimum: 1 | True | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. |
gopClosedCadence | integer Minimum: 0 | 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. |
gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. |
gopSizeUnits | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | |
level | False | H.265 Level. | |
lookAheadRateControl | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | |
maxBitrate | integer Minimum: 100000 Maximum: 40000000 | False | For QVBR: See the tooltip for Quality level |
minIInterval | integer Minimum: 0 Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. 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. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1 |
parDenominator | integer Minimum: 1 | False | Pixel Aspect Ratio denominator. |
parNumerator | integer Minimum: 1 | False | Pixel Aspect Ratio numerator. |
profile | False | H.265 Profile. | |
qvbrQualityLevel | integer Minimum: 1 Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M |
rateControlMode | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | |
scanType | False | Sets the scan type of the output to progressive or top-field-first interlaced. | |
sceneChangeDetect | False | Scene change detection. | |
slices | integer Minimum: 1 Maximum: 16 | 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. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. |
tier | False | H.265 Tier. | |
timecodeInsertion | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config |
H265Tier
H265 Tier
HIGHMAIN
H265TimecodeInsertionBehavior
H265 Timecode Insertion Behavior
DISABLEDPIC_TIMING_SEI
Hdr10Settings
Hdr10 Settings
| Property | Type | Required | Description |
|---|---|---|---|
maxCll | integer Minimum: 0 Maximum: 32768 | False | Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file. |
maxFall | integer Minimum: 0 Maximum: 32768 | False | Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file. |
HlsAdMarkers
Hls Ad Markers
ADOBEELEMENTALELEMENTAL_SCTE35
HlsAkamaiHttpTransferMode
Hls Akamai Http Transfer Mode
CHUNKEDNON_CHUNKED
HlsAkamaiSettings
Hls Akamai Settings
| Property | Type | Required | Description |
|---|---|---|---|
connectionRetryInterval | integer Minimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. |
filecacheDuration | integer Minimum: 0 Maximum: 600 | False | Size in seconds of file cache for streaming outputs. |
httpTransferMode | False | Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. | |
numRetries | integer Minimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. |
restartDelay | integer Minimum: 0 Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. |
salt | string | False | Salt for authenticated Akamai. |
token | string | False | Token parameter for authenticated akamai. If not specified, _gda_ is used. |
HlsBasicPutSettings
Hls Basic Put Settings
| Property | Type | Required | Description |
|---|---|---|---|
connectionRetryInterval | integer Minimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. |
filecacheDuration | integer Minimum: 0 Maximum: 600 | False | Size in seconds of file cache for streaming outputs. |
numRetries | integer Minimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. |
restartDelay | integer Minimum: 0 Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. |
HlsCaptionLanguageSetting
Hls Caption Language Setting
INSERTNONEOMIT
HlsCdnSettings
Hls Cdn Settings
| Property | Type | Required | Description |
|---|---|---|---|
hlsAkamaiSettings | False | ||
hlsBasicPutSettings | False | ||
hlsMediaStoreSettings | False | ||
hlsS3Settings | False | ||
hlsWebdavSettings | False |
HlsClientCache
Hls Client Cache
DISABLEDENABLED
HlsCodecSpecification
Hls Codec Specification
RFC_4281RFC_6381
HlsDirectoryStructure
Hls Directory Structure
SINGLE_DIRECTORYSUBDIRECTORY_PER_STREAM
HlsDiscontinuityTags
Hls Discontinuity Tags
INSERTNEVER_INSERT
HlsEncryptionType
Hls Encryption Type
AES128SAMPLE_AES
HlsGroupSettings
Hls Group Settings
| Property | Type | Required | Description |
|---|---|---|---|
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. |
baseUrlContent | 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. |
baseUrlContent1 | string | False | Optional. One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0. |
baseUrlManifest | 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. |
baseUrlManifest1 | string | False | Optional. One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0. |
captionLanguageMappings | Array of type CaptionLanguageMapping | False | Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert". |
captionLanguageSetting | False | Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. | |
clientCache | False | When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. | |
codecSpecification | False | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. | |
constantIv | string MinLength: 32 MaxLength: 32 | False | For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption. |
destination | True | A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled). | |
directoryStructure | False | Place segments in subdirectories. | |
discontinuityTags | False | Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags. | |
encryptionType | False | Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. | |
hlsCdnSettings | False | Parameters that control interactions with the CDN. | |
hlsId3SegmentTagging | False | State of HLS ID3 Segment Tagging | |
iFrameOnlyPlaylists | False | DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" | |
incompleteSegmentBehavior | False | Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior. | |
indexNSegments | integer Minimum: 3 | False | Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field. |
inputLossAction | False | Parameter that control output group behavior on input loss. | |
ivInManifest | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. | |
ivSource | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. | |
keepSegments | integer Minimum: 1 | False | Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player. |
keyFormat | string | False | The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given. |
keyFormatVersions | string | False | Either a single positive integer version value or a slash delimited list of version values (1/2/3). |
keyProviderSettings | False | The key provider settings. | |
manifestCompression | False | When set to gzip, compresses HLS playlist. | |
manifestDurationFormat | False | Indicates whether the output manifest should use floating point or integer values for segment duration. | |
minSegmentLength | integer Minimum: 0 | False | When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed. |
mode | False | If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. | |
outputSelection | False | MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS_ONLY: Does not generate any manifests for this output group. | |
programDateTime | False | Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. | |
programDateTimeClock | False | Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock. | |
programDateTimePeriod | integer Minimum: 0 Maximum: 3600 | False | Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. |
redundantManifest | False | ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. | |
segmentationMode | False | useInputSegmentation has been deprecated. The configured segment size is always used. | |
segmentLength | integer Minimum: 1 | 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. |
segmentsPerSubdirectory | integer Minimum: 1 | False | Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect. |
streamInfResolution | False | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. | |
timedMetadataId3Frame | False | Indicates ID3 frame that has the timecode. | |
timedMetadataId3Period | integer Minimum: 0 | False | Timed Metadata interval in seconds. |
timestampDeltaMilliseconds | integer Minimum: 0 | False | Provides an extra millisecond delta offset to fine tune the timestamps. |
tsFileMode | False | SEGMENTED_FILES: Emit the program as segments - multiple .ts media files. SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. |
HlsH265PackagingType
Hls H265 Packaging Type
HEV1HVC1
HlsId3SegmentTaggingState
State of HLS ID3 Segment Tagging
DISABLEDENABLED
HlsIncompleteSegmentBehavior
Hls Incomplete Segment Behavior
AUTOSUPPRESS
HlsInputSettings
Hls Input Settings
| Property | Type | Required | Description |
|---|---|---|---|
bandwidth | integer Minimum: 0 | False | When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest. |
bufferSegments | integer Minimum: 0 | False | When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8. |
retries | integer Minimum: 0 | False | The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable. |
retryInterval | integer Minimum: 0 | False | The number of seconds between retries when an attempt to read a manifest or segment fails. |
scte35Source | False | Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected. |
HlsIvInManifest
Hls Iv In Manifest
EXCLUDEINCLUDE
HlsIvSource
Hls Iv Source
EXPLICITFOLLOWS_SEGMENT_NUMBER
HlsManifestCompression
Hls Manifest Compression
GZIPNONE
HlsManifestDurationFormat
Hls Manifest Duration Format
FLOATING_POINTINTEGER
HlsMediaStoreSettings
Hls Media Store Settings
| Property | Type | Required | Description |
|---|---|---|---|
connectionRetryInterval | integer Minimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. |
filecacheDuration | integer Minimum: 0 Maximum: 600 | False | Size in seconds of file cache for streaming outputs. |
mediaStoreStorageClass | False | When set to temporal, output files are stored in non-persistent memory for faster reading and writing. | |
numRetries | integer Minimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. |
restartDelay | integer Minimum: 0 Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. |
HlsMediaStoreStorageClass
Hls Media Store Storage Class
TEMPORAL
HlsMode
Hls Mode
LIVEVOD
HlsOutputSelection
Hls Output Selection
MANIFESTS_AND_SEGMENTSSEGMENTS_ONLYVARIANT_MANIFESTS_AND_SEGMENTS
HlsOutputSettings
Hls Output Settings
| Property | Type | Required | Description |
|---|---|---|---|
h265PackagingType | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | |
hlsSettings | True | Settings regarding the underlying stream. These settings are different for audio-only outputs. | |
nameModifier | string MinLength: 1 | False | String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters. |
segmentModifier | string | False | String concatenated to end of segment filenames. |
HlsProgramDateTime
Hls Program Date Time
EXCLUDEINCLUDE
HlsProgramDateTimeClock
Hls Program Date Time Clock
INITIALIZE_FROM_OUTPUT_TIMECODESYSTEM_CLOCK
HlsRedundantManifest
Hls Redundant Manifest
DISABLEDENABLED
HlsS3LogUploads
Hls S3 Log Uploads
DISABLEDENABLED
HlsS3Settings
Hls S3 Settings
| Property | Type | Required | Description |
|---|---|---|---|
cannedAcl | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | |
logUploads | False | When set to enabled, each fragment upload to CDN or server will be logged. |
HlsScte35SourceType
Hls Scte35 Source Type
MANIFESTSEGMENTS
HlsSegmentationMode
Hls Segmentation Mode
USE_INPUT_SEGMENTATIONUSE_SEGMENT_DURATION
HlsSettings
Hls Settings
| Property | Type | Required | Description |
|---|---|---|---|
audioOnlyHlsSettings | False | ||
fmp4HlsSettings | False | ||
frameCaptureHlsSettings | False | ||
standardHlsSettings | False |
HlsStreamInfResolution
Hls Stream Inf Resolution
EXCLUDEINCLUDE
HlsTimedMetadataId3Frame
Hls Timed Metadata Id3 Frame
NONEPRIVTDRL
HlsTsFileMode
Hls Ts File Mode
SEGMENTED_FILESSINGLE_FILE
HlsWebdavHttpTransferMode
Hls Webdav Http Transfer Mode
CHUNKEDNON_CHUNKED
HlsWebdavSettings
Hls Webdav Settings
| Property | Type | Required | Description |
|---|---|---|---|
connectionRetryInterval | integer Minimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. |
filecacheDuration | integer Minimum: 0 Maximum: 600 | False | Size in seconds of file cache for streaming outputs. |
httpTransferMode | False | Specify whether or not to use chunked transfer encoding to WebDAV. | |
numRetries | integer Minimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. |
restartDelay | integer Minimum: 0 Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. |
HtmlMotionGraphicsSettings
Html Motion Graphics Settings
IFrameOnlyPlaylistType
When set to "standard", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.
DISABLEDSTANDARD
InputAttachment
| Property | Type | Required | Description |
|---|---|---|---|
automaticInputFailoverSettings | False | User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input. | |
inputAttachmentName | string | False | User-specified name for the attachment. This is required if the user wants to use this input in an input switch action. |
inputId | string | False | The ID of the input |
inputSettings | False | Settings of an input (caption selector, etc.) |
InputChannelLevel
Input Channel Level
| Property | Type | Required | Description |
|---|---|---|---|
gain | integer Minimum: -60 Maximum: 6 | True | Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB. |
inputChannel | integer Minimum: 0 Maximum: 15 | True | The index of the input channel used as a source. |
InputCodec
codec in increasing order of complexity
MPEG2AVCHEVC
InputDeblockFilter
Input Deblock Filter
DISABLEDENABLED
InputDenoiseFilter
Input Denoise Filter
DISABLEDENABLED
InputFilter
Input Filter
AUTODISABLEDFORCED
InputLocation
Input Location
| Property | Type | Required | Description |
|---|---|---|---|
passwordParam | string | False | key used to extract the password from EC2 Parameter store |
uri | string | True | Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live". |
username | string | False | Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://<parameter name>" |
InputLossActionForHlsOut
Input Loss Action For Hls Out
EMIT_OUTPUTPAUSE_OUTPUT
InputLossActionForMsSmoothOut
Input Loss Action For Ms Smooth Out
EMIT_OUTPUTPAUSE_OUTPUT
InputLossActionForRtmpOut
Input Loss Action For Rtmp Out
EMIT_OUTPUTPAUSE_OUTPUT
InputLossActionForUdpOut
Input Loss Action For Udp Out
DROP_PROGRAMDROP_TSEMIT_PROGRAM
InputLossBehavior
Input Loss Behavior
| Property | Type | Required | Description |
|---|---|---|---|
blackFrameMsec | integer Minimum: 0 Maximum: 1000000 | False | On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. |
inputLossImageColor | string MinLength: 6 MaxLength: 6 | False | When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB. |
inputLossImageSlate | False | When input loss image type is "slate" these fields specify the parameters for accessing the slate. | |
inputLossImageType | False | Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. | |
repeatFrameMsec | integer Minimum: 0 Maximum: 1000000 | False | On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. |
InputLossFailoverSettings
MediaLive will perform a failover if content is not detected in this input for the specified period.
| Property | Type | Required | Description |
|---|---|---|---|
inputLossThresholdMsec | integer Minimum: 100 | False | The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur. |
InputLossImageType
Input Loss Image Type
COLORSLATE
InputMaximumBitrate
Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.
MAX_10_MBPSMAX_20_MBPSMAX_50_MBPS
InputPreference
Input preference when deciding which input to make active when a previously failed input has recovered. If \"EQUAL_INPUT_PREFERENCE\", then the active input will stay active as long as it is healthy. If \"PRIMARY_INPUT_PREFERRED\", then always switch back to the primary input when it is healthy.
EQUAL_INPUT_PREFERENCEPRIMARY_INPUT_PREFERRED
InputResolution
Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines
SDHDUHD
InputSettings
Live Event input parameters. There can be multiple inputs in a single Live Event.
| Property | Type | Required | Description |
|---|---|---|---|
audioSelectors | Array of type AudioSelector | False | Used to select the audio stream to decode for inputs that have multiple available. |
captionSelectors | Array of type CaptionSelector | False | Used to select the caption input to use for inputs that have multiple available. |
deblockFilter | False | Enable or disable the deblock filter when filtering. | |
denoiseFilter | False | Enable or disable the denoise filter when filtering. | |
filterStrength | integer Minimum: 1 Maximum: 5 | False | Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest). |
inputFilter | False | Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type | |
networkInputSettings | False | Input settings. | |
smpte2038DataPreference | False | Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038. | |
sourceEndBehavior | False | Loop input if it is a file. This allows a file input to be streamed indefinitely. | |
videoSelector | False | Informs which video elementary stream to decode for input types that have multiple available. |
InputSourceEndBehavior
Input Source End Behavior
CONTINUELOOP
InputSpecification
| Property | Type | Required | Description |
|---|---|---|---|
codec | False | Input codec | |
maximumBitrate | False | Maximum input bitrate, categorized coarsely | |
resolution | False | Input resolution, categorized coarsely |
InternalServiceError
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
InvalidRequest
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
KeyProviderSettings
Key Provider Settings
| Property | Type | Required | Description |
|---|---|---|---|
staticKeySettings | False |
LimitExceeded
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
ListChannelsResultModel
| Property | Type | Required | Description |
|---|---|---|---|
channels | Array of type ChannelSummary | False | |
nextToken | string | False |
LogLevel
The log level the user wants for their channel.
ERRORWARNINGINFODEBUGDISABLED
M2tsAbsentInputAudioBehavior
M2ts Absent Input Audio Behavior
DROPENCODE_SILENCE
M2tsArib
M2ts Arib
DISABLEDENABLED
M2tsAribCaptionsPidControl
M2ts Arib Captions Pid Control
AUTOUSE_CONFIGURED
M2tsAudioBufferModel
M2ts Audio Buffer Model
ATSCDVB
M2tsAudioInterval
M2ts Audio Interval
VIDEO_AND_FIXED_INTERVALSVIDEO_INTERVAL
M2tsAudioStreamType
M2ts Audio Stream Type
ATSCDVB
M2tsBufferModel
M2ts Buffer Model
MULTIPLEXNONE
M2tsCcDescriptor
M2ts Cc Descriptor
DISABLEDENABLED
M2tsEbifControl
M2ts Ebif Control
NONEPASSTHROUGH
M2tsEbpPlacement
M2ts Ebp Placement
VIDEO_AND_AUDIO_PIDSVIDEO_PID
M2tsEsRateInPes
M2ts Es Rate In Pes
EXCLUDEINCLUDE
M2tsKlv
M2ts Klv
NONEPASSTHROUGH
M2tsNielsenId3Behavior
M2ts Nielsen Id3 Behavior
NO_PASSTHROUGHPASSTHROUGH
M2tsPcrControl
M2ts Pcr Control
CONFIGURED_PCR_PERIODPCR_EVERY_PES_PACKET
M2tsRateMode
M2ts Rate Mode
CBRVBR
M2tsScte35Control
M2ts Scte35 Control
NONEPASSTHROUGH
M2tsSegmentationMarkers
M2ts Segmentation Markers
EBPEBP_LEGACYNONEPSI_SEGSTARTRAI_ADAPTRAI_SEGSTART
M2tsSegmentationStyle
M2ts Segmentation Style
MAINTAIN_CADENCERESET_CADENCE
M2tsSettings
M2ts Settings
| Property | Type | Required | Description |
|---|---|---|---|
absentInputAudioBehavior | False | When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. | |
arib | False | When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. | |
aribCaptionsPid | string | False | Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). |
aribCaptionsPidControl | False | If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. | |
audioBufferModel | False | When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. | |
audioFramesPerPes | integer Minimum: 0 | False | The number of audio frames to insert for each PES packet. |
audioPids | string | 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. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). |
audioStreamType | False | When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. | |
bitrate | integer Minimum: 0 | False | The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. |
bufferModel | False | Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices. | |
ccDescriptor | False | When set to enabled, generates captionServiceDescriptor in PMT. | |
dvbNitSettings | False | Inserts DVB Network Information Table (NIT) at the specified table repetition interval. | |
dvbSdtSettings | False | Inserts DVB Service Description Table (SDT) at the specified table repetition interval. | |
dvbSubPids | string | False | Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). |
dvbTdtSettings | False | Inserts DVB Time and Date Table (TDT) at the specified table repetition interval. | |
dvbTeletextPid | string | False | Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). |
ebif | False | If set to passthrough, passes any EBIF data from the input source to this output. | |
ebpAudioInterval | False | When videoAndFixedIntervals is selected, 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. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. | |
ebpLookaheadMs | 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. |
ebpPlacement | False | Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. | |
ecmPid | string | False | This field is unused and deprecated. |
esRateInPes | False | Include or exclude the ES Rate field in the PES header. | |
etvPlatformPid | string | False | Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). |
etvSignalPid | string | False | Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). |
fragmentTime | number Minimum: 0 | False | The length in seconds of each fragment. Only used with EBP markers. |
klv | False | If set to passthrough, passes any KLV data from the input source to this output. | |
klvDataPids | string | False | Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). |
nielsenId3Behavior | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | |
nullPacketBitrate | number Minimum: 0 | False | Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets. |
patInterval | integer Minimum: 0 Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. |
pcrControl | False | When set to pcrEveryPesPacket, 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. | |
pcrPeriod | integer Minimum: 0 Maximum: 500 | False | Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream. |
pcrPid | string | 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. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). |
pmtInterval | integer Minimum: 0 Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. |
pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). |
programNum | integer Minimum: 0 Maximum: 65535 | False | The value of the program number field in the Program Map Table. |
rateMode | False | When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. | |
scte27Pids | string | False | Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). |
scte35Control | False | Optionally pass SCTE-35 signals from the input source to this output. | |
scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). |
segmentationMarkers | False | Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart 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. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. | |
segmentationStyle | 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 "resetCadence" 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 $segmentationTime seconds. When a segmentation style of "maintainCadence" 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 $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. | |
segmentationTime | number Minimum: 1 | False | The length in seconds of each segment. Required unless markers is set to _none_. |
timedMetadataBehavior | False | When set to passthrough, timed metadata will be passed through from input to output. | |
timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). |
transportStreamId | integer Minimum: 0 Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. |
videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). |
M2tsTimedMetadataBehavior
M2ts Timed Metadata Behavior
NO_PASSTHROUGHPASSTHROUGH
M3u8NielsenId3Behavior
M3u8 Nielsen Id3 Behavior
NO_PASSTHROUGHPASSTHROUGH
M3u8PcrControl
M3u8 Pcr Control
CONFIGURED_PCR_PERIODPCR_EVERY_PES_PACKET
M3u8Scte35Behavior
M3u8 Scte35 Behavior
NO_PASSTHROUGHPASSTHROUGH
M3u8Settings
Settings information for the .m3u8 container
| Property | Type | Required | Description |
|---|---|---|---|
audioFramesPerPes | integer Minimum: 0 | False | The number of audio frames to insert for each PES packet. |
audioPids | string | 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. Can be entered as decimal or hexadecimal values. |
ecmPid | string | False | This parameter is unused and deprecated. |
nielsenId3Behavior | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | |
patInterval | integer Minimum: 0 Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file. |
pcrControl | False | When set to pcrEveryPesPacket, 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. | |
pcrPeriod | integer Minimum: 0 Maximum: 500 | False | Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream. |
pcrPid | string | 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. Can be entered as a decimal or hexadecimal value. |
pmtInterval | integer Minimum: 0 Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file. |
pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. |
programNum | integer Minimum: 0 Maximum: 65535 | False | The value of the program number field in the Program Map Table. |
scte35Behavior | False | If set to passthrough, passes any SCTE-35 signals from the input source to this output. | |
scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. |
timedMetadataBehavior | False | When set to passthrough, timed metadata is passed through from input to output. | |
timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). |
transportStreamId | integer Minimum: 0 Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. |
videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. |
M3u8TimedMetadataBehavior
M3u8 Timed Metadata Behavior
NO_PASSTHROUGHPASSTHROUGH
MaintenanceCreateSettings
| Property | Type | Required | Description |
|---|---|---|---|
maintenanceDay | False | Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows. | |
maintenanceStartTime | string Pattern: | False | Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows. |
MaintenanceDay
The currently selected maintenance day.
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY
MaintenanceStatus
| Property | Type | Required | Description |
|---|---|---|---|
maintenanceDay | False | The currently selected maintenance day. | |
maintenanceDeadline | string Format: string | False | Maintenance is required by the displayed date and time. Date and time is in ISO. |
maintenanceScheduledDate | string Format: string | False | The currently scheduled maintenance date and time. Date and time is in ISO. |
maintenanceStartTime | string | False | The currently selected maintenance start time. Time is in UTC. |
MediaPackageGroupSettings
Media Package Group Settings
| Property | Type | Required | Description |
|---|---|---|---|
destination | True | MediaPackage channel destination. |
MediaPackageOutputDestinationSettings
MediaPackage Output Destination Settings
| Property | Type | Required | Description |
|---|---|---|---|
channelId | string MinLength: 1 | False | ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region. |
MediaPackageOutputSettings
Media Package Output Settings
MotionGraphicsConfiguration
Motion Graphics Configuration
| Property | Type | Required | Description |
|---|---|---|---|
motionGraphicsInsertion | False | ||
motionGraphicsSettings | True | Motion Graphics Settings |
MotionGraphicsInsertion
Motion Graphics Insertion
DISABLEDENABLED
MotionGraphicsSettings
Motion Graphics Settings
| Property | Type | Required | Description |
|---|---|---|---|
htmlMotionGraphicsSettings | False |
Mp2CodingMode
Mp2 Coding Mode
CODING_MODE_1_0CODING_MODE_2_0
Mp2Settings
Mp2 Settings
| Property | Type | Required | Description |
|---|---|---|---|
bitrate | number | False | Average bitrate in bits/second. |
codingMode | False | The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). | |
sampleRate | number | False | Sample rate in Hz. |
Mpeg2AdaptiveQuantization
Mpeg2 Adaptive Quantization
AUTOHIGHLOWMEDIUMOFF
Mpeg2ColorMetadata
Mpeg2 Color Metadata
IGNOREINSERT
Mpeg2ColorSpace
Mpeg2 Color Space
AUTOPASSTHROUGH
Mpeg2DisplayRatio
Mpeg2 Display Ratio
DISPLAYRATIO16X9DISPLAYRATIO4X3
Mpeg2FilterSettings
Mpeg2 Filter Settings
| Property | Type | Required | Description |
|---|---|---|---|
temporalFilterSettings | False |
Mpeg2GopSizeUnits
Mpeg2 Gop Size Units
FRAMESSECONDS
Mpeg2ScanType
Mpeg2 Scan Type
INTERLACEDPROGRESSIVE
Mpeg2Settings
Mpeg2 Settings
| Property | Type | Required | Description |
|---|---|---|---|
adaptiveQuantization | False | Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality. | |
afdSignaling | False | Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD. | |
colorMetadata | False | Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata. | |
colorSpace | False | Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \"MediaLive Features - Video - color space\" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709. | |
displayAspectRatio | False | Sets the pixel aspect ratio for the encode. | |
filterSettings | False | Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate. | |
fixedAfd | False | Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode. | |
framerateDenominator | integer Minimum: 1 | True | description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. |
framerateNumerator | integer Minimum: 1 | True | The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. |
gopClosedCadence | integer Minimum: 0 | False | MPEG2: default is open GOP. |
gopNumBFrames | integer Minimum: 0 Maximum: 7 | False | Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default. |
gopSize | number | False | Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer. |
gopSizeUnits | False | Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count. | |
scanType | False | Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first). | |
subgopLength | False | Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality. | |
timecodeInsertion | False | Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \"MediaLive Features - Timecode configuration\" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP_TIMECODE: Include timecode metadata in the GOP header. |
Mpeg2SubGopLength
Mpeg2 Sub Gop Length
DYNAMICFIXED
Mpeg2TimecodeInsertionBehavior
Mpeg2 Timecode Insertion Behavior
DISABLEDGOP_TIMECODE
MsSmoothGroupSettings
Ms Smooth Group Settings
| Property | Type | Required | Description |
|---|---|---|---|
acquisitionPointId | string | False | The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE. |
audioOnlyTimecodeControl | False | If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. | |
certificateMode | False | If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. | |
connectionRetryInterval | integer Minimum: 0 | False | Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established. |
destination | True | Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS. | |
eventId | string | False | MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured. |
eventIdMode | False | Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. | |
eventStopBehavior | False | When set to sendEos, send EOS signal to IIS server when stopping the event | |
filecacheDuration | integer Minimum: 0 | False | Size in seconds of file cache for streaming outputs. |
fragmentLength | integer Minimum: 1 | False | Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate. |
inputLossAction | False | Parameter that control output group behavior on input loss. | |
numRetries | integer Minimum: 0 | False | Number of retry attempts. |
restartDelay | integer Minimum: 0 | False | Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration. |
segmentationMode | False | useInputSegmentation has been deprecated. The configured segment size is always used. | |
sendDelayMs | integer Minimum: 0 Maximum: 10000 | False | Number of milliseconds to delay the output from the second pipeline. |
sparseTrackType | False | Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group. | |
streamManifestBehavior | False | When set to send, send stream manifest so publishing point doesn't start until all streams start. | |
timestampOffset | string | False | Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset. |
timestampOffsetMode | False | Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset |
MsSmoothH265PackagingType
Ms Smooth H265 Packaging Type
HEV1HVC1
MsSmoothOutputSettings
Ms Smooth Output Settings
| Property | Type | Required | Description |
|---|---|---|---|
h265PackagingType | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | |
nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. |
MultiplexGroupSettings
Multiplex Group Settings
MultiplexOutputSettings
Multiplex Output Settings
| Property | Type | Required | Description |
|---|---|---|---|
destination | True | Destination is a Multiplex. |
MultiplexProgramChannelDestinationSettings
Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex
| Property | Type | Required | Description |
|---|---|---|---|
multiplexId | string MinLength: 1 | False | The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel. |
programName | string MinLength: 1 | False | The program name of the Multiplex program that the encoder is providing output to. |
NetworkInputServerValidation
Network Input Server Validation
CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAMECHECK_CRYPTOGRAPHY_ONLY
NetworkInputSettings
Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection.
| Property | Type | Required | Description |
|---|---|---|---|
hlsInputSettings | False | Specifies HLS input settings when the uri is for a HLS manifest. | |
serverValidation | False | Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. |
NielsenCBET
Nielsen CBET
| Property | Type | Required | Description |
|---|---|---|---|
cbetCheckDigitString | string MinLength: 2 MaxLength: 2 | True | Enter the CBET check digits to use in the watermark. |
cbetStepaside | True | Determines the method of CBET insertion mode when prior encoding is detected on the same layer. | |
csid | string MinLength: 1 MaxLength: 7 | True | Enter the CBET Source ID (CSID) to use in the watermark |
NielsenConfiguration
Nielsen Configuration
| Property | Type | Required | Description |
|---|---|---|---|
distributorId | string | False | Enter the Distributor ID assigned to your organization by Nielsen. |
nielsenPcmToId3Tagging | False | Enables Nielsen PCM to ID3 tagging |
NielsenNaesIiNw
Nielsen Naes Ii Nw
| Property | Type | Required | Description |
|---|---|---|---|
checkDigitString | string MinLength: 2 MaxLength: 2 | True | Enter the check digit string for the watermark |
sid | number Minimum: 1 Maximum: 65535 | True | Enter the Nielsen Source ID (SID) to include in the watermark |
NielsenPcmToId3TaggingState
State of Nielsen PCM to ID3 tagging
DISABLEDENABLED
NielsenWatermarksCbetStepaside
Nielsen Watermarks Cbet Stepaside
DISABLEDENABLED
NielsenWatermarksDistributionTypes
Nielsen Watermarks Distribution Types
FINAL_DISTRIBUTORPROGRAM_CONTENT
NielsenWatermarksSettings
Nielsen Watermarks Settings
| Property | Type | Required | Description |
|---|---|---|---|
nielsenCbetSettings | False | Complete these fields only if you want to insert watermarks of type Nielsen CBET | |
nielsenDistributionType | False | Choose the distribution types that you want to assign to the watermarks: - PROGRAM_CONTENT - FINAL_DISTRIBUTOR | |
nielsenNaesIiNwSettings | False | Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW). |
Output
Output settings. There can be multiple outputs within a group.
| Property | Type | Required | Description |
|---|---|---|---|
audioDescriptionNames | Array of type string | False | The names of the AudioDescriptions used as audio sources for this output. |
captionDescriptionNames | Array of type string | False | The names of the CaptionDescriptions used as caption sources for this output. |
outputName | string MinLength: 1 MaxLength: 255 | False | The name used to identify an output. |
outputSettings | True | Output type-specific settings. | |
videoDescriptionName | string | False | The name of the VideoDescription used as the source for this output. |
OutputDestination
| Property | Type | Required | Description |
|---|---|---|---|
id | string | False | User-specified id. This is used in an output group or an output. |
mediaPackageSettings | Array of type MediaPackageOutputDestinationSettings | False | Destination settings for a MediaPackage output; one destination for both encoders. |
multiplexSettings | False | Destination settings for a Multiplex output; one destination for both encoders. | |
settings | Array of type OutputDestinationSettings | False | Destination settings for a standard output; one destination for each redundant encoder. |
OutputDestinationSettings
| Property | Type | Required | Description |
|---|---|---|---|
passwordParam | string | False | key used to extract the password from EC2 Parameter store |
streamName | string | False | Stream name for RTMP destinations (URLs of type rtmp://) |
url | string | False | A URL specifying a destination |
username | string | False | username for destination |
OutputGroup
Output groups for this Live Event. Output groups contain information about where streams should be distributed.
| Property | Type | Required | Description |
|---|---|---|---|
name | string MaxLength: 32 | False | Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed. |
outputGroupSettings | True | Settings associated with the output group. | |
outputs | Array of type Output | True |
OutputGroupSettings
Output Group Settings
| Property | Type | Required | Description |
|---|---|---|---|
archiveGroupSettings | False | ||
frameCaptureGroupSettings | False | ||
hlsGroupSettings | False | ||
mediaPackageGroupSettings | False | ||
msSmoothGroupSettings | False | ||
multiplexGroupSettings | False | ||
rtmpGroupSettings | False | ||
udpGroupSettings | False |
OutputLocationRef
Reference to an OutputDestination ID defined in the channel
| Property | Type | Required | Description |
|---|---|---|---|
destinationRefId | string | False |
OutputSettings
Output Settings
| Property | Type | Required | Description |
|---|---|---|---|
archiveOutputSettings | False | ||
frameCaptureOutputSettings | False | ||
hlsOutputSettings | False | ||
mediaPackageOutputSettings | False | ||
msSmoothOutputSettings | False | ||
multiplexOutputSettings | False | ||
rtmpOutputSettings | False | ||
udpOutputSettings | False |
PassThroughSettings
Pass Through Settings
PipelineDetail
Runtime details of a pipeline when a channel is running.
| Property | Type | Required | Description |
|---|---|---|---|
activeInputAttachmentName | string | False | The name of the active input attachment currently being ingested by this pipeline. |
activeInputSwitchActionName | string | False | The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline. |
activeMotionGraphicsActionName | string | False | The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline. |
activeMotionGraphicsUri | string | False | The current URI being used for HTML5 motion graphics for this pipeline. |
pipelineId | string | False | Pipeline ID |
RawSettings
Raw Settings
Rec601Settings
Rec601 Settings
Rec709Settings
Rec709 Settings
RemixSettings
Remix Settings
| Property | Type | Required | Description |
|---|---|---|---|
channelMappings | Array of type AudioChannelMapping | True | Mapping of input channels to output channels, with appropriate gain adjustments. |
channelsIn | integer Minimum: 1 Maximum: 16 | False | Number of input channels to be used. |
channelsOut | integer Minimum: 1 Maximum: 8 | False | Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8 |
ResourceConflict
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
RtmpAdMarkers
Rtmp Ad Markers
ON_CUE_POINT_SCTE35
RtmpCacheFullBehavior
Rtmp Cache Full Behavior
DISCONNECT_IMMEDIATELYWAIT_FOR_SERVER
RtmpCaptionData
Rtmp Caption Data
ALLFIELD1_608FIELD1_AND_FIELD2_608
RtmpCaptionInfoDestinationSettings
Rtmp Caption Info Destination Settings
RtmpGroupSettings
Rtmp Group Settings
| Property | Type | Required | Description |
|---|---|---|---|
adMarkers | Array of type RtmpAdMarkers | False | Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream. |
authenticationScheme | False | Authentication scheme to use when connecting with CDN | |
cacheFullBehavior | False | Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. | |
cacheLength | integer Minimum: 30 | False | Cache length, in seconds, is used to calculate buffer size. |
captionData | False | Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. | |
inputLossAction | False | Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. | |
restartDelay | integer Minimum: 0 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. |
RtmpOutputCertificateMode
Rtmp Output Certificate Mode
SELF_SIGNEDVERIFY_AUTHENTICITY
RtmpOutputSettings
Rtmp Output Settings
| Property | Type | Required | Description |
|---|---|---|---|
certificateMode | False | If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. | |
connectionRetryInterval | integer Minimum: 1 | False | Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost. |
destination | True | The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers. | |
numRetries | integer Minimum: 0 | False | Number of retry attempts. |
S3CannedAcl
S3 Canned Acl
AUTHENTICATED_READBUCKET_OWNER_FULL_CONTROLBUCKET_OWNER_READPUBLIC_READ
Scte20Convert608To708
Scte20 Convert608 To708
DISABLEDUPCONVERT
Scte20PlusEmbeddedDestinationSettings
Scte20 Plus Embedded Destination Settings
Scte20SourceSettings
Scte20 Source Settings
| Property | Type | Required | Description |
|---|---|---|---|
convert608To708 | False | If 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. | |
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. |
Scte27DestinationSettings
Scte27 Destination Settings
Scte27OcrLanguage
Scte27 Ocr Language
DEUENGFRANLDPORSPA
Scte27SourceSettings
Scte27 Source Settings
| Property | Type | Required | Description |
|---|---|---|---|
ocrLanguage | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | |
pid | integer Minimum: 1 | False | The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through. |
Scte35AposNoRegionalBlackoutBehavior
Scte35 Apos No Regional Blackout Behavior
FOLLOWIGNORE
Scte35AposWebDeliveryAllowedBehavior
Scte35 Apos Web Delivery Allowed Behavior
FOLLOWIGNORE
Scte35SpliceInsert
Scte35 Splice Insert
| Property | Type | Required | Description |
|---|---|---|---|
adAvailOffset | integer Minimum: -1000 Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. |
noRegionalBlackoutFlag | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | |
webDeliveryAllowedFlag | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates |
Scte35SpliceInsertNoRegionalBlackoutBehavior
Scte35 Splice Insert No Regional Blackout Behavior
FOLLOWIGNORE
Scte35SpliceInsertWebDeliveryAllowedBehavior
Scte35 Splice Insert Web Delivery Allowed Behavior
FOLLOWIGNORE
Scte35TimeSignalApos
Scte35 Time Signal Apos
| Property | Type | Required | Description |
|---|---|---|---|
adAvailOffset | integer Minimum: -1000 Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. |
noRegionalBlackoutFlag | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | |
webDeliveryAllowedFlag | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates |
SmoothGroupAudioOnlyTimecodeControl
Smooth Group Audio Only Timecode Control
PASSTHROUGHUSE_CONFIGURED_CLOCK
SmoothGroupCertificateMode
Smooth Group Certificate Mode
SELF_SIGNEDVERIFY_AUTHENTICITY
SmoothGroupEventIdMode
Smooth Group Event Id Mode
NO_EVENT_IDUSE_CONFIGUREDUSE_TIMESTAMP
SmoothGroupEventStopBehavior
Smooth Group Event Stop Behavior
NONESEND_EOS
SmoothGroupSegmentationMode
Smooth Group Segmentation Mode
USE_INPUT_SEGMENTATIONUSE_SEGMENT_DURATION
SmoothGroupSparseTrackType
Smooth Group Sparse Track Type
NONESCTE_35SCTE_35_WITHOUT_SEGMENTATION
SmoothGroupStreamManifestBehavior
Smooth Group Stream Manifest Behavior
DO_NOT_SENDSEND
SmoothGroupTimestampOffsetMode
Smooth Group Timestamp Offset Mode
USE_CONFIGURED_OFFSETUSE_EVENT_START_DATE
Smpte2038DataPreference
Smpte2038 Data Preference
IGNOREPREFER
SmpteTtDestinationSettings
Smpte Tt Destination Settings
StandardHlsSettings
Standard Hls Settings
| Property | Type | Required | Description |
|---|---|---|---|
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 ','. |
m3u8Settings | True |
StaticKeySettings
Static Key Settings
| Property | Type | Required | Description |
|---|---|---|---|
keyProviderServer | False | The URL of the license server used for protecting content. | |
staticKeyValue | string MinLength: 32 MaxLength: 32 | True | Static key value as a 32 character hexadecimal string. |
Tags
| Property | Type | Required | Description |
|---|---|---|---|
| string | False |
TeletextDestinationSettings
Teletext Destination Settings
TeletextSourceSettings
Teletext Source Settings
| Property | Type | Required | Description |
|---|---|---|---|
outputRectangle | False | Optionally defines a region where TTML style captions will be displayed | |
pageNumber | string | False | Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix. |
TemporalFilterPostFilterSharpening
Temporal Filter Post Filter Sharpening
AUTODISABLEDENABLED
TemporalFilterSettings
Temporal Filter Settings
| Property | Type | Required | Description |
|---|---|---|---|
postFilterSharpening | False | If you enable this filter, the results are the following: - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source. - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR. | |
strength | False | Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft. |
TemporalFilterStrength
Temporal Filter Strength
AUTOSTRENGTH_1STRENGTH_2STRENGTH_3STRENGTH_4STRENGTH_5STRENGTH_6STRENGTH_7STRENGTH_8STRENGTH_9STRENGTH_10STRENGTH_11STRENGTH_12STRENGTH_13STRENGTH_14STRENGTH_15STRENGTH_16
TimecodeConfig
Timecode Config
| Property | Type | Required | Description |
|---|---|---|---|
source | True | Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. | |
syncThreshold | integer Minimum: 1 Maximum: 1000000 | False | Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified. |
TimecodeConfigSource
Timecode Config Source
EMBEDDEDSYSTEMCLOCKZEROBASED
TtmlDestinationSettings
Ttml Destination Settings
| Property | Type | Required | Description |
|---|---|---|---|
styleControl | False | When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. |
TtmlDestinationStyleControl
Ttml Destination Style Control
PASSTHROUGHUSE_CONFIGURED
UdpContainerSettings
Udp Container Settings
| Property | Type | Required | Description |
|---|---|---|---|
m2tsSettings | False |
UdpGroupSettings
Udp Group Settings
| Property | Type | Required | Description |
|---|---|---|---|
inputLossAction | False | Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. | |
timedMetadataId3Frame | False | Indicates ID3 frame that has the timecode. | |
timedMetadataId3Period | integer Minimum: 0 | False | Timed Metadata interval in seconds. |
UdpOutputSettings
Udp Output Settings
| Property | Type | Required | Description |
|---|---|---|---|
bufferMsec | integer Minimum: 0 Maximum: 10000 | False | UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc. |
containerSettings | True | ||
destination | True | Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002). | |
fecOutputSettings | False | Settings for enabling and adjusting Forward Error Correction on UDP outputs. |
UdpTimedMetadataId3Frame
Udp Timed Metadata Id3 Frame
NONEPRIVTDRL
ValidationError
| Property | Type | Required | Description |
|---|---|---|---|
elementPath | string | False | Path to the source of the error. |
errorMessage | string | False | The error message. |
VideoBlackFailoverSettings
| Property | Type | Required | Description |
|---|---|---|---|
blackDetectThreshold | number Minimum: 0 Maximum: 1 | False | A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023*0.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255*0.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places. |
videoBlackThresholdMsec | integer Minimum: 1000 | False | The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs. |
VideoCodecSettings
Video Codec Settings
| Property | Type | Required | Description |
|---|---|---|---|
frameCaptureSettings | False | ||
h264Settings | False | ||
h265Settings | False | ||
mpeg2Settings | False |
VideoDescription
Video settings for this stream.
| Property | Type | Required | Description |
|---|---|---|---|
codecSettings | False | Video codec settings. | |
height | integer | False | Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. |
name | string | True | The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event. |
respondToAfd | False | Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output | |
scalingBehavior | False | STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. | |
sharpness | integer Minimum: 0 Maximum: 100 | False | Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content. |
width | integer | False | Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. |
VideoDescriptionRespondToAfd
Video Description Respond To Afd
NONEPASSTHROUGHRESPOND
VideoDescriptionScalingBehavior
Video Description Scaling Behavior
DEFAULTSTRETCH_TO_OUTPUT
VideoSelector
Specifies a particular video stream within an input source. An input may have only a single video selector.
| Property | Type | Required | Description |
|---|---|---|---|
colorSpace | False | Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed. | |
colorSpaceSettings | False | Color space settings | |
colorSpaceUsage | False | Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. | |
selectorSettings | False | The video selector settings. |
VideoSelectorColorSpace
Video Selector Color Space
FOLLOWHDR10HLG_2020REC_601REC_709
VideoSelectorColorSpaceSettings
Video Selector Color Space Settings
| Property | Type | Required | Description |
|---|---|---|---|
hdr10Settings | False |
VideoSelectorColorSpaceUsage
Video Selector Color Space Usage
FALLBACKFORCE
VideoSelectorPid
Video Selector Pid
| Property | Type | Required | Description |
|---|---|---|---|
pid | integer Minimum: 0 Maximum: 8191 | False | Selects a specific PID from within a video source. |
VideoSelectorProgramId
Video Selector Program Id
| Property | Type | Required | Description |
|---|---|---|---|
programId | integer Minimum: 0 Maximum: 65536 | False | Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default. |
VideoSelectorSettings
Video Selector Settings
| Property | Type | Required | Description |
|---|---|---|---|
videoSelectorPid | False | ||
videoSelectorProgramId | False |
VpcOutputSettings
The properties for a private VPC Output When this property is specified, the output egress addresses will be created in a user specified VPC
| Property | Type | Required | Description |
|---|---|---|---|
publicAddressAllocationIds | Array of type string | False | List of public address allocation ids to associate with ENIs that will be created in Output VPC. Must specify one for SINGLE_PIPELINE, two for STANDARD channels |
securityGroupIds | Array of type string | False | A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces. If none are specified then the VPC default security group will be used |
subnetIds | Array of type string | True | A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ). |
VpcOutputSettingsDescription
The properties for a private VPC Output
| Property | Type | Required | Description |
|---|---|---|---|
availabilityZones | Array of type string | False | The Availability Zones where the vpc subnets are located. The first Availability Zone applies to the first subnet in the list of subnets. The second Availability Zone applies to the second subnet. |
networkInterfaceIds | Array of type string | False | A list of Elastic Network Interfaces created by MediaLive in the customer's VPC |
securityGroupIds | Array of type string | False | A list of up EC2 VPC security group IDs attached to the Output VPC network interfaces. |
subnetIds | Array of type string | False | A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ). |
WavCodingMode
Wav Coding Mode
CODING_MODE_1_0CODING_MODE_2_0CODING_MODE_4_0CODING_MODE_8_0
WavSettings
Wav Settings
| Property | Type | Required | Description |
|---|---|---|---|
bitDepth | number | False | Bits per sample. |
codingMode | False | The audio coding mode for the WAV audio. The mode determines the number of channels in the audio. | |
sampleRate | number | False | Sample rate in Hz. |
WebvttDestinationSettings
Webvtt Destination Settings
| Property | Type | Required | Description |
|---|---|---|---|
styleControl | False | Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don't pass through the style. The output captions will not contain any font styling information. |
WebvttDestinationStyleControl
Webvtt Destination Style Control
NO_STYLE_DATAPASSTHROUGH
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
ListChannels
CreateChannel
