Channels channelId Start - AWS Elemental MediaLive API Reference

Channels channelId Start

URI

/prod/channels/channelId/start

HTTP Methods

POST

Operation ID: StartChannel

Starts an existing channel

Path Parameters
Name Type Required Description
channelId String True
Responses
Status Code Response Model Description
200 Channel

200 response

400 InvalidRequest

400 response

403 AccessDenied

403 response

404 ResourceNotFound

404 response

409 ResourceConflict

409 response

429 LimitExceeded

429 response

500 InternalServiceError

500 response

502 BadGatewayException

502 response

504 GatewayTimeoutException

504 response

Schemas

Response Bodies

Example Channel

{ "name": "string", "id": "string", "arn": "string", "inputAttachments": [ { "inputId": "string", "inputAttachmentName": "string", "inputSettings": { "networkInputSettings": { "hlsInputSettings": { "bandwidth": integer, "retries": integer, "retryInterval": integer, "bufferSegments": integer }, "serverValidation": enum }, "sourceEndBehavior": enum, "inputFilter": enum, "filterStrength": integer, "deblockFilter": enum, "denoiseFilter": enum, "smpte2038DataPreference": enum, "videoSelector": { "selectorSettings": { "videoSelectorProgramId": { "programId": integer }, "videoSelectorPid": { "pid": integer } }, "colorSpace": enum, "colorSpaceUsage": enum }, "audioSelectors": [ { "name": "string", "selectorSettings": { "audioPidSelection": { "pid": integer }, "audioLanguageSelection": { "languageCode": "string", "languageSelectionPolicy": enum }, "audioTrackSelection": { "tracks": [ { "track": integer } ] } } } ], "captionSelectors": [ { "selectorSettings": { "ancillarySourceSettings": { "sourceAncillaryChannelNumber": integer }, "embeddedSourceSettings": { "source608ChannelNumber": integer, "source608TrackNumber": integer, "convert608To708": enum, "scte20Detection": enum }, "teletextSourceSettings": { "pageNumber": "string" }, "dvbSubSourceSettings": { "pid": integer }, "scte27SourceSettings": { "pid": integer }, "scte20SourceSettings": { "source608ChannelNumber": integer, "convert608To708": enum }, "aribSourceSettings": { } }, "name": "string", "languageCode": "string" } ] }, "automaticInputFailoverSettings": { "secondaryInputId": "string", "inputPreference": enum, "errorClearTimeMsec": integer, "failoverConditions": [ { "failoverConditionSettings": { "inputLossSettings": { "inputLossThresholdMsec": integer }, "videoBlackSettings": { "videoBlackThresholdMsec": integer, "blackDetectThreshold": number }, "audioSilenceSettings": { "audioSilenceThresholdMsec": integer, "audioSelectorName": "string" } } } ] } } ], "state": enum, "pipelinesRunningCount": integer, "destinations": [ { "id": "string", "settings": [ { "url": "string", "username": "string", "passwordParam": "string", "streamName": "string" } ], "mediaPackageSettings": [ { "channelId": "string" } ], "multiplexSettings": { "multiplexId": "string", "programName": "string" } } ], "egressEndpoints": [ { "sourceIp": "string" } ], "encoderSettings": { "audioDescriptions": [ { "audioSelectorName": "string", "audioType": enum, "codecSettings": { "aacSettings": { "inputType": enum, "bitrate": number, "codingMode": enum, "rawFormat": enum, "spec": enum, "profile": enum, "rateControlMode": enum, "sampleRate": number, "vbrQuality": enum }, "ac3Settings": { "bitrate": number, "bitstreamMode": enum, "codingMode": enum, "dialnorm": integer, "drcProfile": enum, "metadataControl": enum, "lfeFilter": enum }, "eac3Settings": { "attenuationControl": enum, "bitrate": number, "bitstreamMode": enum, "codingMode": enum, "dcFilter": enum, "dialnorm": integer, "drcLine": enum, "drcRf": enum, "lfeControl": enum, "lfeFilter": enum, "metadataControl": enum, "loRoCenterMixLevel": number, "loRoSurroundMixLevel": number, "ltRtCenterMixLevel": number, "ltRtSurroundMixLevel": number, "passthroughControl": enum, "phaseControl": enum, "stereoDownmix": enum, "surroundExMode": enum, "surroundMode": enum }, "mp2Settings": { "codingMode": enum, "bitrate": number, "sampleRate": number }, "passThroughSettings": { }, "wavSettings": { "codingMode": enum, "sampleRate": number, "bitDepth": number } }, "audioTypeControl": enum, "languageCodeControl": enum, "languageCode": "string", "name": "string", "remixSettings": { "channelsIn": integer, "channelsOut": integer, "channelMappings": [ { "outputChannel": integer, "inputChannelLevels": [ { "inputChannel": integer, "gain": integer } ] } ] }, "streamName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "targetLkfs": number } } ], "availBlanking": { "state": enum, "availBlankingImage": { "passwordParam": "string", "uri": "string", "username": "string" } }, "availConfiguration": { "availSettings": { "scte35TimeSignalApos": { "webDeliveryAllowedFlag": enum, "noRegionalBlackoutFlag": enum, "adAvailOffset": integer }, "scte35SpliceInsert": { "webDeliveryAllowedFlag": enum, "noRegionalBlackoutFlag": enum, "adAvailOffset": integer } } }, "blackoutSlate": { "state": enum, "blackoutSlateImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "networkEndBlackout": enum, "networkId": "string", "networkEndBlackoutImage": { "passwordParam": "string", "uri": "string", "username": "string" } }, "captionDescriptions": [ { "name": "string", "captionSelectorName": "string", "languageCode": "string", "destinationSettings": { "dvbSubDestinationSettings": { "font": { "passwordParam": "string", "uri": "string", "username": "string" }, "fontSize": "string", "fontResolution": integer, "alignment": enum, "xPosition": integer, "yPosition": integer, "teletextGridControl": enum, "fontColor": enum, "fontOpacity": integer, "backgroundColor": enum, "backgroundOpacity": integer, "outlineSize": integer, "outlineColor": enum, "shadowColor": enum, "shadowOpacity": integer, "shadowXOffset": integer, "shadowYOffset": integer }, "burnInDestinationSettings": { "font": { "passwordParam": "string", "uri": "string", "username": "string" }, "fontSize": "string", "fontResolution": integer, "alignment": enum, "xPosition": integer, "yPosition": integer, "teletextGridControl": enum, "fontColor": enum, "fontOpacity": integer, "backgroundColor": enum, "backgroundOpacity": integer, "outlineSize": integer, "outlineColor": enum, "shadowColor": enum, "shadowOpacity": integer, "shadowXOffset": integer, "shadowYOffset": integer }, "ttmlDestinationSettings": { "styleControl": enum }, "ebuTtDDestinationSettings": { "styleControl": enum, "fillLineGap": enum, "fontFamily": "string" }, "aribDestinationSettings": { }, "embeddedDestinationSettings": { }, "embeddedPlusScte20DestinationSettings": { }, "scte20PlusEmbeddedDestinationSettings": { }, "rtmpCaptionInfoDestinationSettings": { }, "smpteTtDestinationSettings": { }, "teletextDestinationSettings": { }, "webvttDestinationSettings": { }, "scte27DestinationSettings": { } }, "languageDescription": "string" } ], "globalConfiguration": { "initialAudioGain": integer, "supportLowFramerateInputs": enum, "inputEndAction": enum, "outputTimingSource": enum, "inputLossBehavior": { "repeatFrameMsec": integer, "blackFrameMsec": integer, "inputLossImageType": enum, "inputLossImageColor": "string", "inputLossImageSlate": { "passwordParam": "string", "uri": "string", "username": "string" } }, "outputLockingMode": enum }, "featureActivations": { "inputPrepareScheduleActions": enum }, "outputGroups": [ { "outputGroupSettings": { "msSmoothGroupSettings": { "inputLossAction": enum, "fragmentLength": integer, "eventId": "string", "eventIdMode": enum, "eventStopBehavior": enum, "streamManifestBehavior": enum, "timestampOffsetMode": enum, "timestampOffset": "string", "sparseTrackType": enum, "acquisitionPointId": "string", "connectionRetryInterval": integer, "destination": { "destinationRefId": "string" }, "certificateMode": enum, "numRetries": integer, "filecacheDuration": integer, "restartDelay": integer, "segmentationMode": enum, "sendDelayMs": integer, "audioOnlyTimecodeControl": enum }, "hlsGroupSettings": { "incompleteSegmentBehavior": enum, "discontinuityTags": enum, "keyProviderSettings": { "staticKeySettings": { "staticKeyValue": "string", "keyProviderServer": { "passwordParam": "string", "uri": "string", "username": "string" } } }, "adMarkers": [ enum ], "baseUrlContent": "string", "baseUrlContent1": "string", "baseUrlManifest": "string", "baseUrlManifest1": "string", "captionLanguageSetting": enum, "captionLanguageMappings": [ { "captionChannel": integer, "languageCode": "string", "languageDescription": "string" } ], "hlsCdnSettings": { "hlsBasicPutSettings": { "numRetries": integer, "connectionRetryInterval": integer, "restartDelay": integer, "filecacheDuration": integer }, "hlsMediaStoreSettings": { "numRetries": integer, "connectionRetryInterval": integer, "restartDelay": integer, "filecacheDuration": integer, "mediaStoreStorageClass": enum }, "hlsAkamaiSettings": { "numRetries": integer, "connectionRetryInterval": integer, "restartDelay": integer, "filecacheDuration": integer, "token": "string", "salt": "string", "httpTransferMode": enum }, "hlsWebdavSettings": { "numRetries": integer, "connectionRetryInterval": integer, "restartDelay": integer, "filecacheDuration": integer, "httpTransferMode": enum } }, "inputLossAction": enum, "manifestCompression": enum, "destination": { "destinationRefId": "string" }, "encryptionType": enum, "ivInManifest": enum, "ivSource": enum, "constantIv": "string", "clientCache": enum, "tsFileMode": enum, "manifestDurationFormat": enum, "segmentationMode": enum, "redundantManifest": enum, "outputSelection": enum, "streamInfResolution": enum, "iFrameOnlyPlaylists": enum, "indexNSegments": integer, "programDateTime": enum, "programDateTimePeriod": integer, "keepSegments": integer, "keyFormat": "string", "keyFormatVersions": "string", "minSegmentLength": integer, "segmentLength": integer, "timedMetadataId3Frame": enum, "timedMetadataId3Period": integer, "hlsId3SegmentTagging": enum, "timestampDeltaMilliseconds": integer, "codecSpecification": enum, "directoryStructure": enum, "segmentsPerSubdirectory": integer, "mode": enum }, "rtmpGroupSettings": { "authenticationScheme": enum, "cacheLength": integer, "restartDelay": integer, "cacheFullBehavior": enum, "captionData": enum, "inputLossAction": enum, "adMarkers": [ enum ] }, "udpGroupSettings": { "inputLossAction": enum, "timedMetadataId3Period": integer, "timedMetadataId3Frame": enum }, "archiveGroupSettings": { "destination": { "destinationRefId": "string" }, "rolloverInterval": integer }, "frameCaptureGroupSettings": { "destination": { "destinationRefId": "string" } }, "mediaPackageGroupSettings": { "destination": { "destinationRefId": "string" } }, "multiplexGroupSettings": { } }, "name": "string", "outputs": [ { "outputSettings": { "hlsOutputSettings": { "nameModifier": "string", "segmentModifier": "string", "hlsSettings": { "standardHlsSettings": { "m3u8Settings": { "audioFramesPerPes": integer, "audioPids": "string", "ecmPid": "string", "nielsenId3Behavior": enum, "patInterval": integer, "pcrControl": enum, "pcrPid": "string", "pcrPeriod": integer, "pmtInterval": integer, "pmtPid": "string", "programNum": integer, "scte35Pid": "string", "scte35Behavior": enum, "timedMetadataPid": "string", "timedMetadataBehavior": enum, "transportStreamId": integer, "videoPid": "string" }, "audioRenditionSets": "string" }, "fmp4HlsSettings": { "audioRenditionSets": "string", "timedMetadataBehavior": enum, "nielsenId3Behavior": enum }, "audioOnlyHlsSettings": { "audioOnlyImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "audioTrackType": enum, "audioGroupId": "string", "segmentType": enum } }, "h265PackagingType": enum }, "rtmpOutputSettings": { "destination": { "destinationRefId": "string" }, "connectionRetryInterval": integer, "numRetries": integer, "certificateMode": enum }, "udpOutputSettings": { "destination": { "destinationRefId": "string" }, "bufferMsec": integer, "fecOutputSettings": { "includeFec": enum, "columnDepth": integer, "rowLength": integer }, "containerSettings": { "m2tsSettings": { "bitrate": integer, "ccDescriptor": enum, "ebif": enum, "nielsenId3Behavior": enum, "programNum": integer, "patInterval": integer, "pmtInterval": integer, "pcrControl": enum, "pcrPeriod": integer, "timedMetadataBehavior": enum, "transportStreamId": integer, "bufferModel": enum, "rateMode": enum, "audioBufferModel": enum, "audioStreamType": enum, "nullPacketBitrate": number, "audioFramesPerPes": integer, "segmentationTime": number, "segmentationStyle": enum, "fragmentTime": number, "segmentationMarkers": enum, "ebpLookaheadMs": integer, "ebpPlacement": enum, "ebpAudioInterval": enum, "esRateInPes": enum, "arib": enum, "aribCaptionsPidControl": enum, "absentInputAudioBehavior": enum, "dvbNitSettings": { "repInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "repInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "dvbTdtSettings": { "repInterval": integer }, "pmtPid": "string", "pcrPid": "string", "videoPid": "string", "audioPids": "string", "dvbTeletextPid": "string", "dvbSubPids": "string", "scte27Pids": "string", "scte35Pid": "string", "scte35Control": enum, "klv": enum, "klvDataPids": "string", "timedMetadataPid": "string", "etvPlatformPid": "string", "etvSignalPid": "string", "ecmPid": "string", "aribCaptionsPid": "string" } } }, "msSmoothOutputSettings": { "nameModifier": "string", "h265PackagingType": enum }, "archiveOutputSettings": { "nameModifier": "string", "extension": "string", "containerSettings": { "m2tsSettings": { "bitrate": integer, "ccDescriptor": enum, "ebif": enum, "nielsenId3Behavior": enum, "programNum": integer, "patInterval": integer, "pmtInterval": integer, "pcrControl": enum, "pcrPeriod": integer, "timedMetadataBehavior": enum, "transportStreamId": integer, "bufferModel": enum, "rateMode": enum, "audioBufferModel": enum, "audioStreamType": enum, "nullPacketBitrate": number, "audioFramesPerPes": integer, "segmentationTime": number, "segmentationStyle": enum, "fragmentTime": number, "segmentationMarkers": enum, "ebpLookaheadMs": integer, "ebpPlacement": enum, "ebpAudioInterval": enum, "esRateInPes": enum, "arib": enum, "aribCaptionsPidControl": enum, "absentInputAudioBehavior": enum, "dvbNitSettings": { "repInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "repInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "dvbTdtSettings": { "repInterval": integer }, "pmtPid": "string", "pcrPid": "string", "videoPid": "string", "audioPids": "string", "dvbTeletextPid": "string", "dvbSubPids": "string", "scte27Pids": "string", "scte35Pid": "string", "scte35Control": enum, "klv": enum, "klvDataPids": "string", "timedMetadataPid": "string", "etvPlatformPid": "string", "etvSignalPid": "string", "ecmPid": "string", "aribCaptionsPid": "string" }, "rawSettings": { } } }, "frameCaptureOutputSettings": { "nameModifier": "string" }, "mediaPackageOutputSettings": { }, "multiplexOutputSettings": { "destination": { "destinationRefId": "string" } } }, "outputName": "string", "videoDescriptionName": "string", "audioDescriptionNames": [ "string" ], "captionDescriptionNames": [ "string" ] } ] } ], "timecodeConfig": { "source": enum, "syncThreshold": integer }, "nielsenConfiguration": { "distributorId": "string", "nielsenPcmToId3Tagging": enum }, "videoDescriptions": [ { "codecSettings": { "h264Settings": { "afdSignaling": enum, "fixedAfd": enum, "colorSpaceSettings": { "colorSpacePassthroughSettings": { }, "rec601Settings": { }, "rec709Settings": { } }, "colorMetadata": enum, "adaptiveQuantization": enum, "bitrate": integer, "bufSize": integer, "bufFillPct": integer, "entropyEncoding": enum, "filterSettings": { "temporalFilterSettings": { "strength": enum, "postFilterSharpening": enum } }, "flickerAq": enum, "forceFieldPictures": enum, "framerateControl": enum, "framerateNumerator": integer, "framerateDenominator": integer, "gopBReference": enum, "gopClosedCadence": integer, "gopNumBFrames": integer, "gopSize": number, "gopSizeUnits": enum, "subgopLength": enum, "scanType": enum, "level": enum, "lookAheadRateControl": enum, "maxBitrate": integer, "minIInterval": integer, "numRefFrames": integer, "parControl": enum, "parNumerator": integer, "parDenominator": integer, "profile": enum, "qualityLevel": enum, "rateControlMode": enum, "qvbrQualityLevel": integer, "syntax": enum, "sceneChangeDetect": enum, "slices": integer, "softness": integer, "spatialAq": enum, "temporalAq": enum, "timecodeInsertion": enum }, "h265Settings": { "parNumerator": integer, "parDenominator": integer, "afdSignaling": enum, "fixedAfd": enum, "colorSpaceSettings": { "hdr10Settings": { "maxCll": integer, "maxFall": integer }, "colorSpacePassthroughSettings": { }, "rec601Settings": { }, "rec709Settings": { } }, "rateControlMode": enum, "bitrate": integer, "maxBitrate": integer, "bufSize": integer, "qvbrQualityLevel": integer, "framerateNumerator": integer, "framerateDenominator": integer, "gopSize": number, "gopSizeUnits": enum, "gopClosedCadence": integer, "sceneChangeDetect": enum, "minIInterval": integer, "profile": enum, "tier": enum, "scanType": enum, "level": enum, "slices": integer, "adaptiveQuantization": enum, "filterSettings": { "temporalFilterSettings": { "strength": enum, "postFilterSharpening": enum } }, "flickerAq": enum, "colorMetadata": enum, "alternativeTransferFunction": enum, "lookAheadRateControl": enum, "timecodeInsertion": enum }, "mpeg2Settings": { "afdSignaling": enum, "fixedAfd": enum, "colorSpace": enum, "colorMetadata": enum, "adaptiveQuantization": enum, "filterSettings": { "temporalFilterSettings": { "strength": enum, "postFilterSharpening": enum } }, "framerateNumerator": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "gopNumBFrames": integer, "gopSize": number, "gopSizeUnits": enum, "subgopLength": enum, "scanType": enum, "displayAspectRatio": enum, "timecodeInsertion": enum }, "frameCaptureSettings": { "captureInterval": integer, "captureIntervalUnits": enum } }, "height": integer, "name": "string", "respondToAfd": enum, "sharpness": integer, "scalingBehavior": enum, "width": integer } ] }, "roleArn": "string", "inputSpecification": { "codec": enum, "resolution": enum, "maximumBitrate": enum }, "cdiInputSpecification": { "resolution": enum }, "logLevel": enum, "tags": { }, "channelClass": enum, "pipelineDetails": [ { "pipelineId": "string", "activeInputAttachmentName": "string", "activeInputSwitchActionName": "string" } ] }

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example ResourceNotFound

{ "message": "string" }

Example ResourceConflict

{ "message": "string" }

Example LimitExceeded

{ "message": "string" }

Example InternalServiceError

{ "message": "string" }

Example BadGatewayException

{ "message": "string" }

Example GatewayTimeoutException

{ "message": "string" }

Properties

AacCodingMode

Aac Coding Mode

  • AD_RECEIVER_MIX

  • CODING_MODE_1_0

  • CODING_MODE_1_1

  • CODING_MODE_2_0

  • CODING_MODE_5_1

AacInputType

Aac Input Type

  • BROADCASTER_MIXED_AD

  • NORMAL

AacProfile

Aac Profile

  • HEV1

  • HEV2

  • LC

AacRateControlMode

Aac Rate Control Mode

  • CBR

  • VBR

AacRawFormat

Aac Raw Format

  • LATM_LOAS

  • NONE

AacSettings

Aac Settings

Property Type Required Description
inputType

AacInputType

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.

bitrate

number

False

Average bitrate in bits/second. Valid values depend on rate control mode and profile.

codingMode

AacCodingMode

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.

rawFormat

AacRawFormat

False

Sets LATM / LOAS AAC output for raw containers.

spec

AacSpec

False

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

profile

AacProfile

False

AAC Profile.

rateControlMode

AacRateControlMode

False

Rate Control Mode.

sampleRate

number

False

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

vbrQuality

AacVbrQuality

False

VBR Quality Level - Only used if rateControlMode is VBR.

AacSpec

Aac Spec

  • MPEG2

  • MPEG4

AacVbrQuality

Aac Vbr Quality

  • HIGH

  • LOW

  • MEDIUM_HIGH

  • MEDIUM_LOW

Ac3BitstreamMode

Ac3 Bitstream Mode

  • COMMENTARY

  • COMPLETE_MAIN

  • DIALOGUE

  • EMERGENCY

  • HEARING_IMPAIRED

  • MUSIC_AND_EFFECTS

  • VISUALLY_IMPAIRED

  • VOICE_OVER

Ac3CodingMode

Ac3 Coding Mode

  • CODING_MODE_1_0

  • CODING_MODE_1_1

  • CODING_MODE_2_0

  • CODING_MODE_3_2_LFE

Ac3DrcProfile

Ac3 Drc Profile

  • FILM_STANDARD

  • NONE

Ac3LfeFilter

Ac3 Lfe Filter

  • DISABLED

  • ENABLED

Ac3MetadataControl

Ac3 Metadata Control

  • FOLLOW_INPUT

  • USE_CONFIGURED

Ac3Settings

Ac3 Settings

Property Type Required Description
bitrate

number

False

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

bitstreamMode

Ac3BitstreamMode

False

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

codingMode

Ac3CodingMode

False

Dolby Digital coding mode. Determines number of channels.

dialnorm

integer

Minimum: 1

Maximum: 31

False

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

drcProfile

Ac3DrcProfile

False

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

metadataControl

Ac3MetadataControl

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.

lfeFilter

Ac3LfeFilter

False

When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.

AccessDenied

Property Type Required Description
message

string

False

AfdSignaling

Afd Signaling

  • AUTO

  • FIXED

  • NONE

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.

ArchiveContainerSettings

Archive Container Settings

Property Type Required Description
m2tsSettings

M2tsSettings

False
rawSettings

RawSettings

False

ArchiveGroupSettings

Archive Group Settings

Property Type Required Description
destination

OutputLocationRef

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
nameModifier

string

False

String concatenated to the end of the destination filename. Required for multiple outputs of the same type.

extension

string

False

Output file extension. If excluded, this will be auto-selected from the container type.

containerSettings

ArchiveContainerSettings

True

Settings specific to the container type of the file.

AribDestinationSettings

Arib Destination Settings

AribSourceSettings

Arib Source Settings

AudioChannelMapping

Audio Channel Mapping

Property Type Required Description
outputChannel

integer

Minimum: 0

Maximum: 7

True

The index of the output channel being produced.

inputChannelLevels

Array of type InputChannelLevel

True

Indices and gain values for each input channel that should be remixed into this output channel.

AudioCodecSettings

Audio Codec Settings

Property Type Required Description
aacSettings

AacSettings

False
ac3Settings

Ac3Settings

False
eac3Settings

Eac3Settings

False
mp2Settings

Mp2Settings

False
passThroughSettings

PassThroughSettings

False
wavSettings

WavSettings

False

AudioDescription

Audio Description

Property Type Required Description
audioSelectorName

string

True

The name of the AudioSelector used as the source for this AudioDescription.

audioType

AudioType

False

Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.

codecSettings

AudioCodecSettings

False

Audio codec settings.

audioTypeControl

AudioDescriptionAudioTypeControl

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.

languageCodeControl

AudioDescriptionLanguageCodeControl

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.

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.

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

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

audioNormalizationSettings

AudioNormalizationSettings

False

Advanced audio normalization settings.

AudioDescriptionAudioTypeControl

Audio Description Audio Type Control

  • FOLLOW_INPUT

  • USE_CONFIGURED

AudioDescriptionLanguageCodeControl

Audio Description Language Code Control

  • FOLLOW_INPUT

  • USE_CONFIGURED

AudioLanguageSelection

Audio Language Selection

Property Type Required Description
languageCode

string

True

Selects a specific three-letter language code from within an audio source.

languageSelectionPolicy

AudioLanguageSelectionPolicy

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

  • LOOSE

  • STRICT

AudioNormalizationAlgorithm

Audio Normalization Algorithm

  • ITU_1770_1

  • ITU_1770_2

AudioNormalizationAlgorithmControl

Audio Normalization Algorithm Control

  • CORRECT_AUDIO

AudioNormalizationSettings

Audio Normalization Settings

Property Type Required Description
algorithm

AudioNormalizationAlgorithm

False

Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.

algorithmControl

AudioNormalizationAlgorithmControl

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

Maximum: 0.0

False

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

AudioOnlyHlsSegmentType

Audio Only Hls Segment Type

  • AAC

  • FMP4

AudioOnlyHlsSettings

Audio Only Hls Settings

Property Type Required Description
audioOnlyImage

InputLocation

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

AudioOnlyHlsTrackType

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

audioGroupId

string

False

Specifies the group to which the audio Rendition belongs.

segmentType

AudioOnlyHlsSegmentType

False

Specifies the segment type.

AudioOnlyHlsTrackType

Audio Only Hls Track Type

  • ALTERNATE_AUDIO_AUTO_SELECT

  • ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT

  • ALTERNATE_AUDIO_NOT_AUTO_SELECT

  • AUDIO_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

AudioSelectorSettings

False

The audio selector settings.

AudioSelectorSettings

Audio Selector Settings

Property Type Required Description
audioPidSelection

AudioPidSelection

False
audioLanguageSelection

AudioLanguageSelection

False
audioTrackSelection

AudioTrackSelection

False

AudioSilenceFailoverSettings

Property Type Required Description
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.

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.

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_EFFECTS

  • HEARING_IMPAIRED

  • UNDEFINED

  • VISUAL_IMPAIRED_COMMENTARY

AuthenticationScheme

Authentication Scheme

  • AKAMAI

  • COMMON

AutomaticInputFailoverSettings

The settings for Automatic Input Failover.

Property Type Required Description
secondaryInputId

string

True

The input ID of the secondary input in the automatic input failover pair.

inputPreference

InputPreference

False

Input preference when deciding which input to make active when a previously failed input has recovered.

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.

AvailBlanking

Avail Blanking

Property Type Required Description
state

AvailBlankingState

False

When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.

availBlankingImage

InputLocation

False

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

AvailBlankingState

Avail Blanking State

  • DISABLED

  • ENABLED

AvailConfiguration

Avail Configuration

Property Type Required Description
availSettings

AvailSettings

False

Ad avail settings.

AvailSettings

Avail Settings

Property Type Required Description
scte35TimeSignalApos

Scte35TimeSignalApos

False
scte35SpliceInsert

Scte35SpliceInsert

False

BadGatewayException

Property Type Required Description
message

string

False

BlackoutSlate

Blackout Slate

Property Type Required Description
state

BlackoutSlateState

False

When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

blackoutSlateImage

InputLocation

False

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

networkEndBlackout

BlackoutSlateNetworkEndBlackout

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

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

networkEndBlackoutImage

InputLocation

False

Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

BlackoutSlateNetworkEndBlackout

Blackout Slate Network End Blackout

  • DISABLED

  • ENABLED

BlackoutSlateState

Blackout Slate State

  • DISABLED

  • ENABLED

BurnInAlignment

Burn In Alignment

  • CENTERED

  • LEFT

  • SMART

BurnInBackgroundColor

Burn In Background Color

  • BLACK

  • NONE

  • WHITE

BurnInDestinationSettings

Burn In Destination Settings

Property Type Required Description
font

InputLocation

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.

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.

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.

alignment

BurnInAlignment

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.

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.

teletextGridControl

BurnInTeletextGridControl

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.

fontColor

BurnInFontColor

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.

backgroundColor

BurnInBackgroundColor

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.

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.

outlineColor

BurnInOutlineColor

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.

shadowColor

BurnInShadowColor

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.

BurnInFontColor

Burn In Font Color

  • BLACK

  • BLUE

  • GREEN

  • RED

  • WHITE

  • YELLOW

BurnInOutlineColor

Burn In Outline Color

  • BLACK

  • BLUE

  • GREEN

  • RED

  • WHITE

  • YELLOW

BurnInShadowColor

Burn In Shadow Color

  • BLACK

  • NONE

  • WHITE

BurnInTeletextGridControl

Burn In Teletext Grid Control

  • FIXED

  • SCALED

CaptionDescription

Caption Description

Property Type Required Description
name

string

True

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

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.

languageCode

string

False

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

destinationSettings

CaptionDestinationSettings

False

Additional settings for captions destination that depend on the destination type.

languageDescription

string

False

Human readable information to indicate captions available for players (eg. English, or Spanish).

CaptionDestinationSettings

Caption Destination Settings

Property Type Required Description
dvbSubDestinationSettings

DvbSubDestinationSettings

False
burnInDestinationSettings

BurnInDestinationSettings

False
ttmlDestinationSettings

TtmlDestinationSettings

False
ebuTtDDestinationSettings

EbuTtDDestinationSettings

False
aribDestinationSettings

AribDestinationSettings

False
embeddedDestinationSettings

EmbeddedDestinationSettings

False
embeddedPlusScte20DestinationSettings

EmbeddedPlusScte20DestinationSettings

False
scte20PlusEmbeddedDestinationSettings

Scte20PlusEmbeddedDestinationSettings

False
rtmpCaptionInfoDestinationSettings

RtmpCaptionInfoDestinationSettings

False
smpteTtDestinationSettings

SmpteTtDestinationSettings

False
teletextDestinationSettings

TeletextDestinationSettings

False
webvttDestinationSettings

WebvttDestinationSettings

False
scte27DestinationSettings

Scte27DestinationSettings

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

CaptionSelector

Output groups for this Live Event. Output groups contain information about where streams should be distributed.

Property Type Required Description
selectorSettings

CaptionSelectorSettings

False

Caption selector settings.

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.

languageCode

string

False

When specified this field indicates the three letter language code of the caption track to extract from the source.

CaptionSelectorSettings

Caption Selector Settings

Property Type Required Description
ancillarySourceSettings

AncillarySourceSettings

False
embeddedSourceSettings

EmbeddedSourceSettings

False
teletextSourceSettings

TeletextSourceSettings

False
dvbSubSourceSettings

DvbSubSourceSettings

False
scte27SourceSettings

Scte27SourceSettings

False
scte20SourceSettings

Scte20SourceSettings

False
aribSourceSettings

AribSourceSettings

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

  • SD

  • HD

  • FHD

  • UHD

CdiInputSpecification

Property Type Required Description
resolution

CdiInputResolution

False

Maximum CDI input resolution

Channel

Property Type Required Description
name

string

False

The name of the channel. (user-mutable)

id

string

False

The unique id of the channel.

arn

string

False

The unique arn of the channel.

inputAttachments

Array of type InputAttachment

False

List of input attachments for channel.

state

ChannelState

False
pipelinesRunningCount

integer

False

The number of currently healthy pipelines.

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

EncoderSettings

False
roleArn

string

False

The Amazon Resource Name (ARN) of the role assumed when running the Channel.

inputSpecification

InputSpecification

False

Specification of network and file inputs for this channel

cdiInputSpecification

CdiInputSpecification

False

Specification of CDI inputs for this channel

logLevel

LogLevel

False

The log level being written to CloudWatch Logs.

tags

Tags

False

A collection of key-value pairs.

channelClass

ChannelClass

False

The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

pipelineDetails

Array of type PipelineDetail

False

Runtime details for the pipelines of a running channel.

ChannelClass

A standard channel has two encoding pipelines and a single pipeline channel only has one.

  • STANDARD

  • SINGLE_PIPELINE

ChannelEgressEndpoint

Property Type Required Description
sourceIp

string

False

Public IP of where a channel's output comes from

ChannelState

  • CREATING

  • CREATE_FAILED

  • IDLE

  • STARTING

  • RUNNING

  • RECOVERING

  • STOPPING

  • DELETING

  • DELETED

  • UPDATING

  • UPDATE_FAILED

ColorSpacePassthroughSettings

Passthrough applies no color space conversion to the output

DvbNitSettings

DVB Network Information Table (NIT)

Property Type Required Description
repInterval

integer

Minimum: 25

Maximum: 10000

False

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

networkId

integer

Minimum: 0

Maximum: 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.

DvbSdtOutputSdt

Dvb Sdt Output Sdt

  • SDT_FOLLOW

  • SDT_FOLLOW_IF_PRESENT

  • SDT_MANUAL

  • SDT_NONE

DvbSdtSettings

DVB Service Description Table (SDT)

Property Type Required Description
outputSdt

DvbSdtOutputSdt

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

  • CENTERED

  • LEFT

  • SMART

DvbSubDestinationBackgroundColor

Dvb Sub Destination Background Color

  • BLACK

  • NONE

  • WHITE

DvbSubDestinationFontColor

Dvb Sub Destination Font Color

  • BLACK

  • BLUE

  • GREEN

  • RED

  • WHITE

  • YELLOW

DvbSubDestinationOutlineColor

Dvb Sub Destination Outline Color

  • BLACK

  • BLUE

  • GREEN

  • RED

  • WHITE

  • YELLOW

DvbSubDestinationSettings

Dvb Sub Destination Settings

Property Type Required Description
font

InputLocation

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.

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.

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.

alignment

DvbSubDestinationAlignment

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.

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.

teletextGridControl

DvbSubDestinationTeletextGridControl

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.

fontColor

DvbSubDestinationFontColor

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.

backgroundColor

DvbSubDestinationBackgroundColor

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.

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.

outlineColor

DvbSubDestinationOutlineColor

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.

shadowColor

DvbSubDestinationShadowColor

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.

DvbSubDestinationShadowColor

Dvb Sub Destination Shadow Color

  • BLACK

  • NONE

  • WHITE

DvbSubDestinationTeletextGridControl

Dvb Sub Destination Teletext Grid Control

  • FIXED

  • SCALED

DvbSubSourceSettings

Dvb Sub Source Settings

Property Type Required Description
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_DB

  • NONE

Eac3BitstreamMode

Eac3 Bitstream Mode

  • COMMENTARY

  • COMPLETE_MAIN

  • EMERGENCY

  • HEARING_IMPAIRED

  • VISUALLY_IMPAIRED

Eac3CodingMode

Eac3 Coding Mode

  • CODING_MODE_1_0

  • CODING_MODE_2_0

  • CODING_MODE_3_2

Eac3DcFilter

Eac3 Dc Filter

  • DISABLED

  • ENABLED

Eac3DrcLine

Eac3 Drc Line

  • FILM_LIGHT

  • FILM_STANDARD

  • MUSIC_LIGHT

  • MUSIC_STANDARD

  • NONE

  • SPEECH

Eac3DrcRf

Eac3 Drc Rf

  • FILM_LIGHT

  • FILM_STANDARD

  • MUSIC_LIGHT

  • MUSIC_STANDARD

  • NONE

  • SPEECH

Eac3LfeControl

Eac3 Lfe Control

  • LFE

  • NO_LFE

Eac3LfeFilter

Eac3 Lfe Filter

  • DISABLED

  • ENABLED

Eac3MetadataControl

Eac3 Metadata Control

  • FOLLOW_INPUT

  • USE_CONFIGURED

Eac3PassthroughControl

Eac3 Passthrough Control

  • NO_PASSTHROUGH

  • WHEN_POSSIBLE

Eac3PhaseControl

Eac3 Phase Control

  • NO_SHIFT

  • SHIFT_90_DEGREES

Eac3Settings

Eac3 Settings

Property Type Required Description
attenuationControl

Eac3AttenuationControl

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

Eac3BitstreamMode

False

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

codingMode

Eac3CodingMode

False

Dolby Digital Plus coding mode. Determines number of channels.

dcFilter

Eac3DcFilter

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

Eac3DrcLine

False

Sets the Dolby dynamic range compression profile.

drcRf

Eac3DrcRf

False

Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.

lfeControl

Eac3LfeControl

False

When encoding 3/2 audio, setting to lfe enables the LFE channel

lfeFilter

Eac3LfeFilter

False

When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.

metadataControl

Eac3MetadataControl

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.

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.

passthroughControl

Eac3PassthroughControl

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

Eac3PhaseControl

False

When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.

stereoDownmix

Eac3StereoDownmix

False

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

surroundExMode

Eac3SurroundExMode

False

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

surroundMode

Eac3SurroundMode

False

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

Eac3StereoDownmix

Eac3 Stereo Downmix

  • DPL2

  • LO_RO

  • LT_RT

  • NOT_INDICATED

Eac3SurroundExMode

Eac3 Surround Ex Mode

  • DISABLED

  • ENABLED

  • NOT_INDICATED

Eac3SurroundMode

Eac3 Surround Mode

  • DISABLED

  • ENABLED

  • NOT_INDICATED

EbuTtDDestinationSettings

Ebu Tt DDestination Settings

Property Type Required Description
styleControl

EbuTtDDestinationStyleControl

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.

fillLineGap

EbuTtDFillLineGapControl

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

EbuTtDDestinationStyleControl

Ebu Tt DDestination Style Control

  • EXCLUDE

  • INCLUDE

EbuTtDFillLineGapControl

Ebu Tt DFill Line Gap Control

  • DISABLED

  • ENABLED

EmbeddedConvert608To708

Embedded Convert608 To708

  • DISABLED

  • UPCONVERT

EmbeddedDestinationSettings

Embedded Destination Settings

EmbeddedPlusScte20DestinationSettings

Embedded Plus Scte20 Destination Settings

EmbeddedScte20Detection

Embedded Scte20 Detection

  • AUTO

  • OFF

EmbeddedSourceSettings

Embedded Source Settings

Property Type Required Description
source608ChannelNumber

integer

Minimum: 1

Maximum: 4

False

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

source608TrackNumber

integer

Minimum: 1

Maximum: 5

False

This field is unused and deprecated.

convert608To708

EmbeddedConvert608To708

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

EmbeddedScte20Detection

False

Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.

EncoderSettings

Encoder Settings

Property Type Required Description
audioDescriptions

Array of type AudioDescription

True
availBlanking

AvailBlanking

False

Settings for ad avail blanking.

availConfiguration

AvailConfiguration

False

Event-wide configuration settings for ad avail insertion.

blackoutSlate

BlackoutSlate

False

Settings for blackout slate.

captionDescriptions

Array of type CaptionDescription

False

Settings for caption decriptions

globalConfiguration

GlobalConfiguration

False

Configuration settings that apply to the event as a whole.

featureActivations

FeatureActivations

False

Feature Activations

outputGroups

Array of type OutputGroup

True
timecodeConfig

TimecodeConfig

True

Contains settings used to acquire and adjust timecode information from inputs.

nielsenConfiguration

NielsenConfiguration

False

Nielsen configuration settings.

videoDescriptions

Array of type VideoDescription

True

FailoverCondition

Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings.

Property Type Required Description
failoverConditionSettings

FailoverConditionSettings

False

Failover condition type-specific settings.

FailoverConditionSettings

Settings for one failover condition.

Property Type Required Description
inputLossSettings

InputLossFailoverSettings

False

MediaLive will perform a failover if content is not detected in this input for the specified period.

videoBlackSettings

VideoBlackFailoverSettings

False

MediaLive will perform a failover if content is considered black for the specified period.

audioSilenceSettings

AudioSilenceFailoverSettings

False

MediaLive will perform a failover if the specified audio selector is silent for the specified period.

FeatureActivations

Feature Activations

Property Type Required Description
inputPrepareScheduleActions

FeatureActivationsInputPrepareScheduleActions

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

  • DISABLED

  • ENABLED

FecOutputIncludeFec

Fec Output Include Fec

  • COLUMN

  • COLUMN_AND_ROW

FecOutputSettings

Fec Output Settings

Property Type Required Description
includeFec

FecOutputIncludeFec

False

Enables column only or column and row based FEC

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.

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_0000

  • AFD_0010

  • AFD_0011

  • AFD_0100

  • AFD_1000

  • AFD_1001

  • AFD_1010

  • AFD_1011

  • AFD_1101

  • AFD_1110

  • AFD_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 ','.

timedMetadataBehavior

Fmp4TimedMetadataBehavior

False

When set to passthrough, timed metadata is passed through from input to output.

nielsenId3Behavior

Fmp4NielsenId3Behavior

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.

Fmp4NielsenId3Behavior

Fmp4 Nielsen Id3 Behavior

  • NO_PASSTHROUGH

  • PASSTHROUGH

Fmp4TimedMetadataBehavior

Fmp4 Timed Metadata Behavior

  • NO_PASSTHROUGH

  • PASSTHROUGH

FrameCaptureGroupSettings

Frame Capture Group Settings

Property Type Required Description
destination

OutputLocationRef

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

FrameCaptureIntervalUnit

Frame Capture Interval Unit

  • MILLISECONDS

  • SECONDS

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.

FrameCaptureSettings

Frame Capture Settings

Property Type Required Description
captureInterval

integer

Minimum: 1

Maximum: 3600000

True

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

FrameCaptureIntervalUnit

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.

supportLowFramerateInputs

GlobalConfigurationLowFramerateInputs

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.

inputEndAction

GlobalConfigurationInputEndAction

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

outputTimingSource

GlobalConfigurationOutputTimingSource

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.

inputLossBehavior

InputLossBehavior

False

Settings for system actions when input is lost.

outputLockingMode

GlobalConfigurationOutputLockingMode

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.

GlobalConfigurationInputEndAction

Global Configuration Input End Action

  • NONE

  • SWITCH_AND_LOOP_INPUTS

GlobalConfigurationLowFramerateInputs

Global Configuration Low Framerate Inputs

  • DISABLED

  • ENABLED

GlobalConfigurationOutputLockingMode

Global Configuration Output Locking Mode

  • EPOCH_LOCKING

  • PIPELINE_LOCKING

GlobalConfigurationOutputTimingSource

Global Configuration Output Timing Source

  • INPUT_CLOCK

  • SYSTEM_CLOCK

H264AdaptiveQuantization

H264 Adaptive Quantization

  • HIGH

  • HIGHER

  • LOW

  • MAX

  • MEDIUM

  • OFF

H264ColorMetadata

H264 Color Metadata

  • IGNORE

  • INSERT

H264ColorSpaceSettings

H264 Color Space Settings

Property Type Required Description
colorSpacePassthroughSettings

ColorSpacePassthroughSettings

False
rec601Settings

Rec601Settings

False
rec709Settings

Rec709Settings

False

H264EntropyEncoding

H264 Entropy Encoding

  • CABAC

  • CAVLC

H264FilterSettings

H264 Filter Settings

Property Type Required Description
temporalFilterSettings

TemporalFilterSettings

False

H264FlickerAq

H264 Flicker Aq

  • DISABLED

  • ENABLED

H264ForceFieldPictures

H264 Force Field Pictures

  • DISABLED

  • ENABLED

H264FramerateControl

H264 Framerate Control

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264GopBReference

H264 Gop BReference

  • DISABLED

  • ENABLED

H264GopSizeUnits

H264 Gop Size Units

  • FRAMES

  • SECONDS

H264Level

H264 Level

  • H264_LEVEL_1

  • H264_LEVEL_1_1

  • H264_LEVEL_1_2

  • H264_LEVEL_1_3

  • H264_LEVEL_2

  • H264_LEVEL_2_1

  • H264_LEVEL_2_2

  • H264_LEVEL_3

  • H264_LEVEL_3_1

  • H264_LEVEL_3_2

  • H264_LEVEL_4

  • H264_LEVEL_4_1

  • H264_LEVEL_4_2

  • H264_LEVEL_5

  • H264_LEVEL_5_1

  • H264_LEVEL_5_2

  • H264_LEVEL_AUTO

H264LookAheadRateControl

H264 Look Ahead Rate Control

  • HIGH

  • LOW

  • MEDIUM

H264ParControl

H264 Par Control

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264Profile

H264 Profile

  • BASELINE

  • HIGH

  • HIGH_10BIT

  • HIGH_422

  • HIGH_422_10BIT

  • MAIN

H264QualityLevel

H264 Quality Level

  • ENHANCED_QUALITY

  • STANDARD_QUALITY

H264RateControlMode

H264 Rate Control Mode

  • CBR

  • MULTIPLEX

  • QVBR

  • VBR

H264ScanType

H264 Scan Type

  • INTERLACED

  • PROGRESSIVE

H264SceneChangeDetect

H264 Scene Change Detect

  • DISABLED

  • ENABLED

H264Settings

H264 Settings

Property Type Required Description
afdSignaling

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.

fixedAfd

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

colorSpaceSettings

H264ColorSpaceSettings

False

Color Space settings

colorMetadata

H264ColorMetadata

False

Includes colorspace metadata in the output.

adaptiveQuantization

H264AdaptiveQuantization

False

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

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.

bufSize

integer

Minimum: 0

False

Size of buffer (HRD buffer model) in bits.

bufFillPct

integer

Minimum: 0

Maximum: 100

False

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

entropyEncoding

H264EntropyEncoding

False

Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.

filterSettings

H264FilterSettings

False

Optional filters that you can apply to an encode.

flickerAq

H264FlickerAq

False

If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.

forceFieldPictures

H264ForceFieldPictures

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

H264FramerateControl

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.

framerateNumerator

integer

Minimum: 1

False

Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.

framerateDenominator

integer

Minimum: 1

False

Framerate denominator.

gopBReference

H264GopBReference

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

H264GopSizeUnits

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.

subgopLength

H264SubGopLength

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.

scanType

H264ScanType

False

Sets the scan type of the output to progressive or top-field-first interlaced.

level

H264Level

False

H.264 Level.

lookAheadRateControl

H264LookAheadRateControl

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

H264ParControl

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.

parNumerator

integer

Minimum: 1

False

Pixel Aspect Ratio numerator.

parDenominator

integer

Minimum: 1

False

Pixel Aspect Ratio denominator.

profile

H264Profile

False

H.264 Profile.

qualityLevel

H264QualityLevel

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.

rateControlMode

H264RateControlMode

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.

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

syntax

H264Syntax

False

Produces a bitstream compliant with SMPTE RP-2027.

sceneChangeDetect

H264SceneChangeDetect

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.

spatialAq

H264SpatialAq

False

If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.

temporalAq

H264TemporalAq

False

If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.

timecodeInsertion

H264TimecodeInsertionBehavior

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

  • DISABLED

  • ENABLED

H264SubGopLength

H264 Sub Gop Length

  • DYNAMIC

  • FIXED

H264Syntax

H264 Syntax

  • DEFAULT

  • RP2027

H264TemporalAq

H264 Temporal Aq

  • DISABLED

  • ENABLED

H264TimecodeInsertionBehavior

H264 Timecode Insertion Behavior

  • DISABLED

  • PIC_TIMING_SEI

H265AdaptiveQuantization

H265 Adaptive Quantization

  • HIGH

  • HIGHER

  • LOW

  • MAX

  • MEDIUM

  • OFF

H265AlternativeTransferFunction

H265 Alternative Transfer Function

  • INSERT

  • OMIT

H265ColorMetadata

H265 Color Metadata

  • IGNORE

  • INSERT

H265ColorSpaceSettings

H265 Color Space Settings

Property Type Required Description
hdr10Settings

Hdr10Settings

False
colorSpacePassthroughSettings

ColorSpacePassthroughSettings

False
rec601Settings

Rec601Settings

False
rec709Settings

Rec709Settings

False

H265FilterSettings

H265 Filter Settings

Property Type Required Description
temporalFilterSettings

TemporalFilterSettings

False

H265FlickerAq

H265 Flicker Aq

  • DISABLED

  • ENABLED

H265GopSizeUnits

H265 Gop Size Units

  • FRAMES

  • SECONDS

H265Level

H265 Level

  • H265_LEVEL_1

  • H265_LEVEL_2

  • H265_LEVEL_2_1

  • H265_LEVEL_3

  • H265_LEVEL_3_1

  • H265_LEVEL_4

  • H265_LEVEL_4_1

  • H265_LEVEL_5

  • H265_LEVEL_5_1

  • H265_LEVEL_5_2

  • H265_LEVEL_6

  • H265_LEVEL_6_1

  • H265_LEVEL_6_2

  • H265_LEVEL_AUTO

H265LookAheadRateControl

H265 Look Ahead Rate Control

  • HIGH

  • LOW

  • MEDIUM

H265Profile

H265 Profile

  • MAIN

  • MAIN_10BIT

H265RateControlMode

H265 Rate Control Mode

  • CBR

  • MULTIPLEX

  • QVBR

H265ScanType

H265 Scan Type

  • INTERLACED

  • PROGRESSIVE

H265SceneChangeDetect

H265 Scene Change Detect

  • DISABLED

  • ENABLED

H265Settings

H265 Settings

Property Type Required Description
parNumerator

integer

Minimum: 1

False

Pixel Aspect Ratio numerator.

parDenominator

integer

Minimum: 1

False

Pixel Aspect Ratio denominator.

afdSignaling

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.

fixedAfd

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

colorSpaceSettings

H265ColorSpaceSettings

False

Color Space settings

rateControlMode

H265RateControlMode

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.

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.

maxBitrate

integer

Minimum: 100000

Maximum: 40000000

False

For QVBR: See the tooltip for Quality level

bufSize

integer

Minimum: 100000

Maximum: 80000000

False

Size of buffer (HRD buffer model) in bits.

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

framerateNumerator

integer

Minimum: 1

True

Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.

framerateDenominator

integer

Minimum: 1

Maximum: 3003

True

Framerate denominator.

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

H265GopSizeUnits

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.

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.

sceneChangeDetect

H265SceneChangeDetect

False

Scene change detection.

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

profile

H265Profile

False

H.265 Profile.

tier

H265Tier

False

H.265 Tier.

scanType

H265ScanType

False

Sets the scan type of the output to progressive or top-field-first interlaced.

level

H265Level

False

H.265 Level.

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.

adaptiveQuantization

H265AdaptiveQuantization

False

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

filterSettings

H265FilterSettings

False

Optional filters that you can apply to an encode.

flickerAq

H265FlickerAq

False

If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.

colorMetadata

H265ColorMetadata

False

Includes colorspace metadata in the output.

alternativeTransferFunction

H265AlternativeTransferFunction

False

Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.

lookAheadRateControl

H265LookAheadRateControl

False

Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.

timecodeInsertion

H265TimecodeInsertionBehavior

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

  • HIGH

  • MAIN

H265TimecodeInsertionBehavior

H265 Timecode Insertion Behavior

  • DISABLED

  • PIC_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

  • ADOBE

  • ELEMENTAL

  • ELEMENTAL_SCTE35

HlsAkamaiHttpTransferMode

Hls Akamai Http Transfer Mode

  • CHUNKED

  • NON_CHUNKED

HlsAkamaiSettings

Hls Akamai Settings

Property Type Required Description
numRetries

integer

Minimum: 0

False

Number of retry attempts that will be made before the Live Event is put into an error state.

connectionRetryInterval

integer

Minimum: 0

False

Number of seconds to wait before retrying connection to the CDN if the connection is lost.

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.

filecacheDuration

integer

Minimum: 0

Maximum: 600

False

Size in seconds of file cache for streaming outputs.

token

string

False

Token parameter for authenticated akamai. If not specified, _gda_ is used.

salt

string

False

Salt for authenticated Akamai.

httpTransferMode

HlsAkamaiHttpTransferMode

False

Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.

HlsBasicPutSettings

Hls Basic Put Settings

Property Type Required Description
numRetries

integer

Minimum: 0

False

Number of retry attempts that will be made before the Live Event is put into an error state.

connectionRetryInterval

integer

Minimum: 0

False

Number of seconds to wait before retrying connection to the CDN if the connection is lost.

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.

filecacheDuration

integer

Minimum: 0

Maximum: 600

False

Size in seconds of file cache for streaming outputs.

HlsCaptionLanguageSetting

Hls Caption Language Setting

  • INSERT

  • NONE

  • OMIT

HlsCdnSettings

Hls Cdn Settings

Property Type Required Description
hlsBasicPutSettings

HlsBasicPutSettings

False
hlsMediaStoreSettings

HlsMediaStoreSettings

False
hlsAkamaiSettings

HlsAkamaiSettings

False
hlsWebdavSettings

HlsWebdavSettings

False

HlsClientCache

Hls Client Cache

  • DISABLED

  • ENABLED

HlsCodecSpecification

Hls Codec Specification

  • RFC_4281

  • RFC_6381

HlsDirectoryStructure

Hls Directory Structure

  • SINGLE_DIRECTORY

  • SUBDIRECTORY_PER_STREAM

HlsDiscontinuityTags

Hls Discontinuity Tags

  • INSERT

  • NEVER_INSERT

HlsEncryptionType

Hls Encryption Type

  • AES128

  • SAMPLE_AES

HlsGroupSettings

Hls Group Settings

Property Type Required Description
incompleteSegmentBehavior

HlsIncompleteSegmentBehavior

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.

discontinuityTags

HlsDiscontinuityTags

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.

keyProviderSettings

KeyProviderSettings

False

The key provider settings.

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.

captionLanguageSetting

HlsCaptionLanguageSetting

False

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

captionLanguageMappings

Array of type CaptionLanguageMapping

False

Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".

hlsCdnSettings

HlsCdnSettings

False

Parameters that control interactions with the CDN.

inputLossAction

InputLossActionForHlsOut

False

Parameter that control output group behavior on input loss.

manifestCompression

HlsManifestCompression

False

When set to gzip, compresses HLS playlist.

destination

OutputLocationRef

True

A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).

encryptionType

HlsEncryptionType

False

Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.

ivInManifest

HlsIvInManifest

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

HlsIvSource

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.

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.

clientCache

HlsClientCache

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.

tsFileMode

HlsTsFileMode

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.

manifestDurationFormat

HlsManifestDurationFormat

False

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

segmentationMode

HlsSegmentationMode

False

useInputSegmentation has been deprecated. The configured segment size is always used.

redundantManifest

HlsRedundantManifest

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.

outputSelection

HlsOutputSelection

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.

streamInfResolution

HlsStreamInfResolution

False

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

iFrameOnlyPlaylists

IFrameOnlyPlaylistType

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"

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.

programDateTime

HlsProgramDateTime

False

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

programDateTimePeriod

integer

Minimum: 0

Maximum: 3600

False

Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

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

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.

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.

timedMetadataId3Frame

HlsTimedMetadataId3Frame

False

Indicates ID3 frame that has the timecode.

timedMetadataId3Period

integer

Minimum: 0

False

Timed Metadata interval in seconds.

hlsId3SegmentTagging

HlsId3SegmentTaggingState

False

State of HLS ID3 Segment Tagging

timestampDeltaMilliseconds

integer

Minimum: 0

False

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

codecSpecification

HlsCodecSpecification

False

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

directoryStructure

HlsDirectoryStructure

False

Place segments in subdirectories.

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.

mode

HlsMode

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.

HlsH265PackagingType

Hls H265 Packaging Type

  • HEV1

  • HVC1

HlsId3SegmentTaggingState

State of HLS ID3 Segment Tagging

  • DISABLED

  • ENABLED

HlsIncompleteSegmentBehavior

Hls Incomplete Segment Behavior

  • AUTO

  • SUPPRESS

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.

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.

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.

HlsIvInManifest

Hls Iv In Manifest

  • EXCLUDE

  • INCLUDE

HlsIvSource

Hls Iv Source

  • EXPLICIT

  • FOLLOWS_SEGMENT_NUMBER

HlsManifestCompression

Hls Manifest Compression

  • GZIP

  • NONE

HlsManifestDurationFormat

Hls Manifest Duration Format

  • FLOATING_POINT

  • INTEGER

HlsMediaStoreSettings

Hls Media Store Settings

Property Type Required Description
numRetries

integer

Minimum: 0

False

Number of retry attempts that will be made before the Live Event is put into an error state.

connectionRetryInterval

integer

Minimum: 0

False

Number of seconds to wait before retrying connection to the CDN if the connection is lost.

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.

filecacheDuration

integer

Minimum: 0

Maximum: 600

False

Size in seconds of file cache for streaming outputs.

mediaStoreStorageClass

HlsMediaStoreStorageClass

False

When set to temporal, output files are stored in non-persistent memory for faster reading and writing.

HlsMediaStoreStorageClass

Hls Media Store Storage Class

  • TEMPORAL

HlsMode

Hls Mode

  • LIVE

  • VOD

HlsOutputSelection

Hls Output Selection

  • MANIFESTS_AND_SEGMENTS

  • SEGMENTS_ONLY

  • VARIANT_MANIFESTS_AND_SEGMENTS

HlsOutputSettings

Hls Output Settings

Property Type Required Description
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.

hlsSettings

HlsSettings

True

Settings regarding the underlying stream. These settings are different for audio-only outputs.

h265PackagingType

HlsH265PackagingType

False

Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.

HlsProgramDateTime

Hls Program Date Time

  • EXCLUDE

  • INCLUDE

HlsRedundantManifest

Hls Redundant Manifest

  • DISABLED

  • ENABLED

HlsSegmentationMode

Hls Segmentation Mode

  • USE_INPUT_SEGMENTATION

  • USE_SEGMENT_DURATION

HlsSettings

Hls Settings

Property Type Required Description
standardHlsSettings

StandardHlsSettings

False
fmp4HlsSettings

Fmp4HlsSettings

False
audioOnlyHlsSettings

AudioOnlyHlsSettings

False

HlsStreamInfResolution

Hls Stream Inf Resolution

  • EXCLUDE

  • INCLUDE

HlsTimedMetadataId3Frame

Hls Timed Metadata Id3 Frame

  • NONE

  • PRIV

  • TDRL

HlsTsFileMode

Hls Ts File Mode

  • SEGMENTED_FILES

  • SINGLE_FILE

HlsWebdavHttpTransferMode

Hls Webdav Http Transfer Mode

  • CHUNKED

  • NON_CHUNKED

HlsWebdavSettings

Hls Webdav Settings

Property Type Required Description
numRetries

integer

Minimum: 0

False

Number of retry attempts that will be made before the Live Event is put into an error state.

connectionRetryInterval

integer

Minimum: 0

False

Number of seconds to wait before retrying connection to the CDN if the connection is lost.

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.

filecacheDuration

integer

Minimum: 0

Maximum: 600

False

Size in seconds of file cache for streaming outputs.

httpTransferMode

HlsWebdavHttpTransferMode

False

Specify whether or not to use chunked transfer encoding to WebDAV.

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.

  • DISABLED

  • STANDARD

InputAttachment

Property Type Required Description
inputId

string

False

The ID of the 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.

inputSettings

InputSettings

False

Settings of an input (caption selector, etc.)

automaticInputFailoverSettings

AutomaticInputFailoverSettings

False

User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input.

InputChannelLevel

Input Channel Level

Property Type Required Description
inputChannel

integer

Minimum: 0

Maximum: 15

True

The index of the input channel used as a source.

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.

InputCodec

codec in increasing order of complexity

  • MPEG2

  • AVC

  • HEVC

InputDeblockFilter

Input Deblock Filter

  • DISABLED

  • ENABLED

InputDenoiseFilter

Input Denoise Filter

  • DISABLED

  • ENABLED

InputFilter

Input Filter

  • AUTO

  • DISABLED

  • FORCED

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_OUTPUT

  • PAUSE_OUTPUT

InputLossActionForMsSmoothOut

Input Loss Action For Ms Smooth Out

  • EMIT_OUTPUT

  • PAUSE_OUTPUT

InputLossActionForRtmpOut

Input Loss Action For Rtmp Out

  • EMIT_OUTPUT

  • PAUSE_OUTPUT

InputLossActionForUdpOut

Input Loss Action For Udp Out

  • DROP_PROGRAM

  • DROP_TS

  • EMIT_PROGRAM

InputLossBehavior

Input Loss Behavior

Property Type Required Description
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.

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.

inputLossImageType

InputLossImageType

False

Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.

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

InputLocation

False

When input loss image type is "slate" these fields specify the parameters for accessing the slate.

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

  • COLOR

  • SLATE

InputMaximumBitrate

Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.

  • MAX_10_MBPS

  • MAX_20_MBPS

  • MAX_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_PREFERENCE

  • PRIMARY_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

  • SD

  • HD

  • UHD

InputSettings

Live Event input parameters. There can be multiple inputs in a single Live Event.

Property Type Required Description
networkInputSettings

NetworkInputSettings

False

Input settings.

sourceEndBehavior

InputSourceEndBehavior

False

Loop input if it is a file. This allows a file input to be streamed indefinitely.

inputFilter

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

filterStrength

integer

Minimum: 1

Maximum: 5

False

Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).

deblockFilter

InputDeblockFilter

False

Enable or disable the deblock filter when filtering.

denoiseFilter

InputDenoiseFilter

False

Enable or disable the denoise filter when filtering.

smpte2038DataPreference

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.

videoSelector

VideoSelector

False

Informs which video elementary stream to decode for input types that have multiple available.

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.

InputSourceEndBehavior

Input Source End Behavior

  • CONTINUE

  • LOOP

InputSpecification

Property Type Required Description
codec

InputCodec

False

Input codec

resolution

InputResolution

False

Input resolution, categorized coarsely

maximumBitrate

InputMaximumBitrate

False

Maximum input bitrate, 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

StaticKeySettings

False

LimitExceeded

Property Type Required Description
message

string

False

LogLevel

The log level the user wants for their channel.

  • ERROR

  • WARNING

  • INFO

  • DEBUG

  • DISABLED

M2tsAbsentInputAudioBehavior

M2ts Absent Input Audio Behavior

  • DROP

  • ENCODE_SILENCE

M2tsArib

M2ts Arib

  • DISABLED

  • ENABLED

M2tsAribCaptionsPidControl

M2ts Arib Captions Pid Control

  • AUTO

  • USE_CONFIGURED

M2tsAudioBufferModel

M2ts Audio Buffer Model

  • ATSC

  • DVB

M2tsAudioInterval

M2ts Audio Interval

  • VIDEO_AND_FIXED_INTERVALS

  • VIDEO_INTERVAL

M2tsAudioStreamType

M2ts Audio Stream Type

  • ATSC

  • DVB

M2tsBufferModel

M2ts Buffer Model

  • MULTIPLEX

  • NONE

M2tsCcDescriptor

M2ts Cc Descriptor

  • DISABLED

  • ENABLED

M2tsEbifControl

M2ts Ebif Control

  • NONE

  • PASSTHROUGH

M2tsEbpPlacement

M2ts Ebp Placement

  • VIDEO_AND_AUDIO_PIDS

  • VIDEO_PID

M2tsEsRateInPes

M2ts Es Rate In Pes

  • EXCLUDE

  • INCLUDE

M2tsKlv

M2ts Klv

  • NONE

  • PASSTHROUGH

M2tsNielsenId3Behavior

M2ts Nielsen Id3 Behavior

  • NO_PASSTHROUGH

  • PASSTHROUGH

M2tsPcrControl

M2ts Pcr Control

  • CONFIGURED_PCR_PERIOD

  • PCR_EVERY_PES_PACKET

M2tsRateMode

M2ts Rate Mode

  • CBR

  • VBR

M2tsScte35Control

M2ts Scte35 Control

  • NONE

  • PASSTHROUGH

M2tsSegmentationMarkers

M2ts Segmentation Markers

  • EBP

  • EBP_LEGACY

  • NONE

  • PSI_SEGSTART

  • RAI_ADAPT

  • RAI_SEGSTART

M2tsSegmentationStyle

M2ts Segmentation Style

  • MAINTAIN_CADENCE

  • RESET_CADENCE

M2tsSettings

M2ts Settings

Property Type Required Description
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.

ccDescriptor

M2tsCcDescriptor

False

When set to enabled, generates captionServiceDescriptor in PMT.

ebif

M2tsEbifControl

False

If set to passthrough, passes any EBIF data from the input source to this output.

nielsenId3Behavior

M2tsNielsenId3Behavior

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.

programNum

integer

Minimum: 0

Maximum: 65535

False

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

patInterval

integer

Minimum: 0

Maximum: 1000

False

The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.

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.

pcrControl

M2tsPcrControl

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.

timedMetadataBehavior

M2tsTimedMetadataBehavior

False

When set to passthrough, timed metadata will be passed through from input to output.

transportStreamId

integer

Minimum: 0

Maximum: 65535

False

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

bufferModel

M2tsBufferModel

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.

rateMode

M2tsRateMode

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.

audioBufferModel

M2tsAudioBufferModel

False

When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.

audioStreamType

M2tsAudioStreamType

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.

nullPacketBitrate

number

Minimum: 0.0

False

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

audioFramesPerPes

integer

Minimum: 0

False

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

segmentationTime

number

Minimum: 1.0

False

The length in seconds of each segment. Required unless markers is set to _none_.

segmentationStyle

M2tsSegmentationStyle

False

The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "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.

fragmentTime

number

Minimum: 0.0

False

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

segmentationMarkers

M2tsSegmentationMarkers

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.

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

M2tsEbpPlacement

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.

ebpAudioInterval

M2tsAudioInterval

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.

esRateInPes

M2tsEsRateInPes

False

Include or exclude the ES Rate field in the PES header.

arib

M2tsArib

False

When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.

aribCaptionsPidControl

M2tsAribCaptionsPidControl

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.

absentInputAudioBehavior

M2tsAbsentInputAudioBehavior

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.

dvbNitSettings

DvbNitSettings

False

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

dvbSdtSettings

DvbSdtSettings

False

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

dvbTdtSettings

DvbTdtSettings

False

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

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

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

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

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

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

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

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

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

scte35Control

M2tsScte35Control

False

Optionally pass SCTE-35 signals from the input source to this output.

klv

M2tsKlv

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

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

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

ecmPid

string

False

This field is unused and deprecated.

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

M2tsTimedMetadataBehavior

M2ts Timed Metadata Behavior

  • NO_PASSTHROUGH

  • PASSTHROUGH

M3u8NielsenId3Behavior

M3u8 Nielsen Id3 Behavior

  • NO_PASSTHROUGH

  • PASSTHROUGH

M3u8PcrControl

M3u8 Pcr Control

  • CONFIGURED_PCR_PERIOD

  • PCR_EVERY_PES_PACKET

M3u8Scte35Behavior

M3u8 Scte35 Behavior

  • NO_PASSTHROUGH

  • PASSTHROUGH

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

M3u8NielsenId3Behavior

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

M3u8PcrControl

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.

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.

pcrPeriod

integer

Minimum: 0

Maximum: 500

False

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

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.

scte35Pid

string

False

Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.

scte35Behavior

M3u8Scte35Behavior

False

If set to passthrough, passes any SCTE-35 signals from the input source to this 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).

timedMetadataBehavior

M3u8TimedMetadataBehavior

False

When set to passthrough, timed metadata is passed through from input to output.

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_PASSTHROUGH

  • PASSTHROUGH

MediaPackageGroupSettings

Media Package Group Settings

Property Type Required Description
destination

OutputLocationRef

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

Mp2CodingMode

Mp2 Coding Mode

  • CODING_MODE_1_0

  • CODING_MODE_2_0

Mp2Settings

Mp2 Settings

Property Type Required Description
codingMode

Mp2CodingMode

False

The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).

bitrate

number

False

Average bitrate in bits/second.

sampleRate

number

False

Sample rate in Hz.

Mpeg2AdaptiveQuantization

Mpeg2 Adaptive Quantization

  • AUTO

  • HIGH

  • LOW

  • MEDIUM

  • OFF

Mpeg2ColorMetadata

Mpeg2 Color Metadata

  • IGNORE

  • INSERT

Mpeg2ColorSpace

Mpeg2 Color Space

  • AUTO

  • PASSTHROUGH

Mpeg2DisplayRatio

Mpeg2 Display Ratio

  • DISPLAYRATIO16X9

  • DISPLAYRATIO4X3

Mpeg2FilterSettings

Mpeg2 Filter Settings

Property Type Required Description
temporalFilterSettings

TemporalFilterSettings

False

Mpeg2GopSizeUnits

Mpeg2 Gop Size Units

  • FRAMES

  • SECONDS

Mpeg2ScanType

Mpeg2 Scan Type

  • INTERLACED

  • PROGRESSIVE

Mpeg2Settings

Mpeg2 Settings

Property Type Required Description
afdSignaling

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.

fixedAfd

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.

colorSpace

Mpeg2ColorSpace

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.

colorMetadata

Mpeg2ColorMetadata

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.

adaptiveQuantization

Mpeg2AdaptiveQuantization

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.

filterSettings

Mpeg2FilterSettings

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.

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.

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.

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

Mpeg2GopSizeUnits

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.

subgopLength

Mpeg2SubGopLength

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.

scanType

Mpeg2ScanType

False

Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).

displayAspectRatio

Mpeg2DisplayRatio

False

Sets the pixel aspect ratio for the encode.

timecodeInsertion

Mpeg2TimecodeInsertionBehavior

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

  • DYNAMIC

  • FIXED

Mpeg2TimecodeInsertionBehavior

Mpeg2 Timecode Insertion Behavior

  • DISABLED

  • GOP_TIMECODE

MsSmoothGroupSettings

Ms Smooth Group Settings

Property Type Required Description
inputLossAction

InputLossActionForMsSmoothOut

False

Parameter that control output group behavior on input loss.

fragmentLength

integer

Minimum: 1

False

Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.

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

SmoothGroupEventIdMode

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

SmoothGroupEventStopBehavior

False

When set to sendEos, send EOS signal to IIS server when stopping the event

streamManifestBehavior

SmoothGroupStreamManifestBehavior

False

When set to send, send stream manifest so publishing point doesn't start until all streams start.

timestampOffsetMode

SmoothGroupTimestampOffsetMode

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

timestampOffset

string

False

Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.

sparseTrackType

SmoothGroupSparseTrackType

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.

acquisitionPointId

string

False

The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.

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

OutputLocationRef

True

Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.

certificateMode

SmoothGroupCertificateMode

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.

numRetries

integer

Minimum: 0

False

Number of retry attempts.

filecacheDuration

integer

Minimum: 0

False

Size in seconds of file cache for streaming outputs.

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

SmoothGroupSegmentationMode

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.

audioOnlyTimecodeControl

SmoothGroupAudioOnlyTimecodeControl

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.

MsSmoothH265PackagingType

Ms Smooth H265 Packaging Type

  • HEV1

  • HVC1

MsSmoothOutputSettings

Ms Smooth Output Settings

Property Type Required Description
nameModifier

string

False

String concatenated to the end of the destination filename. Required for multiple outputs of the same type.

h265PackagingType

MsSmoothH265PackagingType

False

Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.

MultiplexGroupSettings

Multiplex Group Settings

MultiplexOutputSettings

Multiplex Output Settings

Property Type Required Description
destination

OutputLocationRef

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_NAME

  • CHECK_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

HlsInputSettings

False

Specifies HLS input settings when the uri is for a HLS manifest.

serverValidation

NetworkInputServerValidation

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.

NielsenConfiguration

Nielsen Configuration

Property Type Required Description
distributorId

string

False

Enter the Distributor ID assigned to your organization by Nielsen.

nielsenPcmToId3Tagging

NielsenPcmToId3TaggingState

False

Enables Nielsen PCM to ID3 tagging

NielsenPcmToId3TaggingState

State of Nielsen PCM to ID3 tagging

  • DISABLED

  • ENABLED

Output

Output settings. There can be multiple outputs within a group.

Property Type Required Description
outputSettings

OutputSettings

True

Output type-specific settings.

outputName

string

MinLength: 1

MaxLength: 255

False

The name used to identify an output.

videoDescriptionName

string

False

The name of the VideoDescription used as the source for this output.

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.

OutputDestination

Property Type Required Description
id

string

False

User-specified id. This is used in an output group or an output.

settings

Array of type OutputDestinationSettings

False

Destination settings for a standard output; one destination for each redundant encoder.

mediaPackageSettings

Array of type MediaPackageOutputDestinationSettings

False

Destination settings for a MediaPackage output; one destination for both encoders.

multiplexSettings

MultiplexProgramChannelDestinationSettings

False

Destination settings for a Multiplex output; one destination for both encoders.

OutputDestinationSettings

Property Type Required Description
url

string

False

A URL specifying a destination

username

string

False

username for destination

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://)

OutputGroup

Output groups for this Live Event. Output groups contain information about where streams should be distributed.

Property Type Required Description
outputGroupSettings

OutputGroupSettings

True

Settings associated with the output group.

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.

outputs

Array of type Output

True

OutputGroupSettings

Output Group Settings

Property Type Required Description
msSmoothGroupSettings

MsSmoothGroupSettings

False
hlsGroupSettings

HlsGroupSettings

False
rtmpGroupSettings

RtmpGroupSettings

False
udpGroupSettings

UdpGroupSettings

False
archiveGroupSettings

ArchiveGroupSettings

False
frameCaptureGroupSettings

FrameCaptureGroupSettings

False
mediaPackageGroupSettings

MediaPackageGroupSettings

False
multiplexGroupSettings

MultiplexGroupSettings

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
hlsOutputSettings

HlsOutputSettings

False
rtmpOutputSettings

RtmpOutputSettings

False
udpOutputSettings

UdpOutputSettings

False
msSmoothOutputSettings

MsSmoothOutputSettings

False
archiveOutputSettings

ArchiveOutputSettings

False
frameCaptureOutputSettings

FrameCaptureOutputSettings

False
mediaPackageOutputSettings

MediaPackageOutputSettings

False
multiplexOutputSettings

MultiplexOutputSettings

False

PassThroughSettings

Pass Through Settings

PipelineDetail

Runtime details of a pipeline when a channel is running.

Property Type Required Description
pipelineId

string

False

Pipeline ID

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.

RawSettings

Raw Settings

Rec601Settings

Rec601 Settings

Rec709Settings

Rec709 Settings

RemixSettings

Remix Settings

Property Type Required Description
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

channelMappings

Array of type AudioChannelMapping

True

Mapping of input channels to output channels, with appropriate gain adjustments.

ResourceConflict

Property Type Required Description
message

string

False

ResourceNotFound

Property Type Required Description
message

string

False

RtmpAdMarkers

Rtmp Ad Markers

  • ON_CUE_POINT_SCTE35

RtmpCacheFullBehavior

Rtmp Cache Full Behavior

  • DISCONNECT_IMMEDIATELY

  • WAIT_FOR_SERVER

RtmpCaptionData

Rtmp Caption Data

  • ALL

  • FIELD1_608

  • FIELD1_AND_FIELD2_608

RtmpCaptionInfoDestinationSettings

Rtmp Caption Info Destination Settings

RtmpGroupSettings

Rtmp Group Settings

Property Type Required Description
authenticationScheme

AuthenticationScheme

False

Authentication scheme to use when connecting with CDN

cacheLength

integer

Minimum: 30

False

Cache length, in seconds, is used to calculate buffer size.

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.

cacheFullBehavior

RtmpCacheFullBehavior

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.

captionData

RtmpCaptionData

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

InputLossActionForRtmpOut

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.

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.

RtmpOutputCertificateMode

Rtmp Output Certificate Mode

  • SELF_SIGNED

  • VERIFY_AUTHENTICITY

RtmpOutputSettings

Rtmp Output Settings

Property Type Required Description
destination

OutputLocationRef

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.

connectionRetryInterval

integer

Minimum: 1

False

Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.

numRetries

integer

Minimum: 0

False

Number of retry attempts.

certificateMode

RtmpOutputCertificateMode

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.

Scte20Convert608To708

Scte20 Convert608 To708

  • DISABLED

  • UPCONVERT

Scte20PlusEmbeddedDestinationSettings

Scte20 Plus Embedded Destination Settings

Scte20SourceSettings

Scte20 Source Settings

Property Type Required Description
source608ChannelNumber

integer

Minimum: 1

Maximum: 4

False

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

convert608To708

Scte20Convert608To708

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.

Scte27DestinationSettings

Scte27 Destination Settings

Scte27SourceSettings

Scte27 Source Settings

Property Type Required Description
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

  • FOLLOW

  • IGNORE

Scte35AposWebDeliveryAllowedBehavior

Scte35 Apos Web Delivery Allowed Behavior

  • FOLLOW

  • IGNORE

Scte35SpliceInsert

Scte35 Splice Insert

Property Type Required Description
webDeliveryAllowedFlag

Scte35SpliceInsertWebDeliveryAllowedBehavior

False

When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates

noRegionalBlackoutFlag

Scte35SpliceInsertNoRegionalBlackoutBehavior

False

When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates

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.

Scte35SpliceInsertNoRegionalBlackoutBehavior

Scte35 Splice Insert No Regional Blackout Behavior

  • FOLLOW

  • IGNORE

Scte35SpliceInsertWebDeliveryAllowedBehavior

Scte35 Splice Insert Web Delivery Allowed Behavior

  • FOLLOW

  • IGNORE

Scte35TimeSignalApos

Scte35 Time Signal Apos

Property Type Required Description
webDeliveryAllowedFlag

Scte35AposWebDeliveryAllowedBehavior

False

When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates

noRegionalBlackoutFlag

Scte35AposNoRegionalBlackoutBehavior

False

When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates

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.

SmoothGroupAudioOnlyTimecodeControl

Smooth Group Audio Only Timecode Control

  • PASSTHROUGH

  • USE_CONFIGURED_CLOCK

SmoothGroupCertificateMode

Smooth Group Certificate Mode

  • SELF_SIGNED

  • VERIFY_AUTHENTICITY

SmoothGroupEventIdMode

Smooth Group Event Id Mode

  • NO_EVENT_ID

  • USE_CONFIGURED

  • USE_TIMESTAMP

SmoothGroupEventStopBehavior

Smooth Group Event Stop Behavior

  • NONE

  • SEND_EOS

SmoothGroupSegmentationMode

Smooth Group Segmentation Mode

  • USE_INPUT_SEGMENTATION

  • USE_SEGMENT_DURATION

SmoothGroupSparseTrackType

Smooth Group Sparse Track Type

  • NONE

  • SCTE_35

  • SCTE_35_WITHOUT_SEGMENTATION

SmoothGroupStreamManifestBehavior

Smooth Group Stream Manifest Behavior

  • DO_NOT_SEND

  • SEND

SmoothGroupTimestampOffsetMode

Smooth Group Timestamp Offset Mode

  • USE_CONFIGURED_OFFSET

  • USE_EVENT_START_DATE

Smpte2038DataPreference

Smpte2038 Data Preference

  • IGNORE

  • PREFER

SmpteTtDestinationSettings

Smpte Tt Destination Settings

StandardHlsSettings

Standard Hls Settings

Property Type Required Description
m3u8Settings

M3u8Settings

True
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 ','.

StaticKeySettings

Static Key Settings

Property Type Required Description
staticKeyValue

string

MinLength: 32

MaxLength: 32

True

Static key value as a 32 character hexadecimal string.

keyProviderServer

InputLocation

False

The URL of the license server used for protecting content.

Tags

Property Type Required Description

*

string

False

TeletextDestinationSettings

Teletext Destination Settings

TeletextSourceSettings

Teletext Source Settings

Property Type Required Description
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

  • AUTO

  • DISABLED

  • ENABLED

TemporalFilterSettings

Temporal Filter Settings

Property Type Required Description
strength

TemporalFilterStrength

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.

postFilterSharpening

TemporalFilterPostFilterSharpening

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.

TemporalFilterStrength

Temporal Filter Strength

  • AUTO

  • STRENGTH_1

  • STRENGTH_2

  • STRENGTH_3

  • STRENGTH_4

  • STRENGTH_5

  • STRENGTH_6

  • STRENGTH_7

  • STRENGTH_8

  • STRENGTH_9

  • STRENGTH_10

  • STRENGTH_11

  • STRENGTH_12

  • STRENGTH_13

  • STRENGTH_14

  • STRENGTH_15

  • STRENGTH_16

TimecodeConfig

Timecode Config

Property Type Required Description
source

TimecodeConfigSource

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

  • EMBEDDED

  • SYSTEMCLOCK

  • ZEROBASED

TtmlDestinationSettings

Ttml Destination Settings

Property Type Required Description
styleControl

TtmlDestinationStyleControl

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

  • PASSTHROUGH

  • USE_CONFIGURED

UdpContainerSettings

Udp Container Settings

Property Type Required Description
m2tsSettings

M2tsSettings

False

UdpGroupSettings

Udp Group Settings

Property Type Required Description
inputLossAction

InputLossActionForUdpOut

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.

timedMetadataId3Period

integer

Minimum: 0

False

Timed Metadata interval in seconds.

timedMetadataId3Frame

UdpTimedMetadataId3Frame

False

Indicates ID3 frame that has the timecode.

UdpOutputSettings

Udp Output Settings

Property Type Required Description
destination

OutputLocationRef

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

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.

fecOutputSettings

FecOutputSettings

False

Settings for enabling and adjusting Forward Error Correction on UDP outputs.

containerSettings

UdpContainerSettings

True

UdpTimedMetadataId3Frame

Udp Timed Metadata Id3 Frame

  • NONE

  • PRIV

  • TDRL

VideoBlackFailoverSettings

Property Type Required Description
videoBlackThresholdMsec

integer

Minimum: 1000

False

The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.

blackDetectThreshold

number

Minimum: 0.0

Maximum: 1.0

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.

VideoCodecSettings

Video Codec Settings

Property Type Required Description
h264Settings

H264Settings

False
h265Settings

H265Settings

False
mpeg2Settings

Mpeg2Settings

False
frameCaptureSettings

FrameCaptureSettings

False

VideoDescription

Video settings for this stream.

Property Type Required Description
codecSettings

VideoCodecSettings

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

VideoDescriptionRespondToAfd

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

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.

scalingBehavior

VideoDescriptionScalingBehavior

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.

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

  • NONE

  • PASSTHROUGH

  • RESPOND

VideoDescriptionScalingBehavior

Video Description Scaling Behavior

  • DEFAULT

  • STRETCH_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
selectorSettings

VideoSelectorSettings

False

The video selector settings.

colorSpace

VideoSelectorColorSpace

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.

colorSpaceUsage

VideoSelectorColorSpaceUsage

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.

VideoSelectorColorSpace

Video Selector Color Space

  • FOLLOW

  • REC_601

  • REC_709

VideoSelectorColorSpaceUsage

Video Selector Color Space Usage

  • FALLBACK

  • FORCE

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
videoSelectorProgramId

VideoSelectorProgramId

False
videoSelectorPid

VideoSelectorPid

False

WavCodingMode

Wav Coding Mode

  • CODING_MODE_1_0

  • CODING_MODE_2_0

  • CODING_MODE_4_0

  • CODING_MODE_8_0

WavSettings

Wav Settings

Property Type Required Description
codingMode

WavCodingMode

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.

bitDepth

number

False

Bits per sample.

WebvttDestinationSettings

Webvtt Destination Settings

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

StartChannel