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

Interface HlsGroupSettings.Builder

    • Method Detail

      • adMarkersWithStrings

        HlsGroupSettings.Builder adMarkersWithStrings​(Collection<String> 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.
        Parameters:
        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.
        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 decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.
        Parameters:
        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.
        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 decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.
        Parameters:
        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.
        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 decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves.
        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • additionalManifests

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

      • additionalManifests

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

      • additionalManifests

        HlsGroupSettings.Builder additionalManifests​(Consumer<HlsAdditionalManifest.Builder>... 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. This is a convenience method that creates an instance of the HlsAdditionalManifest.Builder avoiding the need to create one manually via HlsAdditionalManifest.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #additionalManifests(List).

        Parameters:
        additionalManifests - a consumer that will call methods on HlsAdditionalManifest.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #additionalManifests(java.util.Collection)

      • audioOnlyHeader

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

      • audioOnlyHeader

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

      • baseUrl

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

      • captionLanguageMappings

        HlsGroupSettings.Builder captionLanguageMappings​(Collection<HlsCaptionLanguageMapping> captionLanguageMappings)
        Language to be used on Caption outputs
        Parameters:
        captionLanguageMappings - Language to be used on Caption outputs
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • captionLanguageMappings

        HlsGroupSettings.Builder captionLanguageMappings​(HlsCaptionLanguageMapping... captionLanguageMappings)
        Language to be used on Caption outputs
        Parameters:
        captionLanguageMappings - Language to be used on Caption outputs
        Returns:
        Returns a reference to this object so that method calls can be chained together.

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

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

      • captionSegmentLengthControl

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

      • captionSegmentLengthControl

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

      • clientCache

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

      • clientCache

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

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

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

      • destination

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

      • destinationSettings

        HlsGroupSettings.Builder destinationSettings​(DestinationSettings destinationSettings)
        Settings associated with the destination. Will vary based on the type of destination
        Parameters:
        destinationSettings - Settings associated with the destination. Will vary based on the type of destination
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • directoryStructure

        HlsGroupSettings.Builder directoryStructure​(String directoryStructure)
        Indicates whether segments should be placed in subdirectories.
        Parameters:
        directoryStructure - Indicates whether segments should be placed in subdirectories.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HlsDirectoryStructure, HlsDirectoryStructure

      • encryption

        HlsGroupSettings.Builder encryption​(HlsEncryptionSettings encryption)
        DRM settings.
        Parameters:
        encryption - DRM settings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • imageBasedTrickPlay

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

      • imageBasedTrickPlay

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

      • imageBasedTrickPlaySettings

        HlsGroupSettings.Builder imageBasedTrickPlaySettings​(HlsImageBasedTrickPlaySettings imageBasedTrickPlaySettings)
        Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
        Parameters:
        imageBasedTrickPlaySettings - Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • manifestDurationFormat

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

      • manifestDurationFormat

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

      • minFinalSegmentLength

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

      • minSegmentLength

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

      • outputSelection

        HlsGroupSettings.Builder outputSelection​(String outputSelection)
        Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
        Parameters:
        outputSelection - Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HlsOutputSelection, HlsOutputSelection

      • outputSelection

        HlsGroupSettings.Builder outputSelection​(HlsOutputSelection outputSelection)
        Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
        Parameters:
        outputSelection - Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HlsOutputSelection, HlsOutputSelection

      • programDateTime

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

      • programDateTime

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

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

      • progressiveWriteHlsManifest

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

      • progressiveWriteHlsManifest

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

      • segmentControl

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

      • segmentControl

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

      • segmentLength

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

      • segmentLengthControl

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

      • segmentLengthControl

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

      • segmentsPerSubdirectory

        HlsGroupSettings.Builder segmentsPerSubdirectory​(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.
        Parameters:
        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:
        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:
        HlsStreamInfResolution, HlsStreamInfResolution

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

      • targetDurationCompatibilityMode

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

      • targetDurationCompatibilityMode

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

      • timedMetadataId3Frame

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

      • timedMetadataId3Frame

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

      • timedMetadataId3Period

        HlsGroupSettings.Builder timedMetadataId3Period​(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.
        Parameters:
        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:
        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.