Package software.amazon.awssdk.services.medialive.model

Class HlsGroupSettings

    • Method Detail

      • adMarkers

        public final List<HlsAdMarkers> adMarkers()
        Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdMarkers() method.

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

      • hasAdMarkers

        public final boolean hasAdMarkers()
        For responses, this returns true if the service returned a value for the AdMarkers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • adMarkersAsStrings

        public final List<String> adMarkersAsStrings()
        Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdMarkers() method.

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

      • baseUrlContent

        public final String 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.
        Returns:
        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.

      • baseUrlContent1

        public final String 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.
        Returns:
        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

        public final String 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.
        Returns:
        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.

      • baseUrlManifest1

        public final String 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.
        Returns:
        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.

      • hasCaptionLanguageMappings

        public final boolean hasCaptionLanguageMappings()
        For responses, this returns true if the service returned a value for the CaptionLanguageMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • captionLanguageMappings

        public final List<CaptionLanguageMapping> captionLanguageMappings()
        Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCaptionLanguageMappings() method.

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

      • captionLanguageSetting

        public final HlsCaptionLanguageSetting 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.

        If the service returns an enum value that is not available in the current SDK version, captionLanguageSetting will return HlsCaptionLanguageSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from captionLanguageSettingAsString().

        Returns:
        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.
        See Also:
        HlsCaptionLanguageSetting

      • captionLanguageSettingAsString

        public final String captionLanguageSettingAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, captionLanguageSetting will return HlsCaptionLanguageSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from captionLanguageSettingAsString().

        Returns:
        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.
        See Also:
        HlsCaptionLanguageSetting

      • clientCache

        public final HlsClientCache 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.

        If the service returns an enum value that is not available in the current SDK version, clientCache will return HlsClientCache.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clientCacheAsString().

        Returns:
        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.
        See Also:
        HlsClientCache

      • clientCacheAsString

        public final String clientCacheAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, clientCache will return HlsClientCache.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clientCacheAsString().

        Returns:
        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.
        See Also:
        HlsClientCache

      • codecSpecificationAsString

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

        If the service returns an enum value that is not available in the current SDK version, codecSpecification will return HlsCodecSpecification.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codecSpecificationAsString().

        Returns:
        Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
        See Also:
        HlsCodecSpecification

      • constantIv

        public final String 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.
        Returns:
        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.

      • destination

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

      • discontinuityTags

        public final HlsDiscontinuityTags 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.

        If the service returns an enum value that is not available in the current SDK version, discontinuityTags will return HlsDiscontinuityTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from discontinuityTagsAsString().

        Returns:
        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.
        See Also:
        HlsDiscontinuityTags

      • discontinuityTagsAsString

        public final String discontinuityTagsAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, discontinuityTags will return HlsDiscontinuityTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from discontinuityTagsAsString().

        Returns:
        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.
        See Also:
        HlsDiscontinuityTags

      • encryptionType

        public final HlsEncryptionType encryptionType()
        Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.

        If the service returns an enum value that is not available in the current SDK version, encryptionType will return HlsEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionTypeAsString().

        Returns:
        Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
        See Also:
        HlsEncryptionType

      • encryptionTypeAsString

        public final String encryptionTypeAsString()
        Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.

        If the service returns an enum value that is not available in the current SDK version, encryptionType will return HlsEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionTypeAsString().

        Returns:
        Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
        See Also:
        HlsEncryptionType

      • hlsCdnSettings

        public final HlsCdnSettings hlsCdnSettings()
        Parameters that control interactions with the CDN.
        Returns:
        Parameters that control interactions with the CDN.

      • iFrameOnlyPlaylists

        public final IFrameOnlyPlaylistType 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"

        If the service returns an enum value that is not available in the current SDK version, iFrameOnlyPlaylists will return IFrameOnlyPlaylistType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from iFrameOnlyPlaylistsAsString().

        Returns:
        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"
        See Also:
        IFrameOnlyPlaylistType

      • iFrameOnlyPlaylistsAsString

        public final String iFrameOnlyPlaylistsAsString()
        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"

        If the service returns an enum value that is not available in the current SDK version, iFrameOnlyPlaylists will return IFrameOnlyPlaylistType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from iFrameOnlyPlaylistsAsString().

        Returns:
        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"
        See Also:
        IFrameOnlyPlaylistType

      • incompleteSegmentBehavior

        public final HlsIncompleteSegmentBehavior 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.

        If the service returns an enum value that is not available in the current SDK version, incompleteSegmentBehavior will return HlsIncompleteSegmentBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from incompleteSegmentBehaviorAsString().

        Returns:
        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.
        See Also:
        HlsIncompleteSegmentBehavior

      • incompleteSegmentBehaviorAsString

        public final String incompleteSegmentBehaviorAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, incompleteSegmentBehavior will return HlsIncompleteSegmentBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from incompleteSegmentBehaviorAsString().

        Returns:
        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.
        See Also:
        HlsIncompleteSegmentBehavior

      • indexNSegments

        public final Integer 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.
        Returns:
        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.

      • ivInManifest

        public final HlsIvInManifest 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.

        If the service returns an enum value that is not available in the current SDK version, ivInManifest will return HlsIvInManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ivInManifestAsString().

        Returns:
        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.
        See Also:
        HlsIvInManifest

      • ivInManifestAsString

        public final String ivInManifestAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, ivInManifest will return HlsIvInManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ivInManifestAsString().

        Returns:
        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.
        See Also:
        HlsIvInManifest

      • ivSource

        public final HlsIvSource 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.

        If the service returns an enum value that is not available in the current SDK version, ivSource will return HlsIvSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ivSourceAsString().

        Returns:
        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.
        See Also:
        HlsIvSource

      • ivSourceAsString

        public final String ivSourceAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, ivSource will return HlsIvSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ivSourceAsString().

        Returns:
        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.
        See Also:
        HlsIvSource

      • keepSegments

        public final Integer 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.
        Returns:
        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.

      • keyFormat

        public final String 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.
        Returns:
        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.

      • keyFormatVersions

        public final String keyFormatVersions()
        Either a single positive integer version value or a slash delimited list of version values (1/2/3).
        Returns:
        Either a single positive integer version value or a slash delimited list of version values (1/2/3).

      • keyProviderSettings

        public final KeyProviderSettings keyProviderSettings()
        The key provider settings.
        Returns:
        The key provider settings.

      • manifestDurationFormatAsString

        public final String manifestDurationFormatAsString()
        Indicates whether the output manifest should use floating point or integer values for segment duration.

        If the service returns an enum value that is not available in the current SDK version, manifestDurationFormat will return HlsManifestDurationFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from manifestDurationFormatAsString().

        Returns:
        Indicates whether the output manifest should use floating point or integer values for segment duration.
        See Also:
        HlsManifestDurationFormat

      • minSegmentLength

        public final Integer minSegmentLength()
        Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum segment length is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
        Returns:
        Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum segment length is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

      • mode

        public final HlsMode 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.

        If the service returns an enum value that is not available in the current SDK version, mode will return HlsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

        Returns:
        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.
        See Also:
        HlsMode

      • modeAsString

        public final String modeAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, mode will return HlsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

        Returns:
        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.
        See Also:
        HlsMode

      • outputSelection

        public final HlsOutputSelection 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.

        If the service returns an enum value that is not available in the current SDK version, outputSelection will return HlsOutputSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputSelectionAsString().

        Returns:
        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.
        See Also:
        HlsOutputSelection

      • outputSelectionAsString

        public final String outputSelectionAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, outputSelection will return HlsOutputSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputSelectionAsString().

        Returns:
        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.
        See Also:
        HlsOutputSelection

      • programDateTime

        public final HlsProgramDateTime programDateTime()
        Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.

        If the service returns an enum value that is not available in the current SDK version, programDateTime will return HlsProgramDateTime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from programDateTimeAsString().

        Returns:
        Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.
        See Also:
        HlsProgramDateTime

      • programDateTimeAsString

        public final String programDateTimeAsString()
        Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.

        If the service returns an enum value that is not available in the current SDK version, programDateTime will return HlsProgramDateTime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from programDateTimeAsString().

        Returns:
        Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.
        See Also:
        HlsProgramDateTime

      • programDateTimeClock

        public final HlsProgramDateTimeClock programDateTimeClock()
        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.

        If the service returns an enum value that is not available in the current SDK version, programDateTimeClock will return HlsProgramDateTimeClock.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from programDateTimeClockAsString().

        Returns:
        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.
        See Also:
        HlsProgramDateTimeClock

      • programDateTimeClockAsString

        public final String programDateTimeClockAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, programDateTimeClock will return HlsProgramDateTimeClock.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from programDateTimeClockAsString().

        Returns:
        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.
        See Also:
        HlsProgramDateTimeClock

      • programDateTimePeriod

        public final Integer programDateTimePeriod()
        Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
        Returns:
        Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

      • redundantManifest

        public final HlsRedundantManifest 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.

        If the service returns an enum value that is not available in the current SDK version, redundantManifest will return HlsRedundantManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redundantManifestAsString().

        Returns:
        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.
        See Also:
        HlsRedundantManifest

      • redundantManifestAsString

        public final String redundantManifestAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, redundantManifest will return HlsRedundantManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redundantManifestAsString().

        Returns:
        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.
        See Also:
        HlsRedundantManifest

      • segmentLength

        public final Integer segmentLength()
        Length of MPEG-2 Transport Stream segments to create in seconds. Note that segments will end on the next keyframe after this duration, so actual segment length may be longer.
        Returns:
        Length of MPEG-2 Transport Stream segments to create in seconds. Note that segments will end on the next keyframe after this duration, so actual segment length may be longer.

      • segmentationModeAsString

        public final String segmentationModeAsString()
        useInputSegmentation has been deprecated. The configured segment size is always used.

        If the service returns an enum value that is not available in the current SDK version, segmentationMode will return HlsSegmentationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from segmentationModeAsString().

        Returns:
        useInputSegmentation has been deprecated. The configured segment size is always used.
        See Also:
        HlsSegmentationMode

      • segmentsPerSubdirectory

        public final Integer 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.
        Returns:
        Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.

      • streamInfResolutionAsString

        public final String streamInfResolutionAsString()
        Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

        If the service returns an enum value that is not available in the current SDK version, streamInfResolution will return HlsStreamInfResolution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamInfResolutionAsString().

        Returns:
        Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
        See Also:
        HlsStreamInfResolution

      • timedMetadataId3Period

        public final Integer timedMetadataId3Period()
        Timed Metadata interval in seconds.
        Returns:
        Timed Metadata interval in seconds.

      • timestampDeltaMilliseconds

        public final Integer timestampDeltaMilliseconds()
        Provides an extra millisecond delta offset to fine tune the timestamps.
        Returns:
        Provides an extra millisecond delta offset to fine tune the timestamps.

      • tsFileMode

        public final HlsTsFileMode 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.

        If the service returns an enum value that is not available in the current SDK version, tsFileMode will return HlsTsFileMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tsFileModeAsString().

        Returns:
        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.
        See Also:
        HlsTsFileMode

      • tsFileModeAsString

        public final String tsFileModeAsString()
        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.

        If the service returns an enum value that is not available in the current SDK version, tsFileMode will return HlsTsFileMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tsFileModeAsString().

        Returns:
        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.
        See Also:
        HlsTsFileMode

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)