software.amazon.awssdk.services.mediaconvert.model

Interface HlsGroupSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>, SdkBuilder<HlsGroupSettings.Builder,HlsGroupSettings>, SdkPojo

Enclosing class:

HlsGroupSettings

public static interface HlsGroupSettings.Builder
extends SdkPojo, CopyableBuilder<HlsGroupSettings.Builder,HlsGroupSettings>

Method Summary

Modifier and Type	Method and Description
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.
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.
HlsGroupSettings.Builder	additionalManifests(HlsAdditionalManifest... additionalManifests) By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job.
HlsGroupSettings.Builder	adMarkers(Collection<HlsAdMarkers> adMarkers) Choose one or more ad marker types to decorate your Apple HLS manifest.
HlsGroupSettings.Builder	adMarkers(HlsAdMarkers... adMarkers) Choose one or more ad marker types to decorate your Apple HLS manifest.
HlsGroupSettings.Builder	adMarkersWithStrings(Collection<String> adMarkers) Choose one or more ad marker types to decorate your Apple HLS manifest.
HlsGroupSettings.Builder	adMarkersWithStrings(String... adMarkers) Choose one or more ad marker types to decorate your Apple HLS manifest.
HlsGroupSettings.Builder	audioOnlyHeader(HlsAudioOnlyHeader audioOnlyHeader) Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues.
HlsGroupSettings.Builder	audioOnlyHeader(String audioOnlyHeader) Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues.
HlsGroupSettings.Builder	baseUrl(String baseUrl) A partial URI prefix that will be prepended to each output in the media .m3u8 file.
HlsGroupSettings.Builder	captionLanguageMappings(Collection<HlsCaptionLanguageMapping> captionLanguageMappings) Language to be used on Caption outputs
HlsGroupSettings.Builder	captionLanguageMappings(Consumer<HlsCaptionLanguageMapping.Builder>... captionLanguageMappings) Language to be used on Caption outputs This is a convenience that creates an instance of the .Builder avoiding the need to create one manually via #builder().
HlsGroupSettings.Builder	captionLanguageMappings(HlsCaptionLanguageMapping... captionLanguageMappings) Language to be used on Caption outputs
HlsGroupSettings.Builder	captionLanguageSetting(HlsCaptionLanguageSetting captionLanguageSetting) Applies only to 608 Embedded output captions.
HlsGroupSettings.Builder	captionLanguageSetting(String captionLanguageSetting) Applies only to 608 Embedded output captions.
HlsGroupSettings.Builder	clientCache(HlsClientCache clientCache) Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
HlsGroupSettings.Builder	clientCache(String clientCache) Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
HlsGroupSettings.Builder	codecSpecification(HlsCodecSpecification codecSpecification) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
HlsGroupSettings.Builder	codecSpecification(String codecSpecification) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
HlsGroupSettings.Builder	destination(String destination) Use Destination (Destination) to specify the S3 output location and the output filename base.
default HlsGroupSettings.Builder	destinationSettings(Consumer<DestinationSettings.Builder> destinationSettings) Settings associated with the destination.
HlsGroupSettings.Builder	destinationSettings(DestinationSettings destinationSettings) Settings associated with the destination.
HlsGroupSettings.Builder	directoryStructure(HlsDirectoryStructure directoryStructure) Indicates whether segments should be placed in subdirectories.
HlsGroupSettings.Builder	directoryStructure(String directoryStructure) Indicates whether segments should be placed in subdirectories.
default HlsGroupSettings.Builder	encryption(Consumer<HlsEncryptionSettings.Builder> encryption) DRM settings.
HlsGroupSettings.Builder	encryption(HlsEncryptionSettings encryption) DRM settings.
HlsGroupSettings.Builder	manifestCompression(HlsManifestCompression manifestCompression) When set to GZIP, compresses HLS playlist.
HlsGroupSettings.Builder	manifestCompression(String manifestCompression) When set to GZIP, compresses HLS playlist.
HlsGroupSettings.Builder	manifestDurationFormat(HlsManifestDurationFormat manifestDurationFormat) Indicates whether the output manifest should use floating point values for segment duration.
HlsGroupSettings.Builder	manifestDurationFormat(String manifestDurationFormat) Indicates whether the output manifest should use floating point values for segment duration.
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.
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.
HlsGroupSettings.Builder	outputSelection(HlsOutputSelection outputSelection) Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
HlsGroupSettings.Builder	outputSelection(String outputSelection) Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
HlsGroupSettings.Builder	programDateTime(HlsProgramDateTime programDateTime) Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
HlsGroupSettings.Builder	programDateTime(String programDateTime) Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files.
HlsGroupSettings.Builder	programDateTimePeriod(Integer programDateTimePeriod) Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
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.
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.
HlsGroupSettings.Builder	segmentLength(Integer segmentLength) Length of MPEG-2 Transport Stream segments to create (in seconds).
HlsGroupSettings.Builder	segmentsPerSubdirectory(Integer segmentsPerSubdirectory) Number of segments to write to a subdirectory before starting a new one.
HlsGroupSettings.Builder	streamInfResolution(HlsStreamInfResolution streamInfResolution) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
HlsGroupSettings.Builder	streamInfResolution(String streamInfResolution) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
HlsGroupSettings.Builder	timedMetadataId3Frame(HlsTimedMetadataId3Frame timedMetadataId3Frame) Indicates ID3 frame that has the timecode.
HlsGroupSettings.Builder	timedMetadataId3Frame(String timedMetadataId3Frame) Indicates ID3 frame that has the timecode.
HlsGroupSettings.Builder	timedMetadataId3Period(Integer timedMetadataId3Period) Timed Metadata interval in seconds.
HlsGroupSettings.Builder	timestampDeltaMilliseconds(Integer timestampDeltaMilliseconds) Provides an extra millisecond delta offset to fine tune the timestamps.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #additionalManifests(List).

