Documentation

Hls Group Settings

See: newHlsGroupSettings smart constructor.

Create a value of HlsGroupSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:directoryStructure:HlsGroupSettings', hlsGroupSettings_directoryStructure - Place segments in subdirectories.

$sel:encryptionType:HlsGroupSettings', hlsGroupSettings_encryptionType - Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.

$sel:timedMetadataId3Period:HlsGroupSettings', hlsGroupSettings_timedMetadataId3Period - Timed Metadata interval in seconds.

$sel:ivInManifest:HlsGroupSettings', hlsGroupSettings_ivInManifest - 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.

$sel:discontinuityTags:HlsGroupSettings', hlsGroupSettings_discontinuityTags - 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.

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

$sel:minSegmentLength:HlsGroupSettings', hlsGroupSettings_minSegmentLength - 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.

$sel:iFrameOnlyPlaylists:HlsGroupSettings', hlsGroupSettings_iFrameOnlyPlaylists - DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"

$sel:programDateTime:HlsGroupSettings', hlsGroupSettings_programDateTime - 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.

$sel:indexNSegments:HlsGroupSettings', hlsGroupSettings_indexNSegments - Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field.

$sel:programDateTimePeriod:HlsGroupSettings', hlsGroupSettings_programDateTimePeriod - Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

$sel:codecSpecification:HlsGroupSettings', hlsGroupSettings_codecSpecification - Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

$sel:hlsCdnSettings:HlsGroupSettings', hlsGroupSettings_hlsCdnSettings - Parameters that control interactions with the CDN.

$sel:captionLanguageMappings:HlsGroupSettings', hlsGroupSettings_captionLanguageMappings - Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".

$sel:inputLossAction:HlsGroupSettings', hlsGroupSettings_inputLossAction - Parameter that control output group behavior on input loss.

$sel:mode:HlsGroupSettings', hlsGroupSettings_mode - If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.

$sel:keyProviderSettings:HlsGroupSettings', hlsGroupSettings_keyProviderSettings - The key provider settings.

$sel:incompleteSegmentBehavior:HlsGroupSettings', hlsGroupSettings_incompleteSegmentBehavior - 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.

$sel:constantIv:HlsGroupSettings', hlsGroupSettings_constantIv - 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.

$sel:baseUrlManifest:HlsGroupSettings', hlsGroupSettings_baseUrlManifest - 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.

$sel:adMarkers:HlsGroupSettings', hlsGroupSettings_adMarkers - Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

$sel:keyFormat:HlsGroupSettings', hlsGroupSettings_keyFormat - 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.

$sel:segmentLength:HlsGroupSettings', hlsGroupSettings_segmentLength - 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.

$sel:hlsId3SegmentTagging:HlsGroupSettings', hlsGroupSettings_hlsId3SegmentTagging - State of HLS ID3 Segment Tagging

$sel:timedMetadataId3Frame:HlsGroupSettings', hlsGroupSettings_timedMetadataId3Frame - Indicates ID3 frame that has the timecode.

$sel:baseUrlContent:HlsGroupSettings', hlsGroupSettings_baseUrlContent - 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.

$sel:outputSelection:HlsGroupSettings', hlsGroupSettings_outputSelection - MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS_ONLY: Does not generate any manifests for this output group.

$sel:captionLanguageSetting:HlsGroupSettings', hlsGroupSettings_captionLanguageSetting - 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.

$sel:segmentsPerSubdirectory:HlsGroupSettings', hlsGroupSettings_segmentsPerSubdirectory - Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.

$sel:manifestDurationFormat:HlsGroupSettings', hlsGroupSettings_manifestDurationFormat - Indicates whether the output manifest should use floating point or integer values for segment duration.

$sel:ivSource:HlsGroupSettings', hlsGroupSettings_ivSource - 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.

$sel:segmentationMode:HlsGroupSettings', hlsGroupSettings_segmentationMode - useInputSegmentation has been deprecated. The configured segment size is always used.

$sel:keyFormatVersions:HlsGroupSettings', hlsGroupSettings_keyFormatVersions - Either a single positive integer version value or a slash delimited list of version values (1/2/3).

$sel:clientCache:HlsGroupSettings', hlsGroupSettings_clientCache - 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.

$sel:timestampDeltaMilliseconds:HlsGroupSettings', hlsGroupSettings_timestampDeltaMilliseconds - Provides an extra millisecond delta offset to fine tune the timestamps.

$sel:baseUrlManifest1:HlsGroupSettings', hlsGroupSettings_baseUrlManifest1 - 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.

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

$sel:streamInfResolution:HlsGroupSettings', hlsGroupSettings_streamInfResolution - Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

$sel:keepSegments:HlsGroupSettings', hlsGroupSettings_keepSegments - Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player.

$sel:baseUrlContent1:HlsGroupSettings', hlsGroupSettings_baseUrlContent1 - 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.

$sel:manifestCompression:HlsGroupSettings', hlsGroupSettings_manifestCompression - When set to gzip, compresses HLS playlist.

$sel:destination:HlsGroupSettings', hlsGroupSettings_destination - A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).

Place segments in subdirectories.

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

Timed Metadata interval in seconds.

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.

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.

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

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.

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

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.

Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field.

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

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

Parameters that control interactions with the CDN.

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

Parameter that control output group behavior on input loss.

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

The key provider settings.

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.

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.

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.

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

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.

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.

State of HLS ID3 Segment Tagging

Indicates ID3 frame that has the timecode.

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.

MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS_ONLY: Does not generate any manifests for this output group.

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.

Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.

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

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.

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

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

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.

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

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.

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

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

Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player.

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.

When set to gzip, compresses HLS playlist.

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