interface HlsOutputGroupProps 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.MediaLive.Alpha.HlsOutputGroupProps`
Go	`github.com/aws/aws-cdk-go/awsmedialivealpha/v2#HlsOutputGroupProps`
Java	`software.amazon.awscdk.services.medialive.alpha.HlsOutputGroupProps`
Python	`aws_cdk.aws_medialive_alpha.HlsOutputGroupProps`
TypeScript (source)	`@aws-cdk/aws-medialive-alpha` » `HlsOutputGroupProps`

Properties for an HLS output group.

Example

declare const stack: Stack;
declare const input: medialive.IInput;
declare const bucket: s3.IBucket;
declare const video: medialive.EncodeConfiguration;

new medialive.Channel(stack, 'Channel', {
  inputs: [{ input }],
  availBlanking: {
    state: medialive.AvailBlankingState.ENABLED,
    image: medialive.FileLocation.fromBucket(bucket, 'slates/avail.png'),
  },
  blackoutSlate: {
    state: medialive.BlackoutSlateState.ENABLED,
    image: medialive.FileLocation.fromBucket(bucket, 'slates/blackout.png'),
  },
  outputGroups: [
    medialive.OutputGroupConfiguration.hls({
      name: 'hls',
      destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
      outputs: [{ encodes: [video], outputName: 'hls_out' }],
    }),
  ],
});

Properties

Name	Type	Description
destinations🔹	`OutputDestination[]`	The destinations for this output group — one per pipeline.
name🔹	`string`	The name of this output group.
adMarkers?🔹	`HlsAdMarkers[]`	Chooses one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
baseUrlContent?🔹	`string`	A partial URI prefix that will be prepended to each output in the media .m3u8 file.
baseUrlContent1?🔹	`string`	Optional base URL content for pipeline 1 if different from pipeline 0.
baseUrlManifest?🔹	`string`	A partial URI prefix that will be prepended to each output in the media .m3u8 file for the manifest.
baseUrlManifest1?🔹	`string`	Optional base URL manifest for pipeline 1 if different from pipeline 0.
captionLanguageMappings?🔹	`CaptionLanguageMapping[]`	A mapping of up to 4 captions channels to captions languages.
captionLanguageSetting?🔹	`HlsCaptionLanguageSetting`	Applies only to 608 embedded output captions.
clientCache?🔹	`HlsClientCache`	When set to DISABLED, sets the #EXT-X-ALLOW-CACHE:no tag in the manifest.
codecSpecification?🔹	`HlsCodecSpecification`	The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
constantIv?🔹	`string`	A 128-bit, 16-byte hex value represented by a 32-character text string used as the IV for encryption.
directoryStructure?🔹	`HlsDirectoryStructure`	Places segments in subdirectories.
discontinuityTags?🔹	`HlsDiscontinuityTags`	Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests.
encryptionType?🔹	`HlsEncryptionType`	Encrypts the segments with the specified encryption scheme.
hlsCdnSettings?🔹	`HlsCdnSettings`	Settings to configure the CDN for the HLS output.
hlsId3SegmentTagging?🔹	`HlsId3SegmentTaggingState`	State of HLS ID3 Segment Tagging.
iFrameOnlyPlaylists?🔹	`HlsIFrameOnlyPlaylists`	Whether to create an I-frame-only manifest.
incompleteSegmentBehavior?🔹	`HlsIncompleteSegmentBehavior`	Specifies whether to include the final (incomplete) segment in the media output.
indexNSegments?🔹	`number`	The maximum number of segments in the media manifest (LIVE mode only).
inputLossAction?🔹	`HlsInputLossAction`	Action to take when the input is lost.
ivInManifest?🔹	`HlsIvInManifest`	Whether the IV is listed in the manifest.
ivSource?🔹	`HlsIvSource`	Whether the IV follows the segment number or is explicit.
keepSegments?🔹	`number`	The number of segments to retain in the destination directory (LIVE mode only).
keyFormat?🔹	`string`	Specifies how the key is represented in the resource identified by the URI.
keyFormatVersions?🔹	`string`	Either a single positive integer version value or a slash-delimited list of version values (1/2/3).
keyProviderSettings?🔹	`HlsKeyProviderSettings`	The key provider settings for HLS encryption.
manifestCompression?🔹	`HlsManifestCompression`	When set to GZIP, compresses HLS playlist.
manifestDurationFormat?🔹	`HlsManifestDurationFormat`	Indicates whether the output manifest should use floating point or integer values for segment duration.
minSegment?🔹	`Segment`	The minimum segment length.
mode?🔹	`HlsMode`	The output mode — LIVE or VOD.
outputSelection?🔹	`HlsOutputSelection`	Controls which manifests and segments are generated.
outputs?🔹	`HlsOutputDefinition[]`	The outputs for this HLS output group.
programDateTime?🔹	`HlsProgramDateTime`	Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
programDateTimeClock?🔹	`HlsProgramDateTimeClock`	Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock.
programDateTimePeriod?🔹	`Duration`	The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry.
redundantManifest?🔹	`HlsRedundantManifest`	Whether the master manifest includes information about both pipelines.
segment?🔹	`Segment`	The length of each media segment.
segmentationMode?🔹	`HlsSegmentationMode`	The segmentation mode.
segmentsPerSubdirectory?🔹	`number`	The number of segments to write to a subdirectory before starting a new one.
streamInfResolution?🔹	`HlsStreamInfResolution`	Whether to include or exclude the RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag.
timedMetadataId3Frame?🔹	`HlsTimedMetadataId3Frame`	Indicates the ID3 frame that has the timecode.
timedMetadataId3Period?🔹	`Duration`	The timed metadata interval.
timestampDelta?🔹	`Duration`	Provides an extra delta offset to fine tune the timestamps.
tsFileMode?🔹	`HlsTsFileMode`	Whether to emit segmented files or a single file.