Parameters:

additionalManifests - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#additionalManifests(List)

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 (INCLUDE), to output audio-only headers. Choose Exclude (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 (INCLUDE), to output audio-only headers. Choose Exclude (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 (INCLUDE), to output audio-only headers. Choose Exclude (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 (INCLUDE), to output audio-only headers. Choose Exclude (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.

captionLanguageMappings

HlsGroupSettings.Builder captionLanguageMappings(Consumer<HlsCaptionLanguageMapping.Builder>... captionLanguageMappings)

Language to be used on Caption outputs This is a convenience that creates an instance of the .Builder avoiding the need to create one manually via #builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #captionLanguageMappings(List).

Parameters:

captionLanguageMappings - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#captionLanguageMappings(List)

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

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

destinationSettings

default HlsGroupSettings.Builder destinationSettings(Consumer<DestinationSettings.Builder> destinationSettings)

Settings associated with the destination. Will vary based on the type of destination This is a convenience that creates an instance of the DestinationSettings.Builder avoiding the need to create one manually via DestinationSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationSettings(DestinationSettings).

Parameters:

destinationSettings - a consumer that will call methods on DestinationSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

destinationSettings(DestinationSettings)

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

directoryStructure

HlsGroupSettings.Builder directoryStructure(HlsDirectoryStructure 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.

encryption

default HlsGroupSettings.Builder encryption(Consumer<HlsEncryptionSettings.Builder> encryption)

DRM settings. This is a convenience that creates an instance of the HlsEncryptionSettings.Builder avoiding the need to create one manually via HlsEncryptionSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryption(HlsEncryptionSettings).

Parameters:

encryption - a consumer that will call methods on HlsEncryptionSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

encryption(HlsEncryptionSettings)

manifestCompression

HlsGroupSettings.Builder manifestCompression(String manifestCompression)

When set to GZIP, compresses HLS playlist.

Parameters:

manifestCompression - When set to GZIP, compresses HLS playlist.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsManifestCompression, HlsManifestCompression

manifestCompression

HlsGroupSettings.Builder manifestCompression(HlsManifestCompression manifestCompression)

When set to GZIP, compresses HLS playlist.

Parameters:

manifestCompression - When set to GZIP, compresses HLS playlist.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsManifestCompression, HlsManifestCompression

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.

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)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

segmentsPerSubdirectory

HlsGroupSettings.Builder segmentsPerSubdirectory(Integer segmentsPerSubdirectory)

Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect.

Parameters:

segmentsPerSubdirectory - Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY 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

timedMetadataId3Frame

HlsGroupSettings.Builder timedMetadataId3Frame(String timedMetadataId3Frame)

Indicates ID3 frame that has the timecode.

Parameters:

timedMetadataId3Frame - Indicates ID3 frame that has the timecode.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsTimedMetadataId3Frame, HlsTimedMetadataId3Frame

timedMetadataId3Frame

HlsGroupSettings.Builder timedMetadataId3Frame(HlsTimedMetadataId3Frame timedMetadataId3Frame)

Indicates ID3 frame that has the timecode.

Parameters:

timedMetadataId3Frame - Indicates ID3 frame that has the timecode.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsTimedMetadataId3Frame, HlsTimedMetadataId3Frame

timedMetadataId3Period

HlsGroupSettings.Builder timedMetadataId3Period(Integer timedMetadataId3Period)

Timed Metadata interval in seconds.

Parameters:

timedMetadataId3Period - Timed Metadata interval in seconds.

Returns:

Returns a reference to this object so that method calls can be chained together.

timestampDeltaMilliseconds

HlsGroupSettings.Builder timestampDeltaMilliseconds(Integer timestampDeltaMilliseconds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.