AWS::MediaPackage::OriginEndpoint HlsPackage - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::MediaPackage::OriginEndpoint HlsPackage

Parameters for Apple HLS packaging.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AdMarkers" : String,
  "AdsOnDeliveryRestrictions" : String,
  "AdTriggers" : [ String, ... ],
  "Encryption" : HlsEncryption,
  "IncludeDvbSubtitles" : Boolean,
  "IncludeIframeOnlyStream" : Boolean,
  "PlaylistType" : String,
  "PlaylistWindowSeconds" : Integer,
  "ProgramDateTimeIntervalSeconds" : Integer,
  "SegmentDurationSeconds" : Integer,
  "StreamSelection" : StreamSelection,
  "UseAudioRenditionGroup" : Boolean
}

Properties

AdMarkers

Controls how ad markers are included in the packaged endpoint.

Valid values:

  • NONE - Omits all SCTE-35 ad markers from the output.

  • PASSTHROUGH - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest.

  • SCTE35_ENHANCED - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest.

Required: No

Type: String

Allowed values: NONE | SCTE35_ENHANCED | PASSTHROUGH | DATERANGE

Update requires: No interruption

AdsOnDeliveryRestrictions

The flags on SCTE-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in AWS Elemental MediaPackage, see SCTE-35 Message Options in AWS Elemental MediaPackage.

Required: No

Type: String

Allowed values: NONE | RESTRICTED | UNRESTRICTED | BOTH

Update requires: No interruption

AdTriggers

Specifies the SCTE-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest.

Valid values:

  • BREAK

  • DISTRIBUTOR_ADVERTISEMENT

  • DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY

  • DISTRIBUTOR_PLACEMENT_OPPORTUNITY

  • PROVIDER_ADVERTISEMENT

  • PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY

  • PROVIDER_PLACEMENT_OPPORTUNITY

  • SPLICE_INSERT

Required: No

Type: Array of String

Allowed values: SPLICE_INSERT | BREAK | PROVIDER_ADVERTISEMENT | DISTRIBUTOR_ADVERTISEMENT | PROVIDER_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_PLACEMENT_OPPORTUNITY | PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY

Update requires: No interruption

Encryption

Parameters for encrypting content.

Required: No

Type: HlsEncryption

Update requires: No interruption

IncludeDvbSubtitles

When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.

Required: No

Type: Boolean

Update requires: No interruption

IncludeIframeOnlyStream

Only applies to stream sets with a single video track. When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included.

Required: No

Type: Boolean

Update requires: No interruption

PlaylistType

When specified as either event or vod, a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist. Indicates if the playlist is live-to-VOD content.

Required: No

Type: String

Allowed values: NONE | EVENT | VOD

Update requires: No interruption

PlaylistWindowSeconds

Time window (in seconds) contained in each parent manifest.

Required: No

Type: Integer

Update requires: No interruption

ProgramDateTimeIntervalSeconds

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. Additionally, ID3Timed metadata messages are generated every 5 seconds starting when the content was ingested.

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

Omit this attribute or enter 0 to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.

Required: No

Type: Integer

Update requires: No interruption

SegmentDurationSeconds

Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration.

Required: No

Type: Integer

Update requires: No interruption

StreamSelection

Limitations for outputs from the endpoint, based on the video bitrate.

Required: No

Type: StreamSelection

Update requires: No interruption

UseAudioRenditionGroup

When true, AWS Elemental MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.

Required: No

Type: Boolean

Update requires: No interruption