destinations🔹

Type: OutputDestination[]

The destinations for this output group — one per pipeline.

Array position determines the pipeline mapping:

destinations[0] → Pipeline 0
destinations[1] → Pipeline 1 (STANDARD channels only)

For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations.

name🔹

Type: string

The name of this output group.

Used as the destination reference ID. Underscores are normalised to hyphens internally.

adMarkers?🔹

Type: HlsAdMarkers[] (optional, default: no ad markers)

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

baseUrlContent?🔹

Type: string (optional, default: no base URL content prefix)

A partial URI prefix that will be prepended to each output in the media .m3u8 file.

baseUrlContent1?🔹

Type: string (optional, default: no base URL content 1)

Optional base URL content for pipeline 1 if different from pipeline 0.

baseUrlManifest?🔹

Type: string (optional, default: no base URL manifest prefix)

A partial URI prefix that will be prepended to each output in the media .m3u8 file for the manifest.

baseUrlManifest1?🔹

Type: string (optional, default: no base URL manifest 1)

Optional base URL manifest for pipeline 1 if different from pipeline 0.

captionLanguageMappings?🔹

Type: CaptionLanguageMapping[] (optional, default: no caption language mappings)

A mapping of up to 4 captions channels to captions languages.

Meaningful only if captionLanguageSetting is set to INSERT.

captionLanguageSetting?🔹

Type: HlsCaptionLanguageSetting (optional, default: service default)

Applies only to 608 embedded output captions.

clientCache?🔹

Type: HlsClientCache (optional, default: HlsClientCache.ENABLED)

When set to DISABLED, sets the #EXT-X-ALLOW-CACHE:no tag in the manifest.

codecSpecification?🔹

Type: HlsCodecSpecification (optional, default: HlsCodecSpecification.RFC_4281)

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

constantIv?🔹

Type: string (optional, default: no constant IV)

A 128-bit, 16-byte hex value represented by a 32-character text string used as the IV for encryption.

Used with encryptionType when ivSource is set to EXPLICIT.

directoryStructure?🔹

Type: HlsDirectoryStructure (optional, default: HlsDirectoryStructure.SINGLE_DIRECTORY)

Places segments in subdirectories.

discontinuityTags?🔹

Type: HlsDiscontinuityTags (optional, default: HlsDiscontinuityTags.INSERT)

Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests.

encryptionType?🔹

Type: HlsEncryptionType (optional, default: no encryption)

Encrypts the segments with the specified encryption scheme.

hlsCdnSettings?🔹

Type: HlsCdnSettings (optional, default: service default)

Settings to configure the CDN for the HLS output.

hlsId3SegmentTagging?🔹

