software.amazon.awscdk.services.medialive

Interface CfnChannel.HlsGroupSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.HlsGroupSettingsProperty.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(value=Stable)
public static interface CfnChannel.HlsGroupSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.medialive.*;
 HlsGroupSettingsProperty hlsGroupSettingsProperty = HlsGroupSettingsProperty.builder()
         .adMarkers(List.of("adMarkers"))
         .baseUrlContent("baseUrlContent")
         .baseUrlContent1("baseUrlContent1")
         .baseUrlManifest("baseUrlManifest")
         .baseUrlManifest1("baseUrlManifest1")
         .captionLanguageMappings(List.of(CaptionLanguageMappingProperty.builder()
                 .captionChannel(123)
                 .languageCode("languageCode")
                 .languageDescription("languageDescription")
                 .build()))
         .captionLanguageSetting("captionLanguageSetting")
         .clientCache("clientCache")
         .codecSpecification("codecSpecification")
         .constantIv("constantIv")
         .destination(OutputLocationRefProperty.builder()
                 .destinationRefId("destinationRefId")
                 .build())
         .directoryStructure("directoryStructure")
         .discontinuityTags("discontinuityTags")
         .encryptionType("encryptionType")
         .hlsCdnSettings(HlsCdnSettingsProperty.builder()
                 .hlsAkamaiSettings(HlsAkamaiSettingsProperty.builder()
                         .connectionRetryInterval(123)
                         .filecacheDuration(123)
                         .httpTransferMode("httpTransferMode")
                         .numRetries(123)
                         .restartDelay(123)
                         .salt("salt")
                         .token("token")
                         .build())
                 .hlsBasicPutSettings(HlsBasicPutSettingsProperty.builder()
                         .connectionRetryInterval(123)
                         .filecacheDuration(123)
                         .numRetries(123)
                         .restartDelay(123)
                         .build())
                 .hlsMediaStoreSettings(HlsMediaStoreSettingsProperty.builder()
                         .connectionRetryInterval(123)
                         .filecacheDuration(123)
                         .mediaStoreStorageClass("mediaStoreStorageClass")
                         .numRetries(123)
                         .restartDelay(123)
                         .build())
                 .hlsS3Settings(HlsS3SettingsProperty.builder()
                         .cannedAcl("cannedAcl")
                         .build())
                 .hlsWebdavSettings(HlsWebdavSettingsProperty.builder()
                         .connectionRetryInterval(123)
                         .filecacheDuration(123)
                         .httpTransferMode("httpTransferMode")
                         .numRetries(123)
                         .restartDelay(123)
                         .build())
                 .build())
         .hlsId3SegmentTagging("hlsId3SegmentTagging")
         .iFrameOnlyPlaylists("iFrameOnlyPlaylists")
         .incompleteSegmentBehavior("incompleteSegmentBehavior")
         .indexNSegments(123)
         .inputLossAction("inputLossAction")
         .ivInManifest("ivInManifest")
         .ivSource("ivSource")
         .keepSegments(123)
         .keyFormat("keyFormat")
         .keyFormatVersions("keyFormatVersions")
         .keyProviderSettings(KeyProviderSettingsProperty.builder()
                 .staticKeySettings(StaticKeySettingsProperty.builder()
                         .keyProviderServer(InputLocationProperty.builder()
                                 .passwordParam("passwordParam")
                                 .uri("uri")
                                 .username("username")
                                 .build())
                         .staticKeyValue("staticKeyValue")
                         .build())
                 .build())
         .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")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnChannel.HlsGroupSettingsProperty.Builder A builder for CfnChannel.HlsGroupSettingsProperty
static class	CfnChannel.HlsGroupSettingsProperty.Jsii$Proxy An implementation for CfnChannel.HlsGroupSettingsProperty

Method Summary

