Package software.amazon.awssdk.services.mediaconvert.model

Class HlsGroupSettings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.HlsGroupSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>
@Generated("software.amazon.awssdk:codegen") public final class HlsGroupSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>
Settings related to your HLS output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html.
See Also:

  • Method Details

    • adMarkers

      public final List<HlsAdMarkers> adMarkers()
      Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

      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 decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

    • 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 decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

      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 decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.

    • hasAdditionalManifests

      public final boolean hasAdditionalManifests()
      For responses, this returns true if the service returned a value for the AdditionalManifests 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.

    • additionalManifests

      public final List<HlsAdditionalManifest> additionalManifests()
      By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

      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 hasAdditionalManifests() method.

      Returns:
      By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.

    • audioOnlyHeader

      public final HlsAudioOnlyHeader audioOnlyHeader()
      Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include, to output audio-only headers. Choose Exclude to remove the audio-only headers from your audio segments.

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

      Returns:
      Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include, to output audio-only headers. Choose Exclude to remove the audio-only headers from your audio segments.
      See Also:

    • audioOnlyHeaderAsString

      public final String audioOnlyHeaderAsString()
      Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include, to output audio-only headers. Choose Exclude to remove the audio-only headers from your audio segments.

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

      Returns:
      Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include, to output audio-only headers. Choose Exclude to remove the audio-only headers from your audio segments.
      See Also:

    • baseUrl

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

    • 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<HlsCaptionLanguageMapping> captionLanguageMappings()
      Language to be used on Caption 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 hasCaptionLanguageMappings() method.

      Returns:
      Language to be used on Caption outputs

    • 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:

    • 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:

    • captionSegmentLengthControl

      public final HlsCaptionSegmentLengthControl captionSegmentLengthControl()
      Set Caption segment length control to Match video to create caption segments that align with the video segments from the first video output in this output group. For example, if the video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments to create caption segments that are 300 seconds long.

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

      Returns:
      Set Caption segment length control to Match video to create caption segments that align with the video segments from the first video output in this output group. For example, if the video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments to create caption segments that are 300 seconds long.
      See Also:

    • captionSegmentLengthControlAsString

      public final String captionSegmentLengthControlAsString()
      Set Caption segment length control to Match video to create caption segments that align with the video segments from the first video output in this output group. For example, if the video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments to create caption segments that are 300 seconds long.

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

      Returns:
      Set Caption segment length control to Match video to create caption segments that align with the video segments from the first video output in this output group. For example, if the video segments are 2 seconds long, your WebVTT segments will also be 2 seconds long. Keep the default setting, Large segments to create caption segments that are 300 seconds long.
      See Also:

    • clientCache

      public final HlsClientCache clientCache()
      Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled and control caching in your video distribution set up. For example, use the Cache-Control http header.

      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:
      Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled and control caching in your video distribution set up. For example, use the Cache-Control http header.
      See Also:

    • clientCacheAsString

      public final String clientCacheAsString()
      Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled and control caching in your video distribution set up. For example, use the Cache-Control http header.

      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:
      Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled and control caching in your video distribution set up. For example, use the Cache-Control http header.
      See Also:

    • codecSpecification

      public final HlsCodecSpecification codecSpecification()
      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:

    • 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:

    • destination

      public final String destination()
      Use Destination to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.
      Returns:
      Use Destination to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

    • destinationSettings

      public final DestinationSettings destinationSettings()
      Settings associated with the destination. Will vary based on the type of destination
      Returns:
      Settings associated with the destination. Will vary based on the type of destination

    • directoryStructure

      public final HlsDirectoryStructure directoryStructure()
      Indicates whether segments should be placed in subdirectories.

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

      Returns:
      Indicates whether segments should be placed in subdirectories.
      See Also:

    • directoryStructureAsString

      public final String directoryStructureAsString()
      Indicates whether segments should be placed in subdirectories.

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

      Returns:
      Indicates whether segments should be placed in subdirectories.
      See Also:

    • encryption

      public final HlsEncryptionSettings encryption()
      DRM settings.
      Returns:
      DRM settings.

    • imageBasedTrickPlay

      public final HlsImageBasedTrickPlay imageBasedTrickPlay()
      Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md

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

      Returns:
      Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md
      See Also:

    • imageBasedTrickPlayAsString

      public final String imageBasedTrickPlayAsString()
      Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md

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

      Returns:
      Specify whether MediaConvert generates images for trick play. Keep the default value, None, to not generate any images. Choose Thumbnail to generate tiled thumbnails. Choose Thumbnail and full frame to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md
      See Also:

    • imageBasedTrickPlaySettings

      public final HlsImageBasedTrickPlaySettings imageBasedTrickPlaySettings()
      Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
      Returns:
      Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

    • manifestCompression

      public final HlsManifestCompression manifestCompression()
      When set to GZIP, compresses HLS playlist.

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

      Returns:
      When set to GZIP, compresses HLS playlist.
      See Also:

    • manifestCompressionAsString

      public final String manifestCompressionAsString()
      When set to GZIP, compresses HLS playlist.

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

      Returns:
      When set to GZIP, compresses HLS playlist.
      See Also:

    • manifestDurationFormat

      public final HlsManifestDurationFormat manifestDurationFormat()
      Indicates whether the output manifest should use floating point 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 values for segment duration.
      See Also:

    • manifestDurationFormatAsString

      public final String manifestDurationFormatAsString()
      Indicates whether the output manifest should use floating point 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 values for segment duration.
      See Also:

    • minFinalSegmentLength

      public final Double minFinalSegmentLength()
      Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.
      Returns:
      Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.

    • minSegmentLength

      public final Integer minSegmentLength()
      When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
      Returns:
      When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

    • outputSelection

      public final HlsOutputSelection outputSelection()
      Indicates whether the .m3u8 manifest file should be generated for this HLS 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:
      Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
      See Also:

    • outputSelectionAsString

      public final String outputSelectionAsString()
      Indicates whether the .m3u8 manifest file should be generated for this HLS 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:
      Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
      See Also:

    • programDateTime

      public final HlsProgramDateTime programDateTime()
      Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

      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 as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.
      See Also:

    • programDateTimeAsString

      public final String programDateTimeAsString()
      Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.

      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 as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.
      See Also:

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

    • progressiveWriteHlsManifest

      public final HlsProgressiveWriteHlsManifest progressiveWriteHlsManifest()
      Specify whether MediaConvert generates HLS manifests while your job is running or when your job is complete. To generate HLS manifests while your job is running: Choose Enabled. Use if you want to play back your content as soon as it's available. MediaConvert writes the parent and child manifests after the first three media segments are written to your destination S3 bucket. It then writes new updated manifests after each additional segment is written. The parent manifest includes the latest BANDWIDTH and AVERAGE-BANDWIDTH attributes, and child manifests include the latest available media segment. When your job completes, the final child playlists include an EXT-X-ENDLIST tag. To generate HLS manifests only when your job completes: Choose Disabled.

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

      Returns:
      Specify whether MediaConvert generates HLS manifests while your job is running or when your job is complete. To generate HLS manifests while your job is running: Choose Enabled. Use if you want to play back your content as soon as it's available. MediaConvert writes the parent and child manifests after the first three media segments are written to your destination S3 bucket. It then writes new updated manifests after each additional segment is written. The parent manifest includes the latest BANDWIDTH and AVERAGE-BANDWIDTH attributes, and child manifests include the latest available media segment. When your job completes, the final child playlists include an EXT-X-ENDLIST tag. To generate HLS manifests only when your job completes: Choose Disabled.
      See Also:

    • progressiveWriteHlsManifestAsString

      public final String progressiveWriteHlsManifestAsString()
      Specify whether MediaConvert generates HLS manifests while your job is running or when your job is complete. To generate HLS manifests while your job is running: Choose Enabled. Use if you want to play back your content as soon as it's available. MediaConvert writes the parent and child manifests after the first three media segments are written to your destination S3 bucket. It then writes new updated manifests after each additional segment is written. The parent manifest includes the latest BANDWIDTH and AVERAGE-BANDWIDTH attributes, and child manifests include the latest available media segment. When your job completes, the final child playlists include an EXT-X-ENDLIST tag. To generate HLS manifests only when your job completes: Choose Disabled.

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

      Returns:
      Specify whether MediaConvert generates HLS manifests while your job is running or when your job is complete. To generate HLS manifests while your job is running: Choose Enabled. Use if you want to play back your content as soon as it's available. MediaConvert writes the parent and child manifests after the first three media segments are written to your destination S3 bucket. It then writes new updated manifests after each additional segment is written. The parent manifest includes the latest BANDWIDTH and AVERAGE-BANDWIDTH attributes, and child manifests include the latest available media segment. When your job completes, the final child playlists include an EXT-X-ENDLIST tag. To generate HLS manifests only when your job completes: Choose Disabled.
      See Also:

    • segmentControl

      public final HlsSegmentControl segmentControl()
      When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

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

      Returns:
      When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.
      See Also:

    • segmentControlAsString

      public final String segmentControlAsString()
      When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.

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

      Returns:
      When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.
      See Also:

    • segmentLength

      public final Integer segmentLength()
      Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 10. Related settings: Use Segment length control to specify whether the encoder enforces this value strictly. Use Segment control to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.
      Returns:
      Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 10. Related settings: Use Segment length control to specify whether the encoder enforces this value strictly. Use Segment control to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.

    • segmentLengthControl

      public final HlsSegmentLengthControl segmentLengthControl()
      Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.

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

      Returns:
      Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.
      See Also:

    • segmentLengthControlAsString

      public final String segmentLengthControlAsString()
      Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.

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

      Returns:
      Specify how you want MediaConvert to determine the segment length. Choose Exact to have the encoder use the exact length that you specify with the setting Segment length. This might result in extra I-frames. Choose Multiple of GOP to have the encoder round up the segment lengths to match the next GOP boundary.
      See Also:

    • segmentsPerSubdirectory

      public final Integer segmentsPerSubdirectory()
      Specify the number of segments to write to a subdirectory before starting a new one. You must also set Directory structure to Subdirectory per stream for this setting to have an effect.
      Returns:
      Specify the number of segments to write to a subdirectory before starting a new one. You must also set Directory structure to Subdirectory per stream for this setting to have an effect.

    • streamInfResolution

      public final HlsStreamInfResolution streamInfResolution()
      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:

    • 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:

    • targetDurationCompatibilityMode

      public final HlsTargetDurationCompatibilityMode targetDurationCompatibilityMode()
      When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (invalid input: '<' 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.

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

      Returns:
      When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (invalid input: '<' 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.
      See Also:

    • targetDurationCompatibilityModeAsString

      public final String targetDurationCompatibilityModeAsString()
      When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (invalid input: '<' 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.

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

      Returns:
      When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\\_COMPLIANT, the segment target duration is rounded up to the nearest integer value if fraction seconds are greater than or equal to 0.5 (>= 0.5) and rounded down if less than 0.5 (invalid input: '<' 0.5). You may need to use LEGACY if your client needs to ensure that the target duration is always longer than the actual duration of the segment. Some older players may experience interrupted playback when the actual duration of a track in a segment is longer than the target duration.
      See Also:

    • timedMetadataId3Frame

      public final HlsTimedMetadataId3Frame timedMetadataId3Frame()
      Specify the type of the ID3 frame to use for ID3 timestamps in your output. To include ID3 timestamps: Specify PRIV or TDRL and set ID3 metadata to Passthrough. To exclude ID3 timestamps: Set ID3 timestamp frame type to None.

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

      Returns:
      Specify the type of the ID3 frame to use for ID3 timestamps in your output. To include ID3 timestamps: Specify PRIV or TDRL and set ID3 metadata to Passthrough. To exclude ID3 timestamps: Set ID3 timestamp frame type to None.
      See Also:

    • timedMetadataId3FrameAsString

      public final String timedMetadataId3FrameAsString()
      Specify the type of the ID3 frame to use for ID3 timestamps in your output. To include ID3 timestamps: Specify PRIV or TDRL and set ID3 metadata to Passthrough. To exclude ID3 timestamps: Set ID3 timestamp frame type to None.

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

      Returns:
      Specify the type of the ID3 frame to use for ID3 timestamps in your output. To include ID3 timestamps: Specify PRIV or TDRL and set ID3 metadata to Passthrough. To exclude ID3 timestamps: Set ID3 timestamp frame type to None.
      See Also:

    • timedMetadataId3Period

      public final Integer timedMetadataId3Period()
      Specify the interval in seconds to write ID3 timestamps in your output. The first timestamp starts at the output timecode and date, and increases incrementally with each ID3 timestamp. To use the default interval of 10 seconds: Leave blank. To include this metadata in your output: Set ID3 timestamp frame type to PRIV or TDRL, and set ID3 metadata to Passthrough.
      Returns:
      Specify the interval in seconds to write ID3 timestamps in your output. The first timestamp starts at the output timecode and date, and increases incrementally with each ID3 timestamp. To use the default interval of 10 seconds: Leave blank. To include this metadata in your output: Set ID3 timestamp frame type to PRIV or TDRL, and set ID3 metadata to Passthrough.

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

    • toBuilder

      public HlsGroupSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>
      Returns:
      a builder for type T

    • builder

      public static HlsGroupSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HlsGroupSettings.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.