Type: HlsId3SegmentTaggingState (optional, default: HlsId3SegmentTaggingState.DISABLED)

State of HLS ID3 Segment Tagging.

iFrameOnlyPlaylists?🔹

Type: HlsIFrameOnlyPlaylists (optional, default: HlsIFrameOnlyPlaylists.DISABLED)

Whether to create an I-frame-only manifest.

incompleteSegmentBehavior?🔹

Type: HlsIncompleteSegmentBehavior (optional, default: HlsIncompleteSegmentBehavior.AUTO)

Specifies whether to include the final (incomplete) segment in the media output.

indexNSegments?🔹

Type: number (optional, default: 10)

The maximum number of segments in the media manifest (LIVE mode only).

inputLossAction?🔹

Type: HlsInputLossAction (optional, default: HlsInputLossAction.EMIT_OUTPUT)

Action to take when the input is lost.

ivInManifest?🔹

Type: HlsIvInManifest (optional, default: service default)

Whether the IV is listed in the manifest.

ivSource?🔹

Type: HlsIvSource (optional, default: service default)

Whether the IV follows the segment number or is explicit.

keepSegments?🔹

Type: number (optional, default: 21)

The number of segments to retain in the destination directory (LIVE mode only).

keyFormat?🔹

Type: string (optional, default: service default)

Specifies how the key is represented in the resource identified by the URI.

keyFormatVersions?🔹

Type: string (optional, default: service default)

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

keyProviderSettings?🔹

Type: HlsKeyProviderSettings (optional, default: no key provider settings)

The key provider settings for HLS encryption.

manifestCompression?🔹

Type: HlsManifestCompression (optional, default: HlsManifestCompression.NONE)

When set to GZIP, compresses HLS playlist.

manifestDurationFormat?🔹

Type: HlsManifestDurationFormat (optional, default: HlsManifestDurationFormat.FLOATING_POINT)

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

minSegment?🔹

Type: Segment (optional, default: service default)

The minimum segment length.

HLS supports whole-second segments only.

mode?🔹

Type: HlsMode (optional, default: HlsMode.LIVE)

The output mode — LIVE or VOD.

outputSelection?🔹

Type: HlsOutputSelection (optional, default: HlsOutputSelection.MANIFESTS_AND_SEGMENTS)

Controls which manifests and segments are generated.

outputs?🔹

Type: HlsOutputDefinition[] (optional, default: no initial outputs)

The outputs for this HLS output group.

programDateTime?🔹

Type: HlsProgramDateTime (optional, default: HlsProgramDateTime.INCLUDE)

Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.

programDateTimeClock?🔹

Type: HlsProgramDateTimeClock (optional, default: HlsProgramDateTimeClock.SYSTEM_CLOCK, or INITIALIZE_FROM_OUTPUT_TIMECODE with epoch locking)

Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock.

programDateTimePeriod?🔹

Type: Duration (optional, default: Duration.minutes(10))

The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry.

redundantManifest?🔹

Type: HlsRedundantManifest (optional, default: HlsRedundantManifest.DISABLED)

Whether the master manifest includes information about both pipelines.

segment?🔹

Type: Segment (optional, default: Segment.seconds(2))

The length of each media segment.

HLS supports whole-second segments only.

segmentationMode?🔹

Type: HlsSegmentationMode (optional, default: HlsSegmentationMode.USE_SEGMENT_DURATION)

The segmentation mode.

segmentsPerSubdirectory?🔹

Type: number (optional, default: 10000)

The number of segments to write to a subdirectory before starting a new one.

streamInfResolution?🔹

Type: HlsStreamInfResolution (optional, default: HlsStreamInfResolution.INCLUDE)

Whether to include or exclude the RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag.

timedMetadataId3Frame?🔹

Type: HlsTimedMetadataId3Frame (optional, default: HlsTimedMetadataId3Frame.PRIV)

Indicates the ID3 frame that has the timecode.

timedMetadataId3Period?🔹

Type: Duration (optional, default: Duration.seconds(10))

The timed metadata interval.

timestampDelta?🔹

Type: Duration (optional, default: service default)

Provides an extra delta offset to fine tune the timestamps.

tsFileMode?🔹

Type: HlsTsFileMode (optional, default: HlsTsFileMode.SEGMENTED_FILES)

Whether to emit segmented files or a single file.