Modifier and Type	Method and Description
static CfnChannel.HlsGroupSettingsProperty.Builder	builder()
default List<String>	getAdMarkers() Chooses one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
default String	getBaseUrlContent() A partial URI prefix that will be prepended to each output in the media .m3u8 file.
default String	getBaseUrlContent1() Optional.
default String	getBaseUrlManifest() A partial URI prefix that will be prepended to each output in the media .m3u8 file.
default String	getBaseUrlManifest1() Optional.
default Object	getCaptionLanguageMappings() A mapping of up to 4 captions channels to captions languages.
default String	getCaptionLanguageSetting() Applies only to 608 embedded output captions.
default String	getClientCache() 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.
default String	getCodecSpecification() The specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
default String	getConstantIv() Used with encryptionType.
default Object	getDestination() A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
default String	getDirectoryStructure() Places segments in subdirectories.
default String	getDiscontinuityTags() Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.
default String	getEncryptionType() Encrypts the segments with the specified encryption scheme.
default Object	getHlsCdnSettings() The parameters that control interactions with the CDN.
default String	getHlsId3SegmentTagging() State of HLS ID3 Segment Tagging.
default String	getIFrameOnlyPlaylists() DISABLED: Don't create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).
default String	getIncompleteSegmentBehavior() 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.
default Number	getIndexNSegments() Applies only if the Mode field is LIVE.
default String	getInputLossAction() A parameter that controls output group behavior on an input loss.
default String	getIvInManifest() Used with encryptionType.
default String	getIvSource() Used with encryptionType.
default Number	getKeepSegments() Applies only if the Mode field is LIVE.
default String	getKeyFormat() Specifies how the key is represented in the resource identified by the URI.
default String	getKeyFormatVersions() Either a single positive integer version value or a slash-delimited list of version values (1/2/3).
default Object	getKeyProviderSettings() The key provider settings.
default String	getManifestCompression() When set to gzip, compresses HLS playlist.
default String	getManifestDurationFormat() Indicates whether the output manifest should use a floating point or integer values for segment duration.
default Number	getMinSegmentLength() 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.
default String	getMode() If "vod," all segments are indexed and kept permanently in the destination and manifest.
default String	getOutputSelection() MANIFESTSANDSEGMENTS: Generates manifests (the master manifest, if applicable, and media manifests) for this output group.
default String	getProgramDateTime() Includes or excludes the EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
default String	getProgramDateTimeClock() Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock.
default Number	getProgramDateTimePeriod() The period of insertion of the EXT-X-PROGRAM-DATE-TIME entry, in seconds.
default String	getRedundantManifest() 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.
default String	getSegmentationMode() useInputSegmentation has been deprecated.
default Number	getSegmentLength() The length of the MPEG-2 Transport Stream segments to create, in seconds.
default Number	getSegmentsPerSubdirectory() The number of segments to write to a subdirectory before starting a new one.
default String	getStreamInfResolution() The include or exclude RESOLUTION attribute for a video in the EXT-X-STREAM-INF tag of a variant manifest.
default String	getTimedMetadataId3Frame() Indicates the ID3 frame that has the timecode.
default Number	getTimedMetadataId3Period() The timed metadata interval, in seconds.
default Number	getTimestampDeltaMilliseconds() Provides an extra millisecond delta offset to fine tune the timestamps.
default String	getTsFileMode() SEGMENTEDFILES: Emits the program as segments -multiple .ts media files.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdMarkers

@Stability(value=Stable)
 @Nullable
default List<String> getAdMarkers()

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

getBaseUrlContent

@Stability(value=Stable)
 @Nullable
default String getBaseUrlContent()

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.

getBaseUrlContent1

@Stability(value=Stable)
 @Nullable
default String getBaseUrlContent1()

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.

getBaseUrlManifest

@Stability(value=Stable)
 @Nullable
default String getBaseUrlManifest()

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.

getBaseUrlManifest1

@Stability(value=Stable)
 @Nullable
default String getBaseUrlManifest1()

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.

getCaptionLanguageMappings

@Stability(value=Stable)
 @Nullable
default Object getCaptionLanguageMappings()

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

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

getCaptionLanguageSetting

@Stability(value=Stable)
 @Nullable
default String getCaptionLanguageSetting()

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.

getClientCache

@Stability(value=Stable)
 @Nullable
default String getClientCache()

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.

getCodecSpecification

@Stability(value=Stable)
 @Nullable
default String getCodecSpecification()

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

getConstantIv

@Stability(value=Stable)
 @Nullable
default String getConstantIv()

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.

getDestination

@Stability(value=Stable)
 @Nullable
default Object getDestination()

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

getDirectoryStructure

@Stability(value=Stable)
 @Nullable
default String getDirectoryStructure()

Places segments in subdirectories.

getDiscontinuityTags

@Stability(value=Stable)
 @Nullable
default String getDiscontinuityTags()

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.

getEncryptionType

@Stability(value=Stable)
 @Nullable
default String getEncryptionType()

Encrypts the segments with the specified encryption scheme.

Exclude this parameter if you don't want encryption.

getHlsCdnSettings

@Stability(value=Stable)
 @Nullable
default Object getHlsCdnSettings()

The parameters that control interactions with the CDN.

getHlsId3SegmentTagging

@Stability(value=Stable)
 @Nullable
default String getHlsId3SegmentTagging()

State of HLS ID3 Segment Tagging.

getIFrameOnlyPlaylists

@Stability(value=Stable)
 @Nullable
default String getIFrameOnlyPlaylists()

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

getIncompleteSegmentBehavior

@Stability(value=Stable)
 @Nullable
default String getIncompleteSegmentBehavior()

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.

getIndexNSegments

@Stability(value=Stable)
 @Nullable
default Number getIndexNSegments()

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.

getInputLossAction

@Stability(value=Stable)
 @Nullable
default String getInputLossAction()

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

getIvInManifest

@Stability(value=Stable)
 @Nullable
default String getIvInManifest()

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.

getIvSource

@Stability(value=Stable)
 @Nullable
default String getIvSource()

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.

getKeepSegments

@Stability(value=Stable)
 @Nullable
default Number getKeepSegments()

Applies only if the Mode field is LIVE.

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

getKeyFormat

@Stability(value=Stable)
 @Nullable
default String getKeyFormat()

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.

getKeyFormatVersions

@Stability(value=Stable)
 @Nullable
default String getKeyFormatVersions()

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

getKeyProviderSettings

@Stability(value=Stable)
 @Nullable
default Object getKeyProviderSettings()

The key provider settings.

getManifestCompression

@Stability(value=Stable)
 @Nullable
default String getManifestCompression()

When set to gzip, compresses HLS playlist.

getManifestDurationFormat

@Stability(value=Stable)
 @Nullable
default String getManifestDurationFormat()

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

getMinSegmentLength

@Stability(value=Stable)
 @Nullable
default Number getMinSegmentLength()

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.

getMode

@Stability(value=Stable)
 @Nullable
default String getMode()

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.

getOutputSelection

@Stability(value=Stable)
 @Nullable
default String getOutputSelection()

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.

getProgramDateTime

@Stability(value=Stable)
 @Nullable
default String getProgramDateTime()

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.

getProgramDateTimeClock

@Stability(value=Stable)
 @Nullable
default String getProgramDateTimeClock()

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

Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock.

getProgramDateTimePeriod

@Stability(value=Stable)
 @Nullable
default Number getProgramDateTimePeriod()

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

getRedundantManifest

@Stability(value=Stable)
 @Nullable
default String getRedundantManifest()

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.

getSegmentationMode

@Stability(value=Stable)
 @Nullable
default String getSegmentationMode()

useInputSegmentation has been deprecated.

The configured segment size is always used.

getSegmentLength

@Stability(value=Stable)
 @Nullable
default Number getSegmentLength()

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.

getSegmentsPerSubdirectory

@Stability(value=Stable)
 @Nullable
default Number getSegmentsPerSubdirectory()

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.

getStreamInfResolution

@Stability(value=Stable)
 @Nullable
default String getStreamInfResolution()

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

getTimedMetadataId3Frame

@Stability(value=Stable)
 @Nullable
default String getTimedMetadataId3Frame()

Indicates the ID3 frame that has the timecode.

getTimedMetadataId3Period

@Stability(value=Stable)
 @Nullable
default Number getTimedMetadataId3Period()

The timed metadata interval, in seconds.

getTimestampDeltaMilliseconds

@Stability(value=Stable)
 @Nullable
default Number getTimestampDeltaMilliseconds()

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

getTsFileMode

@Stability(value=Stable)
 @Nullable
default String getTsFileMode()

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.

builder

@Stability(value=Stable)
static CfnChannel.HlsGroupSettingsProperty.Builder builder()

Returns:

a CfnChannel.HlsGroupSettingsProperty.Builder of CfnChannel.HlsGroupSettingsProperty