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

Interface HlsGroupSettings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>, SdkBuilder<HlsGroupSettings.Builder,HlsGroupSettings>, SdkPojo
Enclosing class:
HlsGroupSettings
public static interface HlsGroupSettings.Builder extends SdkPojo, CopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>

  • Method Details

    • adMarkersWithStrings

      HlsGroupSettings.Builder adMarkersWithStrings(Collection<String> adMarkers)
      Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
      Parameters:
      adMarkers - Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adMarkersWithStrings

      HlsGroupSettings.Builder adMarkersWithStrings(String... adMarkers)
      Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
      Parameters:
      adMarkers - Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adMarkers

      HlsGroupSettings.Builder adMarkers(Collection<HlsAdMarkers> adMarkers)
      Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
      Parameters:
      adMarkers - Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adMarkers

      HlsGroupSettings.Builder adMarkers(HlsAdMarkers... adMarkers)
      Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
      Parameters:
      adMarkers - Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • baseUrlContent

      HlsGroupSettings.Builder baseUrlContent(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • baseUrlContent1

      HlsGroupSettings.Builder baseUrlContent1(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • baseUrlManifest

      HlsGroupSettings.Builder baseUrlManifest(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • baseUrlManifest1

      HlsGroupSettings.Builder baseUrlManifest1(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • captionLanguageMappings

      HlsGroupSettings.Builder captionLanguageMappings(Collection<CaptionLanguageMapping> captionLanguageMappings)
      Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
      Parameters:
      captionLanguageMappings - Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • captionLanguageMappings

      HlsGroupSettings.Builder captionLanguageMappings(CaptionLanguageMapping... captionLanguageMappings)
      Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
      Parameters:
      captionLanguageMappings - Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • captionLanguageMappings

      HlsGroupSettings.Builder captionLanguageMappings(Consumer<CaptionLanguageMapping.Builder>... captionLanguageMappings)
      Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert". This is a convenience method that creates an instance of the CaptionLanguageMapping.Builder avoiding the need to create one manually via CaptionLanguageMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to captionLanguageMappings(List<CaptionLanguageMapping>).

      Parameters:
      captionLanguageMappings - a consumer that will call methods on CaptionLanguageMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • captionLanguageSetting

      HlsGroupSettings.Builder captionLanguageSetting(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • captionLanguageSetting

      HlsGroupSettings.Builder captionLanguageSetting(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientCache

      HlsGroupSettings.Builder clientCache(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientCache

      HlsGroupSettings.Builder clientCache(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • codecSpecification

      HlsGroupSettings.Builder codecSpecification(String codecSpecification)
      Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
      Parameters:
      codecSpecification - Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • codecSpecification

      HlsGroupSettings.Builder codecSpecification(HlsCodecSpecification codecSpecification)
      Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
      Parameters:
      codecSpecification - Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • constantIv

      HlsGroupSettings.Builder constantIv(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      HlsGroupSettings.Builder destination(OutputLocationRef destination)
      A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
      Parameters:
      destination - A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      default HlsGroupSettings.Builder destination(Consumer<OutputLocationRef.Builder> destination)
      A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled). This is a convenience method that creates an instance of the OutputLocationRef.Builder avoiding the need to create one manually via OutputLocationRef.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destination(OutputLocationRef).

      Parameters:
      destination - a consumer that will call methods on OutputLocationRef.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • directoryStructure

      HlsGroupSettings.Builder directoryStructure(String directoryStructure)
      Place segments in subdirectories.
      Parameters:
      directoryStructure - Place segments in subdirectories.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • directoryStructure

      HlsGroupSettings.Builder directoryStructure(HlsDirectoryStructure directoryStructure)
      Place segments in subdirectories.
      Parameters:
      directoryStructure - Place segments in subdirectories.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • discontinuityTags

      HlsGroupSettings.Builder discontinuityTags(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • discontinuityTags

      HlsGroupSettings.Builder discontinuityTags(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryptionType

      HlsGroupSettings.Builder encryptionType(String encryptionType)
      Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
      Parameters:
      encryptionType - Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryptionType

      HlsGroupSettings.Builder encryptionType(HlsEncryptionType encryptionType)
      Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
      Parameters:
      encryptionType - Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hlsCdnSettings

      HlsGroupSettings.Builder hlsCdnSettings(HlsCdnSettings hlsCdnSettings)
      Parameters that control interactions with the CDN.
      Parameters:
      hlsCdnSettings - Parameters that control interactions with the CDN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hlsCdnSettings

      default HlsGroupSettings.Builder hlsCdnSettings(Consumer<HlsCdnSettings.Builder> hlsCdnSettings)
      Parameters that control interactions with the CDN. This is a convenience method that creates an instance of the HlsCdnSettings.Builder avoiding the need to create one manually via HlsCdnSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hlsCdnSettings(HlsCdnSettings).

      Parameters:
      hlsCdnSettings - a consumer that will call methods on HlsCdnSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hlsId3SegmentTagging

      HlsGroupSettings.Builder hlsId3SegmentTagging(String hlsId3SegmentTagging)
      State of HLS ID3 Segment Tagging
      Parameters:
      hlsId3SegmentTagging - State of HLS ID3 Segment Tagging
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hlsId3SegmentTagging

      HlsGroupSettings.Builder hlsId3SegmentTagging(HlsId3SegmentTaggingState hlsId3SegmentTagging)
      State of HLS ID3 Segment Tagging
      Parameters:
      hlsId3SegmentTagging - State of HLS ID3 Segment Tagging
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • iFrameOnlyPlaylists

      HlsGroupSettings.Builder iFrameOnlyPlaylists(String 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"
      Parameters:
      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"
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • iFrameOnlyPlaylists

      HlsGroupSettings.Builder iFrameOnlyPlaylists(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"
      Parameters:
      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"
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • incompleteSegmentBehavior

      HlsGroupSettings.Builder incompleteSegmentBehavior(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • incompleteSegmentBehavior

      HlsGroupSettings.Builder incompleteSegmentBehavior(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • indexNSegments

      HlsGroupSettings.Builder indexNSegments(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • inputLossAction

      HlsGroupSettings.Builder inputLossAction(String inputLossAction)
      Parameter that control output group behavior on input loss.
      Parameters:
      inputLossAction - Parameter that control output group behavior on input loss.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inputLossAction

      HlsGroupSettings.Builder inputLossAction(InputLossActionForHlsOut inputLossAction)
      Parameter that control output group behavior on input loss.
      Parameters:
      inputLossAction - Parameter that control output group behavior on input loss.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ivInManifest

      HlsGroupSettings.Builder ivInManifest(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ivInManifest

      HlsGroupSettings.Builder ivInManifest(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ivSource

      HlsGroupSettings.Builder ivSource(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ivSource

      HlsGroupSettings.Builder ivSource(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • keepSegments

      HlsGroupSettings.Builder keepSegments(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • keyFormat

      HlsGroupSettings.Builder keyFormat(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • keyFormatVersions

      HlsGroupSettings.Builder keyFormatVersions(String keyFormatVersions)
      Either a single positive integer version value or a slash delimited list of version values (1/2/3).
      Parameters:
      keyFormatVersions - Either a single positive integer version value or a slash delimited list of version values (1/2/3).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keyProviderSettings

      HlsGroupSettings.Builder keyProviderSettings(KeyProviderSettings keyProviderSettings)
      The key provider settings.
      Parameters:
      keyProviderSettings - The key provider settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keyProviderSettings

      default HlsGroupSettings.Builder keyProviderSettings(Consumer<KeyProviderSettings.Builder> keyProviderSettings)
      The key provider settings. This is a convenience method that creates an instance of the KeyProviderSettings.Builder avoiding the need to create one manually via KeyProviderSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to keyProviderSettings(KeyProviderSettings).

      Parameters:
      keyProviderSettings - a consumer that will call methods on KeyProviderSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • manifestCompression

      HlsGroupSettings.Builder manifestCompression(String manifestCompression)
      When set to gzip, compresses HLS playlist.
      Parameters:
      manifestCompression - When set to gzip, compresses HLS playlist.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • manifestCompression

      HlsGroupSettings.Builder manifestCompression(HlsManifestCompression manifestCompression)
      When set to gzip, compresses HLS playlist.
      Parameters:
      manifestCompression - When set to gzip, compresses HLS playlist.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • manifestDurationFormat

      HlsGroupSettings.Builder manifestDurationFormat(String manifestDurationFormat)
      Indicates whether the output manifest should use floating point or integer values for segment duration.
      Parameters:
      manifestDurationFormat - Indicates whether the output manifest should use floating point or integer values for segment duration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • manifestDurationFormat

      HlsGroupSettings.Builder manifestDurationFormat(HlsManifestDurationFormat manifestDurationFormat)
      Indicates whether the output manifest should use floating point or integer values for segment duration.
      Parameters:
      manifestDurationFormat - Indicates whether the output manifest should use floating point or integer values for segment duration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • minSegmentLength

      HlsGroupSettings.Builder minSegmentLength(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • mode

      HlsGroupSettings.Builder mode(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      HlsGroupSettings.Builder mode(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputSelection

      HlsGroupSettings.Builder outputSelection(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputSelection

      HlsGroupSettings.Builder outputSelection(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • programDateTime

      HlsGroupSettings.Builder programDateTime(String programDateTime)
      Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.
      Parameters:
      programDateTime - Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • programDateTime

      HlsGroupSettings.Builder programDateTime(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.
      Parameters:
      programDateTime - Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • programDateTimeClock

      HlsGroupSettings.Builder programDateTimeClock(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • programDateTimeClock

      HlsGroupSettings.Builder programDateTimeClock(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • programDateTimePeriod

      HlsGroupSettings.Builder programDateTimePeriod(Integer programDateTimePeriod)
      Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
      Parameters:
      programDateTimePeriod - Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • redundantManifest

      HlsGroupSettings.Builder redundantManifest(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • redundantManifest

      HlsGroupSettings.Builder redundantManifest(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • segmentLength

      HlsGroupSettings.Builder segmentLength(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • segmentationMode

      HlsGroupSettings.Builder segmentationMode(String segmentationMode)
      useInputSegmentation has been deprecated. The configured segment size is always used.
      Parameters:
      segmentationMode - useInputSegmentation has been deprecated. The configured segment size is always used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • segmentationMode

      HlsGroupSettings.Builder segmentationMode(HlsSegmentationMode segmentationMode)
      useInputSegmentation has been deprecated. The configured segment size is always used.
      Parameters:
      segmentationMode - useInputSegmentation has been deprecated. The configured segment size is always used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • segmentsPerSubdirectory

      HlsGroupSettings.Builder segmentsPerSubdirectory(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • streamInfResolution

      HlsGroupSettings.Builder streamInfResolution(String streamInfResolution)
      Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
      Parameters:
      streamInfResolution - Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamInfResolution

      HlsGroupSettings.Builder streamInfResolution(HlsStreamInfResolution streamInfResolution)
      Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
      Parameters:
      streamInfResolution - Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timedMetadataId3Frame

      HlsGroupSettings.Builder timedMetadataId3Frame(String timedMetadataId3Frame)
      Indicates ID3 frame that has the timecode.
      Parameters:
      timedMetadataId3Frame - Indicates ID3 frame that has the timecode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timedMetadataId3Frame

      HlsGroupSettings.Builder timedMetadataId3Frame(HlsTimedMetadataId3Frame timedMetadataId3Frame)
      Indicates ID3 frame that has the timecode.
      Parameters:
      timedMetadataId3Frame - Indicates ID3 frame that has the timecode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timedMetadataId3Period

      HlsGroupSettings.Builder timedMetadataId3Period(Integer timedMetadataId3Period)
      Timed Metadata interval in seconds.
      Parameters:
      timedMetadataId3Period - Timed Metadata interval in seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timestampDeltaMilliseconds

      HlsGroupSettings.Builder timestampDeltaMilliseconds(Integer timestampDeltaMilliseconds)
      Provides an extra millisecond delta offset to fine tune the timestamps.
      Parameters:
      timestampDeltaMilliseconds - Provides an extra millisecond delta offset to fine tune the timestamps.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tsFileMode

      HlsGroupSettings.Builder tsFileMode(String 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tsFileMode

      HlsGroupSettings.Builder tsFileMode(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: