Menu
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

channel ID

Responses

Status Code Response Model Description
200 Channel

Successfully initiated start of the channel.

400 InvalidRequest

This request was invalid.

500 InternalServiceError

Unexpected internal service error.

502 None

Bad Gateway Error

403 AccessDenied

You do not have permission to list channels.

404 ResourceNotFound

The channel you're requesting to describe does not exist.

504 None

Gateway Timeout Error

429 LimitExceeded

Request limit exceeded on list channel calls to channel service.

409 ResourceConflict

The channel is unable to create due to an issue with channel resources.

Schemas

Response Bodies

Example Channel

{ "inputAttachments": [ { "inputId": "string", "inputSettings": { "sourceEndBehavior": enum, "audioSelectors": [ { "name": "string", "selectorSettings": { "audioLanguageSelection": { "languageSelectionPolicy": enum, "languageCode": "string" }, "audioPidSelection": { "pid": integer } } } ], "deblockFilter": enum, "inputFilter": enum, "networkInputSettings": { "hlsInputSettings": { "retries": integer, "bandwidth": integer, "retryInterval": integer, "bufferSegments": integer }, "serverValidation": enum }, "videoSelector": { "colorSpace": enum, "selectorSettings": { "videoSelectorPid": { "pid": integer }, "videoSelectorProgramId": { "programId": integer } }, "colorSpaceUsage": enum }, "filterStrength": integer, "captionSelectors": [ { "name": "string", "languageCode": "string", "selectorSettings": { "embeddedSourceSettings": { "scte20Detection": enum, "source608ChannelNumber": integer, "convert608To708": enum, "source608TrackNumber": integer }, "scte20SourceSettings": { "source608ChannelNumber": integer, "convert608To708": enum }, "dvbSubSourceSettings": { "pid": integer }, "teletextSourceSettings": { "pageNumber": "string" }, "aribSourceSettings": { }, "scte27SourceSettings": { "pid": integer } } } ], "denoiseFilter": enum } } ], "roleArn": "string", "destinations": [ { "settings": [ { "passwordParam": "string", "url": "string", "username": "string" } ], "id": "string" } ], "name": "string", "encoderSettings": { "timecodeConfig": { "syncThreshold": integer, "source": enum }, "outputGroups": [ { "outputs": [ { "videoDescriptionName": "string", "outputName": "string", "captionDescriptionNames": [ "string" ], "outputSettings": { "archiveOutputSettings": { "extension": "string", "containerSettings": { "m2tsSettings": { "audioStreamType": enum, "ecmPid": "string", "dvbTeletextPid": "string", "aribCaptionsPidControl": enum, "bitrate": integer, "segmentationTime": number, "rateMode": enum, "audioPids": "string", "ebpLookaheadMs": integer, "ebpAudioInterval": enum, "audioFramesPerPes": integer, "fragmentTime": number, "scte35Pid": "string", "programNum": integer, "pcrPeriod": integer, "pmtInterval": integer, "segmentationStyle": enum, "ebif": enum, "audioBufferModel": enum, "dvbNitSettings": { "networkName": "string", "networkId": integer, "repInterval": integer }, "absentInputAudioBehavior": enum, "timedMetadataBehavior": enum, "timedMetadataPid": "string", "pmtPid": "string", "etvSignalPid": "string", "bufferModel": enum, "scte35Control": enum, "ebpPlacement": enum, "arib": enum, "dvbSdtSettings": { "serviceName": "string", "serviceProviderName": "string", "repInterval": integer, "outputSdt": enum }, "nullPacketBitrate": number, "pcrPid": "string", "transportStreamId": integer, "videoPid": "string", "pcrControl": enum, "esRateInPes": enum, "segmentationMarkers": enum, "klv": enum, "dvbTdtSettings": { "repInterval": integer }, "ccDescriptor": enum, "patInterval": integer, "etvPlatformPid": "string", "dvbSubPids": "string", "aribCaptionsPid": "string", "scte27Pids": "string", "klvDataPids": "string" } }, "nameModifier": "string" }, "msSmoothOutputSettings": { "nameModifier": "string" }, "udpOutputSettings": { "destination": { "destinationRefId": "string" }, "bufferMsec": integer, "containerSettings": { "m2tsSettings": { "audioStreamType": enum, "ecmPid": "string", "dvbTeletextPid": "string", "aribCaptionsPidControl": enum, "bitrate": integer, "segmentationTime": number, "rateMode": enum, "audioPids": "string", "ebpLookaheadMs": integer, "ebpAudioInterval": enum, "audioFramesPerPes": integer, "fragmentTime": number, "scte35Pid": "string", "programNum": integer, "pcrPeriod": integer, "pmtInterval": integer, "segmentationStyle": enum, "ebif": enum, "audioBufferModel": enum, "dvbNitSettings": { "networkName": "string", "networkId": integer, "repInterval": integer }, "absentInputAudioBehavior": enum, "timedMetadataBehavior": enum, "timedMetadataPid": "string", "pmtPid": "string", "etvSignalPid": "string", "bufferModel": enum, "scte35Control": enum, "ebpPlacement": enum, "arib": enum, "dvbSdtSettings": { "serviceName": "string", "serviceProviderName": "string", "repInterval": integer, "outputSdt": enum }, "nullPacketBitrate": number, "pcrPid": "string", "transportStreamId": integer, "videoPid": "string", "pcrControl": enum, "esRateInPes": enum, "segmentationMarkers": enum, "klv": enum, "dvbTdtSettings": { "repInterval": integer }, "ccDescriptor": enum, "patInterval": integer, "etvPlatformPid": "string", "dvbSubPids": "string", "aribCaptionsPid": "string", "scte27Pids": "string", "klvDataPids": "string" } }, "fecOutputSettings": { "rowLength": integer, "columnDepth": integer, "includeFec": enum } }, "hlsOutputSettings": { "segmentModifier": "string", "hlsSettings": { "standardHlsSettings": { "m3u8Settings": { "pmtPid": "string", "ecmPid": "string", "scte35Behavior": enum, "pcrPid": "string", "audioPids": "string", "audioFramesPerPes": integer, "scte35Pid": "string", "transportStreamId": integer, "videoPid": "string", "pcrControl": enum, "pcrPeriod": integer, "programNum": integer, "pmtInterval": integer, "patInterval": integer, "timedMetadataBehavior": enum }, "audioRenditionSets": "string" }, "audioOnlyHlsSettings": { "audioTrackType": enum, "audioGroupId": "string", "audioOnlyImage": { "passwordParam": "string", "uri": "string", "username": "string" } } }, "nameModifier": "string" } }, "audioDescriptionNames": [ "string" ] } ], "outputGroupSettings": { "archiveGroupSettings": { "destination": { "destinationRefId": "string" }, "rolloverInterval": integer }, "udpGroupSettings": { "inputLossAction": enum, "timedMetadataId3Frame": enum, "timedMetadataId3Period": integer }, "msSmoothGroupSettings": { "eventId": "string", "fragmentLength": integer, "timestampOffset": "string", "segmentationMode": enum, "numRetries": integer, "acquisitionPointId": "string", "eventStopBehavior": enum, "sparseTrackType": enum, "destination": { "destinationRefId": "string" }, "timestampOffsetMode": enum, "audioOnlyTimecodeControl": enum, "connectionRetryInterval": integer, "filecacheDuration": integer, "certificateMode": enum, "inputLossAction": enum, "sendDelayMs": integer, "eventIdMode": enum, "restartDelay": integer, "streamManifestBehavior": enum }, "hlsGroupSettings": { "segmentsPerSubdirectory": integer, "ivInManifest": enum, "outputSelection": enum, "encryptionType": enum, "destination": { "destinationRefId": "string" }, "indexNSegments": integer, "timedMetadataId3Frame": enum, "constantIv": "string", "baseUrlManifest": "string", "captionLanguageSetting": enum, "minSegmentLength": integer, "mode": enum, "keyProviderSettings": { "staticKeySettings": { "staticKeyValue": "string", "keyProviderServer": { "passwordParam": "string", "uri": "string", "username": "string" } } }, "manifestCompression": enum, "ivSource": enum, "tsFileMode": enum, "manifestDurationFormat": enum, "keyFormatVersions": "string", "streamInfResolution": enum, "timestampDeltaMilliseconds": integer, "baseUrlContent": "string", "segmentationMode": enum, "captionLanguageMappings": [ { "languageDescription": "string", "captionChannel": integer, "languageCode": "string" } ], "clientCache": enum, "codecSpecification": enum, "keepSegments": integer, "timedMetadataId3Period": integer, "programDateTime": enum, "directoryStructure": enum, "keyFormat": "string", "inputLossAction": enum, "adMarkers": [ enum ], "programDateTimePeriod": integer, "segmentLength": integer, "hlsCdnSettings": { "hlsAkamaiSettings": { "httpTransferMode": enum, "salt": "string", "numRetries": integer, "restartDelay": integer, "connectionRetryInterval": integer, "filecacheDuration": integer, "token": "string" }, "hlsWebdavSettings": { "httpTransferMode": enum, "numRetries": integer, "restartDelay": integer, "connectionRetryInterval": integer, "filecacheDuration": integer }, "hlsBasicPutSettings": { "numRetries": integer, "restartDelay": integer, "connectionRetryInterval": integer, "filecacheDuration": integer }, "hlsMediaStoreSettings": { "mediaStoreStorageClass": enum, "numRetries": integer, "restartDelay": integer, "connectionRetryInterval": integer, "filecacheDuration": integer } } } }, "name": "string" } ], "audioDescriptions": [ { "languageCodeControl": enum, "audioTypeControl": enum, "remixSettings": { "channelMappings": [ { "outputChannel": integer, "inputChannelLevels": [ { "inputChannel": integer, "gain": integer } ] } ], "channelsOut": integer, "channelsIn": integer }, "audioType": enum, "name": "string", "codecSettings": { "ac3Settings": { "drcProfile": enum, "dialnorm": integer, "codingMode": enum, "metadataControl": enum, "bitrate": number, "lfeFilter": enum, "bitstreamMode": enum }, "aacSettings": { "vbrQuality": enum, "codingMode": enum, "profile": enum, "inputType": enum, "bitrate": number, "rawFormat": enum, "rateControlMode": enum, "sampleRate": number, "spec": enum }, "eac3Settings": { "dialnorm": integer, "passthroughControl": enum, "drcLine": enum, "metadataControl": enum, "bitrate": number, "ltRtSurroundMixLevel": number, "surroundExMode": enum, "lfeControl": enum, "codingMode": enum, "surroundMode": enum, "attenuationControl": enum, "lfeFilter": enum, "dcFilter": enum, "phaseControl": enum, "ltRtCenterMixLevel": number, "stereoDownmix": enum, "bitstreamMode": enum, "loRoSurroundMixLevel": number, "drcRf": enum, "loRoCenterMixLevel": number }, "passThroughSettings": { }, "mp2Settings": { "codingMode": enum, "bitrate": number, "sampleRate": number } }, "languageCode": "string", "streamName": "string", "audioNormalizationSettings": { "targetLkfs": number, "algorithmControl": enum, "algorithm": enum }, "audioSelectorName": "string" } ], "captionDescriptions": [ { "captionSelectorName": "string", "languageDescription": "string", "name": "string", "destinationSettings": { "scte27DestinationSettings": { }, "burnInDestinationSettings": { "xPosition": integer, "backgroundColor": enum, "yPosition": integer, "teletextGridControl": enum, "backgroundOpacity": integer, "fontOpacity": integer, "shadowOpacity": integer, "fontResolution": integer, "shadowYOffset": integer, "outlineSize": integer, "outlineColor": enum, "fontSize": "string", "shadowXOffset": integer, "alignment": enum, "shadowColor": enum, "fontColor": enum, "font": { "passwordParam": "string", "uri": "string", "username": "string" } }, "teletextDestinationSettings": { }, "webvttDestinationSettings": { }, "ttmlDestinationSettings": { "styleControl": enum }, "smpteTtDestinationSettings": { }, "embeddedPlusScte20DestinationSettings": { }, "dvbSubDestinationSettings": { "xPosition": integer, "backgroundColor": enum, "yPosition": integer, "teletextGridControl": enum, "backgroundOpacity": integer, "fontOpacity": integer, "shadowOpacity": integer, "fontResolution": integer, "shadowYOffset": integer, "outlineSize": integer, "outlineColor": enum, "fontSize": "string", "shadowXOffset": integer, "alignment": enum, "shadowColor": enum, "fontColor": enum, "font": { "passwordParam": "string", "uri": "string", "username": "string" } }, "embeddedDestinationSettings": { }, "aribDestinationSettings": { }, "scte20PlusEmbeddedDestinationSettings": { } }, "languageCode": "string" } ], "availConfiguration": { "availSettings": { "scte35TimeSignalApos": { "adAvailOffset": integer, "webDeliveryAllowedFlag": enum, "noRegionalBlackoutFlag": enum }, "scte35SpliceInsert": { "adAvailOffset": integer, "webDeliveryAllowedFlag": enum, "noRegionalBlackoutFlag": enum } } }, "globalConfiguration": { "inputLossBehavior": { "inputLossImageType": enum, "inputLossImageColor": "string", "inputLossImageSlate": { "passwordParam": "string", "uri": "string", "username": "string" }, "repeatFrameMsec": integer, "blackFrameMsec": integer }, "supportLowFramerateInputs": enum, "initialAudioGain": integer, "inputEndAction": enum, "outputTimingSource": enum }, "videoDescriptions": [ { "respondToAfd": enum, "scalingBehavior": enum, "name": "string", "width": integer, "sharpness": integer, "codecSettings": { "h264Settings": { "minIInterval": integer, "slices": integer, "parNumerator": integer, "gopSizeUnits": enum, "maxBitrate": integer, "bitrate": integer, "bufFillPct": integer, "temporalAq": enum, "afdSignaling": enum, "timecodeInsertion": enum, "bufSize": integer, "softness": integer, "framerateControl": enum, "fixedAfd": enum, "level": enum, "lookAheadRateControl": enum, "profile": enum, "framerateNumerator": integer, "gopClosedCadence": integer, "framerateDenominator": integer, "spatialAq": enum, "entropyEncoding": enum, "adaptiveQuantization": enum, "colorMetadata": enum, "gopSize": number, "numRefFrames": integer, "gopBReference": enum, "syntax": enum, "parControl": enum, "parDenominator": integer, "sceneChangeDetect": enum, "scanType": enum, "gopNumBFrames": integer, "flickerAq": enum, "rateControlMode": enum } }, "height": integer } ], "availBlanking": { "state": enum, "availBlankingImage": { "passwordParam": "string", "uri": "string", "username": "string" } }, "blackoutSlate": { "networkEndBlackoutImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "networkEndBlackout": enum, "networkId": "string", "blackoutSlateImage": { "passwordParam": "string", "uri": "string", "username": "string" }, "state": enum } }, "id": "string", "pipelinesRunningCount": integer, "state": enum, "arn": "string", "egressEndpoints": [ { "sourceIp": "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" }

Properties

AacCodingMode (enum)

  • AD_RECEIVER_MIX

  • CODING_MODE_1_0

  • CODING_MODE_1_1

  • CODING_MODE_2_0

  • CODING_MODE_5_1

AacInputType (enum)

  • BROADCASTER_MIXED_AD

  • NORMAL

AacProfile (enum)

  • HEV1

  • HEV2

  • LC

AacRateControlMode (enum)

  • CBR

  • VBR

AacRawFormat (enum)

  • LATM_LOAS

  • NONE

AacSettings

Property Type Required Description
vbrQuality

string

False

VBR Quality Level - Only used if rateControlMode is VBR.

codingMode

string

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.

profile

string

False

AAC Profile.

inputType

string

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.

rawFormat

string

False

Sets LATM / LOAS AAC output for raw containers.

rateControlMode

string

False

Rate Control Mode.

sampleRate

number

False

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

spec

string

False

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

AacSpec (enum)

  • MPEG2

  • MPEG4

AacVbrQuality (enum)

  • HIGH

  • LOW

  • MEDIUM_HIGH

  • MEDIUM_LOW

Ac3BitstreamMode (enum)

  • COMMENTARY

  • COMPLETE_MAIN

  • DIALOGUE

  • EMERGENCY

  • HEARING_IMPAIRED

  • MUSIC_AND_EFFECTS

  • VISUALLY_IMPAIRED

  • VOICE_OVER

Ac3CodingMode (enum)

  • CODING_MODE_1_0

  • CODING_MODE_1_1

  • CODING_MODE_2_0

  • CODING_MODE_3_2_LFE

Ac3DrcProfile (enum)

  • FILM_STANDARD

  • NONE

Ac3LfeFilter (enum)

  • DISABLED

  • ENABLED

Ac3MetadataControl (enum)

  • FOLLOW_INPUT

  • USE_CONFIGURED

Ac3Settings

Property Type Required Description
drcProfile

string

False

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

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.

codingMode

string

False

Dolby Digital coding mode. Determines number of channels.

metadataControl

string

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.

bitrate

number

False

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

lfeFilter

string

False

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

bitstreamMode

string

False

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

AccessDenied

Property Type Required Description
message

string

False

AfdSignaling (enum)

  • AUTO

  • FIXED

  • NONE

ArchiveContainerSettings

Property Type Required Description
m2tsSettings

M2tsSettings

False

ArchiveGroupSettings

Property Type Required Description
destination

OutputLocationRef

True

A directory and base filename where archive files should be written. If the base filename portion of the URI is left blank, the base filename of the first input will be automatically inserted.

rolloverInterval

integer

Minimum: 1

False

Number of seconds to write to archive file before closing and starting a new one.

ArchiveOutputSettings

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

nameModifier

string

False

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

AribDestinationSettings

Property Type Required Description

AribSourceSettings

Property Type Required Description

AudioChannelMapping

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

Property Type Required Description
ac3Settings

Ac3Settings

False
aacSettings

AacSettings

False
eac3Settings

Eac3Settings

False
passThroughSettings

PassThroughSettings

False
mp2Settings

Mp2Settings

False

AudioDescription

Property Type Required Description
languageCodeControl

string

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.

audioTypeControl

string

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.

remixSettings

RemixSettings

False

Settings that control how input audio channels are remixed into the output audio channels.

audioType

string

False

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

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.

codecSettings

AudioCodecSettings

True

Audio codec settings.

languageCode

string

False

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

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.

audioSelectorName

string

True

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

AudioDescriptionAudioTypeControl (enum)

  • FOLLOW_INPUT

  • USE_CONFIGURED

AudioDescriptionLanguageCodeControl (enum)

  • FOLLOW_INPUT

  • USE_CONFIGURED

AudioLanguageSelection

Property Type Required Description
languageSelectionPolicy

string

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.

languageCode

string

True

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

AudioLanguageSelectionPolicy (enum)

  • LOOSE

  • STRICT

AudioNormalizationAlgorithm (enum)

  • ITU_1770_1

  • ITU_1770_2

AudioNormalizationAlgorithmControl (enum)

  • CORRECT_AUDIO

AudioNormalizationSettings

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

algorithmControl

string

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.

algorithm

string

False

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

AudioOnlyHlsSettings

Property Type Required Description
audioTrackType

string

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.

audioOnlyImage

InputLocation

False

For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by {image file size} * {segment count} * {user count.}.

AudioOnlyHlsTrackType (enum)

  • ALTERNATE_AUDIO_AUTO_SELECT

  • ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT

  • ALTERNATE_AUDIO_NOT_AUTO_SELECT

  • AUDIO_ONLY_VARIANT_STREAM

AudioPidSelection

Property Type Required Description
pid

integer

Minimum: 0

Maximum: 8191

True

Selects a specific PID from within a source.

AudioSelector

Property Type Required Description
name

string

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

Property Type Required Description
audioLanguageSelection

AudioLanguageSelection

False
audioPidSelection

AudioPidSelection

False

AudioType (enum)

  • CLEAN_EFFECTS

  • HEARING_IMPAIRED

  • UNDEFINED

  • VISUAL_IMPAIRED_COMMENTARY

AvailBlanking

Property Type Required Description
state

string

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 (enum)

  • DISABLED

  • ENABLED

AvailConfiguration

Property Type Required Description
availSettings

AvailSettings

False

Ad avail settings.

AvailSettings

Property Type Required Description
scte35TimeSignalApos

Scte35TimeSignalApos

False
scte35SpliceInsert

Scte35SpliceInsert

False

BlackoutSlate

Property Type Required Description
networkEndBlackoutImage

InputLocation

False

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

networkEndBlackout

string

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

False

Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

blackoutSlateImage

InputLocation

False

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

state

string

False

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

BlackoutSlateNetworkEndBlackout (enum)

  • DISABLED

  • ENABLED

BlackoutSlateState (enum)

  • DISABLED

  • ENABLED

BurnInAlignment (enum)

  • CENTERED

  • LEFT

  • SMART

BurnInBackgroundColor (enum)

  • BLACK

  • NONE

  • WHITE

BurnInDestinationSettings

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

backgroundColor

string

False

Specifies the color of the rectangle behind the captions. 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

string

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.

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.

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.

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.

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.

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.

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

string

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.

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.

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.

alignment

string

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.

shadowColor

string

False

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

fontColor

string

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.

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.

BurnInFontColor (enum)

  • BLACK

  • BLUE

  • GREEN

  • RED

  • WHITE

  • YELLOW

BurnInOutlineColor (enum)

  • BLACK

  • BLUE

  • GREEN

  • RED

  • WHITE

  • YELLOW

BurnInShadowColor (enum)

  • BLACK

  • NONE

  • WHITE

BurnInTeletextGridControl (enum)

  • FIXED

  • SCALED

CaptionDescription

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

Property Type Required Description
captionSelectorName

string

True

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

languageDescription

string

False

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

name

string

True

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

destinationSettings

CaptionDestinationSettings

False

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

languageCode

string

False

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

CaptionDestinationSettings

Property Type Required Description
scte27DestinationSettings

Scte27DestinationSettings

False
burnInDestinationSettings

BurnInDestinationSettings

False
teletextDestinationSettings

TeletextDestinationSettings

False
webvttDestinationSettings

WebvttDestinationSettings

False
ttmlDestinationSettings

TtmlDestinationSettings

False
smpteTtDestinationSettings

SmpteTtDestinationSettings

False
embeddedPlusScte20DestinationSettings

EmbeddedPlusScte20DestinationSettings

False
dvbSubDestinationSettings

DvbSubDestinationSettings

False
embeddedDestinationSettings

EmbeddedDestinationSettings

False
aribDestinationSettings

AribDestinationSettings

False
scte20PlusEmbeddedDestinationSettings

Scte20PlusEmbeddedDestinationSettings

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
languageDescription

string

False

Textual description of language

captionChannel

integer

Minimum: 1

Maximum: 4

False

Channel to insert closed captions. Each channel mapping must have a unique channel number (maximum of 4)

languageCode

string

False

Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)

CaptionSelector

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

Property Type Required Description
name

string

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.

selectorSettings

CaptionSelectorSettings

False

Caption selector settings.

CaptionSelectorSettings

Property Type Required Description
embeddedSourceSettings

EmbeddedSourceSettings

False
scte20SourceSettings

Scte20SourceSettings

False
dvbSubSourceSettings

DvbSubSourceSettings

False
teletextSourceSettings

TeletextSourceSettings

False
aribSourceSettings

AribSourceSettings

False
scte27SourceSettings

Scte27SourceSettings

False

Channel

Property Type Required Description
inputAttachments

Array of type InputAttachment

False

List of input attachments for channel.

roleArn

string

False

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

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.

name

string

False

The name of the channel. (user-mutable)

encoderSettings

EncoderSettings

False
id

string

False

The unique id of the channel.

pipelinesRunningCount

integer

False

The number of currently healthy pipelines.

state

string

False
arn

string

False

The unique arn of the channel.

egressEndpoints

Array of type ChannelEgressEndpoint

False

The endpoints where outgoing connections initiate from

ChannelEgressEndpoint

Property Type Required Description
sourceIp

string

False

Public IP of where a channel's output comes from

ChannelState (enum)

  • CREATING

  • CREATE_FAILED

  • IDLE

  • STARTING

  • RUNNING

  • RECOVERING

  • STOPPING

  • DELETING

  • DELETED

DvbNitSettings

DVB Network Information Table (NIT)

Property Type Required Description
networkName

string

True

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

networkId

integer

Minimum: 0

Maximum: 65536

True

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

repInterval

integer

Minimum: 25

Maximum: 10000

False

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

DvbSdtOutputSdt (enum)

  • SDT_FOLLOW

  • SDT_FOLLOW_IF_PRESENT

  • SDT_MANUAL

  • SDT_NONE

DvbSdtSettings

DVB Service Description Table (SDT)

Property Type Required Description
serviceName

string

False

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

serviceProviderName

string

False

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

repInterval

integer

Minimum: 25

Maximum: 2000

False

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

outputSdt

string

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.

DvbSubDestinationAlignment (enum)

  • CENTERED

  • LEFT

  • SMART

DvbSubDestinationBackgroundColor (enum)

  • BLACK

  • NONE

  • WHITE

DvbSubDestinationFontColor (enum)

  • BLACK

  • BLUE

  • GREEN

  • RED

  • WHITE

  • YELLOW

DvbSubDestinationOutlineColor (enum)

  • BLACK

  • BLUE

  • GREEN

  • RED

  • WHITE

  • YELLOW

DvbSubDestinationSettings

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

backgroundColor

string

False

Specifies the color of the rectangle behind the captions. 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

string

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.

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.

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.

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.

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.

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.

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

string

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.

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.

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.

alignment

string

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.

shadowColor

string

False

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

fontColor

string

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.

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.

DvbSubDestinationShadowColor (enum)

  • BLACK

  • NONE

  • WHITE

DvbSubDestinationTeletextGridControl (enum)

  • FIXED

  • SCALED

DvbSubSourceSettings

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 (enum)

  • ATTENUATE_3_DB

  • NONE

Eac3BitstreamMode (enum)

  • COMMENTARY

  • COMPLETE_MAIN

  • EMERGENCY

  • HEARING_IMPAIRED

  • VISUALLY_IMPAIRED

Eac3CodingMode (enum)

  • CODING_MODE_1_0

  • CODING_MODE_2_0

  • CODING_MODE_3_2

Eac3DcFilter (enum)

  • DISABLED

  • ENABLED

Eac3DrcLine (enum)

  • FILM_LIGHT

  • FILM_STANDARD

  • MUSIC_LIGHT

  • MUSIC_STANDARD

  • NONE

  • SPEECH

Eac3DrcRf (enum)

  • FILM_LIGHT

  • FILM_STANDARD

  • MUSIC_LIGHT

  • MUSIC_STANDARD

  • NONE

  • SPEECH

Eac3LfeControl (enum)

  • LFE

  • NO_LFE

Eac3LfeFilter (enum)

  • DISABLED

  • ENABLED

Eac3MetadataControl (enum)

  • FOLLOW_INPUT

  • USE_CONFIGURED

Eac3PassthroughControl (enum)

  • NO_PASSTHROUGH

  • WHEN_POSSIBLE

Eac3PhaseControl (enum)

  • NO_SHIFT

  • SHIFT_90_DEGREES

Eac3Settings

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

passthroughControl

string

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.

drcLine

string

False

Sets the Dolby dynamic range compression profile.

metadataControl

string

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.

bitrate

number

False

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

ltRtSurroundMixLevel

number

False

Left total/Right total surround mix level. Only used for 3/2 coding mode.

surroundExMode

string

False

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

lfeControl

string

False

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

codingMode

string

False

Dolby Digital Plus coding mode. Determines number of channels.

surroundMode

string

False

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

attenuationControl

string

False

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

lfeFilter

string

False

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

dcFilter

string

False

When set to enabled, activates a DC highpass filter for all input channels.

phaseControl

string

False

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

ltRtCenterMixLevel

number

False

Left total/Right total center mix level. Only used for 3/2 coding mode.

stereoDownmix

string

False

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

bitstreamMode

string

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.

loRoSurroundMixLevel

number

False

Left only/Right only surround mix level. Only used for 3/2 coding mode.

drcRf

string

False

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

loRoCenterMixLevel

number

False

Left only/Right only center mix level. Only used for 3/2 coding mode.

Eac3StereoDownmix (enum)

  • DPL2

  • LO_RO

  • LT_RT

  • NOT_INDICATED

Eac3SurroundExMode (enum)

  • DISABLED

  • ENABLED

  • NOT_INDICATED

Eac3SurroundMode (enum)

  • DISABLED

  • ENABLED

  • NOT_INDICATED

EmbeddedConvert608To708 (enum)

  • DISABLED

  • UPCONVERT

EmbeddedDestinationSettings

Property Type Required Description

EmbeddedPlusScte20DestinationSettings

Property Type Required Description

EmbeddedScte20Detection (enum)

  • AUTO

  • OFF

EmbeddedSourceSettings

Property Type Required Description
scte20Detection

string

False

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

source608ChannelNumber

integer

Minimum: 1

Maximum: 4

False

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

convert608To708

string

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.

source608TrackNumber

integer

Minimum: 1

Maximum: 5

False

This field is unused and deprecated.

EncoderSettings

Property Type Required Description
timecodeConfig

TimecodeConfig

True

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

outputGroups

Array of type OutputGroup

True
audioDescriptions

Array of type AudioDescription

True
captionDescriptions

Array of type CaptionDescription

False

Settings for caption decriptions

availConfiguration

AvailConfiguration

False

Event-wide configuration settings for ad avail insertion.

globalConfiguration

GlobalConfiguration

False

Configuration settings that apply to the event as a whole.

videoDescriptions

Array of type VideoDescription

True
availBlanking

AvailBlanking

False

Settings for ad avail blanking.

blackoutSlate

BlackoutSlate

False

Settings for blackout slate.

FecOutputIncludeFec (enum)

  • COLUMN

  • COLUMN_AND_ROW

FecOutputSettings

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

columnDepth

integer

Minimum: 4

Maximum: 20

False

Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.

includeFec

string

False

Enables column only or column and row based FEC

FixedAfd (enum)

  • AFD_0000

  • AFD_0010

  • AFD_0011

  • AFD_0100

  • AFD_1000

  • AFD_1001

  • AFD_1010

  • AFD_1011

  • AFD_1101

  • AFD_1110

  • AFD_1111

GlobalConfiguration

Property Type Required Description
inputLossBehavior

InputLossBehavior

False

Settings for system actions when input is lost.

supportLowFramerateInputs

string

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.

initialAudioGain

integer

Minimum: -60

Maximum: 60

False

Value to set the initial audio gain for the Live Event.

inputEndAction

string

False

Indicates the action to take when an input completes (e.g. end-of-file.) Options include immediately switching to the next sequential input (via "switchInput"), switching to the next input and looping back to the first input when last input ends (via "switchAndLoopInputs") or not switching inputs and instead transcoding black / color / slate images per the "Input Loss Behavior" configuration until an activateInput REST command is received (via "none").

outputTimingSource

string

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.

GlobalConfigurationInputEndAction (enum)

  • NONE

  • SWITCH_AND_LOOP_INPUTS

GlobalConfigurationLowFramerateInputs (enum)

  • DISABLED

  • ENABLED

GlobalConfigurationOutputTimingSource (enum)

  • INPUT_CLOCK

  • SYSTEM_CLOCK

H264AdaptiveQuantization (enum)

  • HIGH

  • HIGHER

  • LOW

  • MAX

  • MEDIUM

  • OFF

H264ColorMetadata (enum)

  • IGNORE

  • INSERT

H264EntropyEncoding (enum)

  • CABAC

  • CAVLC

H264FlickerAq (enum)

  • DISABLED

  • ENABLED

H264FramerateControl (enum)

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264GopBReference (enum)

  • DISABLED

  • ENABLED

H264GopSizeUnits (enum)

  • FRAMES

  • SECONDS

H264Level (enum)

  • 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 (enum)

  • HIGH

  • LOW

  • MEDIUM

H264ParControl (enum)

  • INITIALIZE_FROM_SOURCE

  • SPECIFIED

H264Profile (enum)

  • BASELINE

  • HIGH

  • HIGH_10BIT

  • HIGH_422

  • HIGH_422_10BIT

  • MAIN

H264RateControlMode (enum)

  • CBR

  • VBR

H264ScanType (enum)

  • INTERLACED

  • PROGRESSIVE

H264SceneChangeDetect (enum)

  • DISABLED

  • ENABLED

H264Settings

Property Type Required Description
minIInterval

integer

Minimum: 0

Maximum: 30

False

Only meaningful if sceneChangeDetect is set to enabled. 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

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.

parNumerator

integer

False

Pixel Aspect Ratio numerator.

gopSizeUnits

string

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.

maxBitrate

integer

Minimum: 1000

False

Maximum bitrate in bits/second (for VBR mode only).

bitrate

integer

Minimum: 1000

False

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

bufFillPct

integer

Minimum: 0

Maximum: 100

False

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

temporalAq

string

False

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

afdSignaling

string

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.

timecodeInsertion

string

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

bufSize

integer

Minimum: 0

False

Size of buffer (HRD buffer model) in bits/second.

softness

integer

Minimum: 0

Maximum: 128

False

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

framerateControl

string

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.

fixedAfd

string

False

Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.

level

string

False

H.264 Level.

lookAheadRateControl

string

False

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

profile

string

False

H.264 Profile.

framerateNumerator

integer

False

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

gopClosedCadence

integer

Minimum: 0

False

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

framerateDenominator

integer

False

Framerate denominator.

spatialAq

string

False

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

entropyEncoding

string

False

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

adaptiveQuantization

string

False

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

colorMetadata

string

False

Includes colorspace metadata in the output.

gopSize

number

Minimum: 1.0

False

GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.

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.

gopBReference

string

False

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

syntax

string

False

Produces a bitstream compliant with SMPTE RP-2027.

parControl

string

False

This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.

parDenominator

integer

Minimum: 1

False

Pixel Aspect Ratio denominator.

sceneChangeDetect

string

False

Scene change detection. Inserts I-frames on scene changes when enabled.

scanType

string

False

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

gopNumBFrames

integer

Minimum: 0

Maximum: 7

False

Number of B-frames between reference frames.

flickerAq

string

False

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

rateControlMode

string

False

Rate control mode.

H264SpatialAq (enum)

  • DISABLED

  • ENABLED

H264Syntax (enum)

  • DEFAULT

  • RP2027

H264TemporalAq (enum)

  • DISABLED

  • ENABLED

H264TimecodeInsertionBehavior (enum)

  • DISABLED

  • PIC_TIMING_SEI

HlsAdMarkers (enum)

  • ADOBE

  • ELEMENTAL

  • ELEMENTAL_SCTE35

HlsAkamaiHttpTransferMode (enum)

  • CHUNKED

  • NON_CHUNKED

HlsAkamaiSettings

Property Type Required Description
httpTransferMode

string

False

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

salt

string

False

Salt for authenticated Akamai.

numRetries

integer

Minimum: 0

False

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

restartDelay

integer

Minimum: 0

Maximum: 15

False

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

connectionRetryInterval

integer

Minimum: 0

False

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

filecacheDuration

integer

Minimum: 0

Maximum: 600

False

Size in seconds of file cache for streaming outputs.

token

string

False

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

HlsBasicPutSettings

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.

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.

connectionRetryInterval

integer

Minimum: 0

False

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

filecacheDuration

integer

Minimum: 0

Maximum: 600

False

Size in seconds of file cache for streaming outputs.

HlsCaptionLanguageSetting (enum)

  • INSERT

  • NONE

  • OMIT

HlsCdnSettings

Property Type Required Description
hlsAkamaiSettings

HlsAkamaiSettings

False
hlsWebdavSettings

HlsWebdavSettings

False
hlsBasicPutSettings

HlsBasicPutSettings

False
hlsMediaStoreSettings

HlsMediaStoreSettings

False

HlsClientCache (enum)

  • DISABLED

  • ENABLED

HlsCodecSpecification (enum)

  • RFC_4281

  • RFC_6381

HlsDirectoryStructure (enum)

  • SINGLE_DIRECTORY

  • SUBDIRECTORY_PER_STREAM

HlsEncryptionType (enum)

  • AES128

  • SAMPLE_AES

HlsGroupSettings

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

ivInManifest

string

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.

outputSelection

string

False

Generates the .m3u8 playlist file for this HLS output group. The segmentsOnly option will output segments without the .m3u8 file.

encryptionType

string

False

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

destination

OutputLocationRef

True

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

indexNSegments

integer

Minimum: 1

False

Number of segments to keep in the playlist (.m3u8) file. mode must be "vod" for this setting to have an effect, and this number should be less than or equal to keepSegments.

timedMetadataId3Frame

string

False

Indicates ID3 frame that has the timecode.

constantIv

string

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.

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.

captionLanguageSetting

string

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.

minSegmentLength

integer

Minimum: 0

False

When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

mode

string

False

If set to "vod", keeps and indexes all segments starting with the first segment. If set to "live" segments will age out and only the last keepSegments number of segments will be retained.

keyProviderSettings

KeyProviderSettings

False

The key provider settings.

manifestCompression

string

False

When set to gzip, compresses HLS playlist.

ivSource

string

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.

tsFileMode

string

False

When set to "singleFile", emits the program as a single media resource (.ts) file, and uses #EXT-X-BYTERANGE tags to index segment for playback. Playback of VOD mode content during event is not guaranteed due to HTTP server caching.

manifestDurationFormat

string

False

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

keyFormatVersions

string

False

Either a single positive integer version value or a slash delimited list of version values (1/2/3).

streamInfResolution

string

False

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

timestampDeltaMilliseconds

integer

Minimum: 0

False

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

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.

segmentationMode

string

False

When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.

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

clientCache

string

False

When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.

codecSpecification

string

False

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

keepSegments

integer

Minimum: 1

False

Number of segments to retain in the destination directory. mode must be "live" for this setting to have an effect.

timedMetadataId3Period

integer

Minimum: 0

False

Timed Metadata interval in seconds.

programDateTime

string

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.

directoryStructure

string

False

Place segments in subdirectories.

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.

inputLossAction

string

False

Parameter that control output group behavior on input loss.

adMarkers

Array of type string

False

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

programDateTimePeriod

integer

Minimum: 0

Maximum: 3600

False

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

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.

hlsCdnSettings

HlsCdnSettings

False

Parameters that control interactions with the CDN.

HlsInputSettings

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

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.

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 (enum)

  • EXCLUDE

  • INCLUDE

HlsIvSource (enum)

  • EXPLICIT

  • FOLLOWS_SEGMENT_NUMBER

HlsManifestCompression (enum)

  • GZIP

  • NONE

HlsManifestDurationFormat (enum)

  • FLOATING_POINT

  • INTEGER

HlsMediaStoreSettings

Property Type Required Description
mediaStoreStorageClass

string

False

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

numRetries

integer

Minimum: 0

False

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

restartDelay

integer

Minimum: 0

Maximum: 15

False

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

connectionRetryInterval

integer

Minimum: 0

False

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

filecacheDuration

integer

Minimum: 0

Maximum: 600

False

Size in seconds of file cache for streaming outputs.

HlsMediaStoreStorageClass (enum)

  • TEMPORAL

HlsMode (enum)

  • LIVE

  • VOD

HlsOutputSelection (enum)

  • MANIFESTS_AND_SEGMENTS

  • SEGMENTS_ONLY

HlsOutputSettings

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

nameModifier

string

True

String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.

HlsProgramDateTime (enum)

  • EXCLUDE

  • INCLUDE

HlsSegmentationMode (enum)

  • USE_INPUT_SEGMENTATION

  • USE_SEGMENT_DURATION

HlsSettings

Property Type Required Description
standardHlsSettings

StandardHlsSettings

False
audioOnlyHlsSettings

AudioOnlyHlsSettings

False

HlsStreamInfResolution (enum)

  • EXCLUDE

  • INCLUDE

HlsTimedMetadataId3Frame (enum)

  • NONE

  • PRIV

  • TDRL

HlsTsFileMode (enum)

  • SEGMENTED_FILES

  • SINGLE_FILE

HlsWebdavHttpTransferMode (enum)

  • CHUNKED

  • NON_CHUNKED

HlsWebdavSettings

Property Type Required Description
httpTransferMode

string

False

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

numRetries

integer

Minimum: 0

False

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

restartDelay

integer

Minimum: 0

Maximum: 15

False

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

connectionRetryInterval

integer

Minimum: 0

False

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

filecacheDuration

integer

Minimum: 0

Maximum: 600

False

Size in seconds of file cache for streaming outputs.

InputAttachment

Property Type Required Description
inputId

string

False

The ID of the input

inputSettings

InputSettings

False

Settings of an input (caption selector, etc.)

InputChannelLevel

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.

InputDeblockFilter (enum)

  • DISABLED

  • ENABLED

InputDenoiseFilter (enum)

  • DISABLED

  • ENABLED

InputFilter (enum)

  • AUTO

  • DISABLED

  • FORCED

InputLocation

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 rtmpEndpoint 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 (enum)

  • EMIT_OUTPUT

  • PAUSE_OUTPUT

InputLossActionForMsSmoothOut (enum)

  • EMIT_OUTPUT

  • PAUSE_OUTPUT

InputLossActionForUdpOut (enum)

  • DROP_PROGRAM

  • DROP_TS

  • EMIT_PROGRAM

InputLossBehavior

Property Type Required Description
inputLossImageType

string

False

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

inputLossImageColor

string

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.

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 (enum)

  • COLOR

  • SLATE

InputSettings

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

Property Type Required Description
sourceEndBehavior

string

False

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

audioSelectors

Array of type AudioSelector

False

Used to select the audio stream to decode for inputs that have multiple available.

deblockFilter

string

False

Enable or disable the deblock filter when filtering.

inputFilter

string

False

Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type

networkInputSettings

NetworkInputSettings

True

Input settings.

videoSelector

VideoSelector

False

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

filterStrength

integer

Minimum: 1

Maximum: 5

False

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

captionSelectors

Array of type CaptionSelector

False

Used to select the caption input to use for inputs that have multiple available.

denoiseFilter

string

False

Enable or disable the denoise filter when filtering.

InputSourceEndBehavior (enum)

  • CONTINUE

  • LOOP

InternalServiceError

Property Type Required Description
message

string

False

InvalidRequest

Property Type Required Description
message

string

False

KeyProviderSettings

Property Type Required Description
staticKeySettings

StaticKeySettings

False

LimitExceeded

Property Type Required Description
message

string

False

M2tsAbsentInputAudioBehavior (enum)

  • DROP

  • ENCODE_SILENCE

M2tsArib (enum)

  • DISABLED

  • ENABLED

M2tsAribCaptionsPidControl (enum)

  • AUTO

  • USE_CONFIGURED

M2tsAudioBufferModel (enum)

  • ATSC

  • DVB

M2tsAudioInterval (enum)

  • VIDEO_AND_FIXED_INTERVALS

  • VIDEO_INTERVAL

M2tsAudioStreamType (enum)

  • ATSC

  • DVB

M2tsBufferModel (enum)

  • MULTIPLEX

  • NONE

M2tsCcDescriptor (enum)

  • DISABLED

  • ENABLED

M2tsEbifControl (enum)

  • NONE

  • PASSTHROUGH

M2tsEbpPlacement (enum)

  • VIDEO_AND_AUDIO_PIDS

  • VIDEO_PID

M2tsEsRateInPes (enum)

  • EXCLUDE

  • INCLUDE

M2tsKlv (enum)

  • NONE

  • PASSTHROUGH

M2tsPcrControl (enum)

  • CONFIGURED_PCR_PERIOD

  • PCR_EVERY_PES_PACKET

M2tsRateMode (enum)

  • CBR

  • VBR

M2tsScte35Control (enum)

  • NONE

  • PASSTHROUGH

M2tsSegmentationMarkers (enum)

  • EBP

  • EBP_LEGACY

  • NONE

  • PSI_SEGSTART

  • RAI_ADAPT

  • RAI_SEGSTART

M2tsSegmentationStyle (enum)

  • MAINTAIN_CADENCE

  • RESET_CADENCE

M2tsSettings

Property Type Required Description
audioStreamType

string

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.

ecmPid

string

False

Packet Identifier (PID) for ECM in the transport stream. Only enabled when Simulcrypt is enabled. Can be entered as a decimal or hexadecimal value. Valid values are 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).

aribCaptionsPidControl

string

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.

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.

segmentationTime

number

Minimum: 1.0

False

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

rateMode

string

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.

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

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.

ebpAudioInterval

string

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.

audioFramesPerPes

integer

Minimum: 0

False

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

fragmentTime

number

Minimum: 0.0

False

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

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

programNum

integer

Minimum: 0

Maximum: 65535

False

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

pcrPeriod

integer

Minimum: 0

Maximum: 500

False

Maximum time in milliseconds between Program Clock Reference (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. Valid values are 0, 10..1000.

segmentationStyle

string

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.

ebif

string

False

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

audioBufferModel

string

False

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

dvbNitSettings

DvbNitSettings

False

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

absentInputAudioBehavior

string

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.

timedMetadataBehavior

string

False

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

timedMetadataPid

string

False

Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

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

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

bufferModel

string

False

If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.

scte35Control

string

False

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

ebpPlacement

string

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.

arib

string

False

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

dvbSdtSettings

DvbSdtSettings

False

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

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.

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

transportStreamId

integer

Minimum: 0

Maximum: 65535

False

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

videoPid

string

False

Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).

pcrControl

string

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.

esRateInPes

string

False

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

segmentationMarkers

string

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.

klv

string

False

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

dvbTdtSettings

DvbTdtSettings

False

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

ccDescriptor

string

False

When set to enabled, generates captionServiceDescriptor in PMT.

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.

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

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

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

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

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

M2tsTimedMetadataBehavior (enum)

  • NO_PASSTHROUGH

  • PASSTHROUGH

M3u8PcrControl (enum)

  • CONFIGURED_PCR_PERIOD

  • PCR_EVERY_PES_PACKET

M3u8Scte35Behavior (enum)

  • NO_PASSTHROUGH

  • PASSTHROUGH

M3u8Settings

Settings information for the .m3u8 container

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

ecmPid

string

False

ThePlatform-protected transport streams using 'microsoft' as Target Client include an ECM stream. This ECM stream contains the size, IV, and PTS of every sample in the transport stream. This stream PID is specified here. This PID has no effect on non ThePlatform-protected streams.

scte35Behavior

string

False

If set to passthrough, passes any SCTE-35 signals from the input source to this output.

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.

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.

audioFramesPerPes

integer

Minimum: 0

False

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

scte35Pid

string

False

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

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.

pcrControl

string

False

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

pcrPeriod

integer

Minimum: 0

Maximum: 500

False

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

programNum

integer

Minimum: 0

Maximum: 65535

False

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

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.

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.

timedMetadataBehavior

string

False

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

M3u8TimedMetadataBehavior (enum)

  • NO_PASSTHROUGH

  • PASSTHROUGH

Mp2CodingMode (enum)

  • CODING_MODE_1_0

  • CODING_MODE_2_0

Mp2Settings

Property Type Required Description
codingMode

string

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.

MsSmoothGroupSettings

Property Type Required Description
eventId

string

False

MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.

fragmentLength

integer

Minimum: 1

False

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

timestampOffset

string

False

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

segmentationMode

string

False

When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.

numRetries

integer

Minimum: 0

False

Number of retry attempts.

acquisitionPointId

string

False

The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".

eventStopBehavior

string

False

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

sparseTrackType

string

False

If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.

destination

OutputLocationRef

True

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

timestampOffsetMode

string

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

audioOnlyTimecodeControl

string

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.

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.

filecacheDuration

integer

Minimum: 0

False

Size in seconds of file cache for streaming outputs.

certificateMode

string

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 unless those certificates are manually added to the OS trusted keystore.

inputLossAction

string

False

Parameter that control output group behavior on input loss.

sendDelayMs

integer

Minimum: 0

Maximum: 10000

False

Outputs that are "output locked" can use this delay. Assign a delay to the output that is "secondary". Do not assign a delay to the "primary" output. The delay means that the primary output will always reach the downstream system before the secondary, which helps ensure that the downstream system always uses the primary output. (If there were no delay, the downstream system might flip-flop between whichever output happens to arrive first.) If the primary fails, the downstream system will switch to the secondary output. When the primary is restarted, the downstream system will switch back to the primary (because once again it is always arriving first)

eventIdMode

string

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.

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.

streamManifestBehavior

string

False

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

MsSmoothOutputSettings

Property Type Required Description
nameModifier

string

False

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

NetworkInputServerValidation (enum)

  • 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

string

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.

Output

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

Property Type Required Description
videoDescriptionName

string

False

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

outputName

string

False

The name used to identify an output.

captionDescriptionNames

Array of type string

False

The names of the CaptionDescriptions used as caption sources for this output.

outputSettings

OutputSettings

True

Output type-specific settings.

audioDescriptionNames

Array of type string

False

The names of the AudioDescriptions used as audio sources for this output.

OutputDestination

Property Type Required Description
settings

Array of type OutputDestinationSettings

False

Destination settings for output; one for each redundant encoder.

id

string

False

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

OutputDestinationSettings

Property Type Required Description
passwordParam

string

False

key used to extract the password from EC2 Parameter store

url

string

False

A URL specifying a destination

username

string

False

username for destination

OutputGroup

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

Property Type Required Description
outputs

Array of type Output

True
outputGroupSettings

OutputGroupSettings

True

Settings associated with the output group.

name

string

False

Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.

OutputGroupSettings

Property Type Required Description
archiveGroupSettings

ArchiveGroupSettings

False
udpGroupSettings

UdpGroupSettings

False
msSmoothGroupSettings

MsSmoothGroupSettings

False
hlsGroupSettings

HlsGroupSettings

False

OutputLocationRef

Reference to an OutputDestination ID defined in the channel

Property Type Required Description
destinationRefId

string

False

OutputSettings

Property Type Required Description
archiveOutputSettings

ArchiveOutputSettings

False
msSmoothOutputSettings

MsSmoothOutputSettings

False
udpOutputSettings

UdpOutputSettings

False
hlsOutputSettings

HlsOutputSettings

False

PassThroughSettings

Property Type Required Description

RemixSettings

Property Type Required Description
channelMappings

Array of type AudioChannelMapping

True

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

channelsOut

integer

Minimum: 1

Maximum: 8

False

Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8

channelsIn

integer

Minimum: 1

Maximum: 16

False

Number of input channels to be used.

ResourceConflict

Property Type Required Description
message

string

False

ResourceNotFound

Property Type Required Description
message

string

False

Scte20Convert608To708 (enum)

  • DISABLED

  • UPCONVERT

Scte20PlusEmbeddedDestinationSettings

Property Type Required Description

Scte20SourceSettings

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

string

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

Property Type Required Description

Scte27SourceSettings

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 (enum)

  • FOLLOW

  • IGNORE

Scte35AposWebDeliveryAllowedBehavior (enum)

  • FOLLOW

  • IGNORE

Scte35SpliceInsert

Property Type Required Description
adAvailOffset

integer

Minimum: -1000

Maximum: 1000

False

When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.

webDeliveryAllowedFlag

string

False

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

noRegionalBlackoutFlag

string

False

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

Scte35SpliceInsertNoRegionalBlackoutBehavior (enum)

  • FOLLOW

  • IGNORE

Scte35SpliceInsertWebDeliveryAllowedBehavior (enum)

  • FOLLOW

  • IGNORE

Scte35TimeSignalApos

Property Type Required Description
adAvailOffset

integer

Minimum: -1000

Maximum: 1000

False

When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.

webDeliveryAllowedFlag

string

False

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

noRegionalBlackoutFlag

string

False

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

SmoothGroupAudioOnlyTimecodeControl (enum)

  • PASSTHROUGH

  • USE_CONFIGURED_CLOCK

SmoothGroupCertificateMode (enum)

  • SELF_SIGNED

  • VERIFY_AUTHENTICITY

SmoothGroupEventIdMode (enum)

  • NO_EVENT_ID

  • USE_CONFIGURED

  • USE_TIMESTAMP

SmoothGroupEventStopBehavior (enum)

  • NONE

  • SEND_EOS

SmoothGroupSegmentationMode (enum)

  • USE_INPUT_SEGMENTATION

  • USE_SEGMENT_DURATION

SmoothGroupSparseTrackType (enum)

  • NONE

  • SCTE_35

SmoothGroupStreamManifestBehavior (enum)

  • DO_NOT_SEND

  • SEND

SmoothGroupTimestampOffsetMode (enum)

  • USE_CONFIGURED_OFFSET

  • USE_EVENT_START_DATE

SmpteTtDestinationSettings

Property Type Required Description

StandardHlsSettings

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

Property Type Required Description
staticKeyValue

string

True

Static key value as a 32 character hexadecimal string.

keyProviderServer

InputLocation

False

The URL of the license server used for protecting content.

TeletextDestinationSettings

Property Type Required Description

TeletextSourceSettings

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.

TimecodeConfig

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

source

string

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.

TimecodeConfigSource (enum)

  • EMBEDDED

  • SYSTEMCLOCK

  • ZEROBASED

TtmlDestinationSettings

Property Type Required Description
styleControl

string

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 (enum)

  • PASSTHROUGH

  • USE_CONFIGURED

UdpContainerSettings

Property Type Required Description
m2tsSettings

M2tsSettings

False

UdpGroupSettings

Property Type Required Description
inputLossAction

string

False

Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.

timedMetadataId3Frame

string

False

Indicates ID3 frame that has the timecode.

timedMetadataId3Period

integer

Minimum: 0

False

Timed Metadata interval in seconds.

UdpOutputSettings

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.

containerSettings

UdpContainerSettings

True
fecOutputSettings

FecOutputSettings

False

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

UdpTimedMetadataId3Frame (enum)

  • NONE

  • PRIV

  • TDRL

VideoCodecSettings

Property Type Required Description
h264Settings

H264Settings

False

VideoDescription

Video settings for this stream.

Property Type Required Description
respondToAfd

string

False

Indicates how to respond to the AFD values in the input stream. Setting to "respond" causes input video to be clipped, depending on AFD value, input display aspect ratio and output display aspect ratio.

scalingBehavior

string

False

When set to "stretchToOutput", automatically configures the output position to stretch the video to the specified output resolution. This option will override any position value.

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.

width

integer

False

Output video width (in pixels). Leave out to use source video width. If left out, height must also be left out. Display aspect ratio is always preserved by letterboxing or pillarboxing when necessary.

sharpness

integer

Minimum: 0

Maximum: 100

False

Changes the width of the anti-alias filter kernel used for scaling. Only applies if scaling is being performed and antiAlias is set to true. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.

codecSettings

VideoCodecSettings

True

Video codec settings.

height

integer

False

Output video height (in pixels). Leave blank to use source video height. If left blank, width must also be unspecified.

VideoDescriptionRespondToAfd (enum)

  • NONE

  • PASSTHROUGH

  • RESPOND

VideoDescriptionScalingBehavior (enum)

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

string

False

Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed.

selectorSettings

VideoSelectorSettings

False

The video selector settings.

colorSpaceUsage

string

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 (enum)

  • FOLLOW

  • REC_601

  • REC_709

VideoSelectorColorSpaceUsage (enum)

  • FALLBACK

  • FORCE

VideoSelectorPid

Property Type Required Description
pid

integer

Minimum: 0

Maximum: 8191

False

Selects a specific PID from within a video source.

VideoSelectorProgramId

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

Property Type Required Description
videoSelectorPid

VideoSelectorPid

False
videoSelectorProgramId

VideoSelectorProgramId

False

WebvttDestinationSettings

Property Type Required Description