interface HlsGroupSettingsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.MediaLive.CfnChannel.HlsGroupSettingsProperty`
Java	`software.amazon.awscdk.services.medialive.CfnChannel.HlsGroupSettingsProperty`
Python	`aws_cdk.aws_medialive.CfnChannel.HlsGroupSettingsProperty`
TypeScript	`@aws-cdk/aws-medialive` » `CfnChannel` » `HlsGroupSettingsProperty`

The settings for an HLS output group.

The parent of this entity is OutputGroupSettings.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive from '@aws-cdk/aws-medialive';
const hlsGroupSettingsProperty: medialive.CfnChannel.HlsGroupSettingsProperty = {
  adMarkers: ['adMarkers'],
  baseUrlContent: 'baseUrlContent',
  baseUrlContent1: 'baseUrlContent1',
  baseUrlManifest: 'baseUrlManifest',
  baseUrlManifest1: 'baseUrlManifest1',
  captionLanguageMappings: [{
    captionChannel: 123,
    languageCode: 'languageCode',
    languageDescription: 'languageDescription',
  }],
  captionLanguageSetting: 'captionLanguageSetting',
  clientCache: 'clientCache',
  codecSpecification: 'codecSpecification',
  constantIv: 'constantIv',
  destination: {
    destinationRefId: 'destinationRefId',
  },
  directoryStructure: 'directoryStructure',
  discontinuityTags: 'discontinuityTags',
  encryptionType: 'encryptionType',
  hlsCdnSettings: {
    hlsAkamaiSettings: {
      connectionRetryInterval: 123,
      filecacheDuration: 123,
      httpTransferMode: 'httpTransferMode',
      numRetries: 123,
      restartDelay: 123,
      salt: 'salt',
      token: 'token',
    },
    hlsBasicPutSettings: {
      connectionRetryInterval: 123,
      filecacheDuration: 123,
      numRetries: 123,
      restartDelay: 123,
    },
    hlsMediaStoreSettings: {
      connectionRetryInterval: 123,
      filecacheDuration: 123,
      mediaStoreStorageClass: 'mediaStoreStorageClass',
      numRetries: 123,
      restartDelay: 123,
    },
    hlsS3Settings: {
      cannedAcl: 'cannedAcl',
    },
    hlsWebdavSettings: {
      connectionRetryInterval: 123,
      filecacheDuration: 123,
      httpTransferMode: 'httpTransferMode',
      numRetries: 123,
      restartDelay: 123,
    },
  },
  hlsId3SegmentTagging: 'hlsId3SegmentTagging',
  iFrameOnlyPlaylists: 'iFrameOnlyPlaylists',
  incompleteSegmentBehavior: 'incompleteSegmentBehavior',
  indexNSegments: 123,
  inputLossAction: 'inputLossAction',
  ivInManifest: 'ivInManifest',
  ivSource: 'ivSource',
  keepSegments: 123,
  keyFormat: 'keyFormat',
  keyFormatVersions: 'keyFormatVersions',
  keyProviderSettings: {
    staticKeySettings: {
      keyProviderServer: {
        passwordParam: 'passwordParam',
        uri: 'uri',
        username: 'username',
      },
      staticKeyValue: 'staticKeyValue',
    },
  },
  manifestCompression: 'manifestCompression',
  manifestDurationFormat: 'manifestDurationFormat',
  minSegmentLength: 123,
  mode: 'mode',
  outputSelection: 'outputSelection',
  programDateTime: 'programDateTime',
  programDateTimeClock: 'programDateTimeClock',
  programDateTimePeriod: 123,
  redundantManifest: 'redundantManifest',
  segmentationMode: 'segmentationMode',
  segmentLength: 123,
  segmentsPerSubdirectory: 123,
  streamInfResolution: 'streamInfResolution',
  timedMetadataId3Frame: 'timedMetadataId3Frame',
  timedMetadataId3Period: 123,
  timestampDeltaMilliseconds: 123,
  tsFileMode: 'tsFileMode',
};

Properties

Name	Type	Description
adMarkers?	`string[]`	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. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.
baseUrlContent1?	`string`	Optional.
baseUrlManifest?	`string`	A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.
baseUrlManifest1?	`string`	Optional.
captionLanguageMappings?	`IResolvable` `\|` `IResolvable` `\|` `CaptionLanguageMappingProperty[]`	A mapping of up to 4 captions channels to captions languages.
captionLanguageSetting?	`string`	Applies only to 608 embedded output captions.
clientCache?	`string`	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`	The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
constantIv?	`string`	Used with encryptionType.
destination?	`IResolvable` `\|` `OutputLocationRefProperty`	A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
directoryStructure?	`string`	Places segments in subdirectories.
discontinuityTags?	`string`	Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.
encryptionType?	`string`	Encrypts the segments with the specified encryption scheme.
hlsCdnSettings?	`IResolvable` `\|` `HlsCdnSettingsProperty`	The parameters that control interactions with the CDN.
hlsId3SegmentTagging?	`string`	State of HLS ID3 Segment Tagging.
iFrameOnlyPlaylists?	`string`	DISABLED: Don't create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).
incompleteSegmentBehavior?	`string`	Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.
indexNSegments?	`number`	Applies only if the Mode field is LIVE.
inputLossAction?	`string`	A parameter that controls output group behavior on an input loss.
ivInManifest?	`string`	Used with encryptionType.
ivSource?	`string`	Used with encryptionType.
keepSegments?	`number`	Applies only if the Mode field is LIVE.
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?	`IResolvable` `\|` `KeyProviderSettingsProperty`	The key provider settings.
manifestCompression?	`string`	When set to gzip, compresses HLS playlist.
manifestDurationFormat?	`string`	Indicates whether the output manifest should use a floating point or integer values for segment duration.
minSegmentLength?	`number`	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`	If "vod," all segments are indexed and kept permanently in the destination and manifest.
outputSelection?	`string`	MANIFESTSANDSEGMENTS: Generates manifests (the master manifest, if applicable, and media manifests) for this output group.
programDateTime?	`string`	Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: Either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.
programDateTimeClock?	`string`	`CfnChannel.HlsGroupSettingsProperty.ProgramDateTimeClock`.
programDateTimePeriod?	`number`	The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry, in seconds.
redundantManifest?	`string`	ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows a playout device that supports stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players, so a redundant manifest from MediaLive is irrelevant.
segmentLength?	`number`	The length of the MPEG-2 Transport Stream segments to create, in seconds.
segmentationMode?	`string`	useInputSegmentation has been deprecated.
segmentsPerSubdirectory?	`number`	The number of segments to write to a subdirectory before starting a new one.
streamInfResolution?	`string`	The include or exclude RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag of a variant manifest.
timedMetadataId3Frame?	`string`	Indicates the ID3 frame that has the timecode.
timedMetadataId3Period?	`number`	The timed metadata interval, in seconds.
timestampDeltaMilliseconds?	`number`	Provides an extra millisecond delta offset to fine tune the timestamps.
tsFileMode?	`string`	SEGMENTEDFILES: Emits the program as segments -multiple .ts media files. SINGLEFILE: Applies only if the Mode field is VOD. Emits the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.

adMarkers?

Type: string[] (optional)

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

baseUrlContent?

Type: string (optional)

A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

baseUrlContent1?

Type: string (optional)

Optional.

One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.

baseUrlManifest?

Type: string (optional)

A partial URI prefix that will be prepended to each output in the media .m3u8 file. The partial URI prefix can be used if the base manifest is delivered from a different URL than the main .m3u8 file.

baseUrlManifest1?

Type: string (optional)

Optional.

One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.

captionLanguageMappings?

Type: IResolvable | IResolvable | CaptionLanguageMappingProperty[] (optional)

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

This is meaningful only if captionLanguageSetting is set to "insert."

captionLanguageSetting?

Type: string (optional)

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 that 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 captions selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match properly with the output captions. None: Include the CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.

clientCache?

Type: string (optional)

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?

Type: string (optional)

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

constantIv?

Type: string (optional)

Used with encryptionType.

This is a 128-bit, 16-byte hex value that is represented by a 32-character text string. If ivSource is set to "explicit," this parameter is required and is used as the IV for encryption.

destination?

Type: IResolvable | OutputLocationRefProperty (optional)

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

directoryStructure?

Type: string (optional)

Places segments in subdirectories.

discontinuityTags?

Type: string (optional)

Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.

Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.

encryptionType?

Type: string (optional)

Encrypts the segments with the specified encryption scheme.

Exclude this parameter if you don't want encryption.

hlsCdnSettings?

Type: IResolvable | HlsCdnSettingsProperty (optional)

The parameters that control interactions with the CDN.

hlsId3SegmentTagging?

Type: string (optional)

State of HLS ID3 Segment Tagging.

iFrameOnlyPlaylists?

Type: string (optional)

DISABLED: Don't create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).

STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888".

incompleteSegmentBehavior?

Type: string (optional)

Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.

Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.

indexNSegments?

Type: number (optional)

Applies only if the Mode field is LIVE.

Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.

inputLossAction?

Type: string (optional)

A parameter that controls output group behavior on an input loss.

ivInManifest?

Type: string (optional)

Used with encryptionType.

The IV (initialization vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include," the IV is listed in the manifest. Otherwise, the IV is not in the manifest.

ivSource?

Type: string (optional)

Used 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 causes the IV to change every segment (to match the segment number). If this is set to "explicit," you must enter a constantIv value.

keepSegments?

Type: number (optional)

Applies only if the Mode field is LIVE.

Specifies the number of media segments (.ts files) to retain in the destination directory.

keyFormat?

Type: string (optional)

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

If the parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be specified.

keyFormatVersions?

Type: string (optional)

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

keyProviderSettings?

Type: IResolvable | KeyProviderSettingsProperty (optional)

The key provider settings.

manifestCompression?

Type: string (optional)

When set to gzip, compresses HLS playlist.

manifestDurationFormat?

Type: string (optional)

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

minSegmentLength?

Type: number (optional)

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?

Type: string (optional)

If "vod," all segments are indexed and kept permanently in the destination and manifest.

If "live," only the number segments specified in keepSegments and indexNSegments are kept. Newer segments replace older segments, which might prevent players from rewinding all the way to the beginning of the channel. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.

outputSelection?

Type: string (optional)

MANIFESTSANDSEGMENTS: Generates manifests (the master manifest, if applicable, and media manifests) for this output group.

SEGMENTSONLY: Doesn't generate any manifests for this output group.

programDateTime?

Type: string (optional)

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

programDateTimeClock?

Type: string (optional)

CfnChannel.HlsGroupSettingsProperty.ProgramDateTimeClock.

programDateTimePeriod?

Type: number (optional)

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

redundantManifest?

Type: string (optional)

ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows a playout device that supports stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players, so a redundant manifest from MediaLive is irrelevant.

segmentLength?

Type: number (optional)

The length of the MPEG-2 Transport Stream segments to create, in seconds.

Note that segments will end on the next keyframe after this number of seconds, so the actual segment length might be longer.

segmentationMode?

Type: string (optional)

useInputSegmentation has been deprecated.

The configured segment size is always used.

segmentsPerSubdirectory?

Type: number (optional)

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

For this setting to have an effect, directoryStructure must be subdirectoryPerStream.

streamInfResolution?

Type: string (optional)

The include or exclude RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag of a variant manifest.

timedMetadataId3Frame?

Type: string (optional)

Indicates the ID3 frame that has the timecode.

timedMetadataId3Period?

Type: number (optional)

The timed metadata interval, in seconds.

timestampDeltaMilliseconds?

Type: number (optional)

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

tsFileMode?

Type: string (optional)

SEGMENTEDFILES: Emits the program as segments -multiple .ts media files. SINGLEFILE: Applies only if the Mode field is VOD. Emits the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.