software.amazon.awssdk.services.mediaconvert.model

Interface CmafGroupSettings.Builder

All Superinterfaces:

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

Enclosing class:

CmafGroupSettings

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

Method Summary

Modifier and Type	Method and Description
CmafGroupSettings.Builder	additionalManifests(CmafAdditionalManifest... additionalManifests) By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job.
CmafGroupSettings.Builder	additionalManifests(Collection<CmafAdditionalManifest> additionalManifests) By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job.
CmafGroupSettings.Builder	additionalManifests(Consumer<CmafAdditionalManifest.Builder>... additionalManifests) By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job.
CmafGroupSettings.Builder	baseUrl(String baseUrl) A partial URI prefix that will be put in the manifest file at the top level BaseURL element.
CmafGroupSettings.Builder	clientCache(CmafClientCache clientCache) Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
CmafGroupSettings.Builder	clientCache(String clientCache) Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
CmafGroupSettings.Builder	codecSpecification(CmafCodecSpecification codecSpecification) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
CmafGroupSettings.Builder	codecSpecification(String codecSpecification) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
CmafGroupSettings.Builder	destination(String destination) Use Destination (Destination) to specify the S3 output location and the output filename base.
default CmafGroupSettings.Builder	destinationSettings(Consumer<DestinationSettings.Builder> destinationSettings) Settings associated with the destination.
CmafGroupSettings.Builder	destinationSettings(DestinationSettings destinationSettings) Settings associated with the destination.
CmafGroupSettings.Builder	encryption(CmafEncryptionSettings encryption) DRM settings.
default CmafGroupSettings.Builder	encryption(Consumer<CmafEncryptionSettings.Builder> encryption) DRM settings.
CmafGroupSettings.Builder	fragmentLength(Integer fragmentLength) Specify the length, in whole seconds, of the mp4 fragments.
CmafGroupSettings.Builder	imageBasedTrickPlay(CmafImageBasedTrickPlay imageBasedTrickPlay) Specify whether MediaConvert generates images for trick play.
CmafGroupSettings.Builder	imageBasedTrickPlay(String imageBasedTrickPlay) Specify whether MediaConvert generates images for trick play.
CmafGroupSettings.Builder	imageBasedTrickPlaySettings(CmafImageBasedTrickPlaySettings imageBasedTrickPlaySettings) Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
default CmafGroupSettings.Builder	imageBasedTrickPlaySettings(Consumer<CmafImageBasedTrickPlaySettings.Builder> imageBasedTrickPlaySettings) Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED This is a convenience method that creates an instance of the CmafImageBasedTrickPlaySettings.Builder avoiding the need to create one manually via CmafImageBasedTrickPlaySettings.builder().
CmafGroupSettings.Builder	manifestCompression(CmafManifestCompression manifestCompression) When set to GZIP, compresses HLS playlist.
CmafGroupSettings.Builder	manifestCompression(String manifestCompression) When set to GZIP, compresses HLS playlist.
CmafGroupSettings.Builder	manifestDurationFormat(CmafManifestDurationFormat manifestDurationFormat) Indicates whether the output manifest should use floating point values for segment duration.
CmafGroupSettings.Builder	manifestDurationFormat(String manifestDurationFormat) Indicates whether the output manifest should use floating point values for segment duration.
CmafGroupSettings.Builder	minBufferTime(Integer minBufferTime) Minimum time of initially buffered media that is needed to ensure smooth playout.
CmafGroupSettings.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.
CmafGroupSettings.Builder	mpdManifestBandwidthType(CmafMpdManifestBandwidthType mpdManifestBandwidthType) Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest.
CmafGroupSettings.Builder	mpdManifestBandwidthType(String mpdManifestBandwidthType) Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest.
CmafGroupSettings.Builder	mpdProfile(CmafMpdProfile mpdProfile) Specify whether your DASH profile is on-demand or main.
CmafGroupSettings.Builder	mpdProfile(String mpdProfile) Specify whether your DASH profile is on-demand or main.
CmafGroupSettings.Builder	ptsOffsetHandlingForBFrames(CmafPtsOffsetHandlingForBFrames ptsOffsetHandlingForBFrames) Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS).
CmafGroupSettings.Builder	ptsOffsetHandlingForBFrames(String ptsOffsetHandlingForBFrames) Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS).
CmafGroupSettings.Builder	segmentControl(CmafSegmentControl segmentControl) When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length.
CmafGroupSettings.Builder	segmentControl(String segmentControl) When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length.
CmafGroupSettings.Builder	segmentLength(Integer segmentLength) Specify the length, in whole seconds, of each segment.
CmafGroupSettings.Builder	segmentLengthControl(CmafSegmentLengthControl segmentLengthControl) Specify how you want MediaConvert to determine the segment length.
CmafGroupSettings.Builder	segmentLengthControl(String segmentLengthControl) Specify how you want MediaConvert to determine the segment length.
CmafGroupSettings.Builder	streamInfResolution(CmafStreamInfResolution streamInfResolution) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
CmafGroupSettings.Builder	streamInfResolution(String streamInfResolution) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
CmafGroupSettings.Builder	targetDurationCompatibilityMode(CmafTargetDurationCompatibilityMode targetDurationCompatibilityMode) When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds.
CmafGroupSettings.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.
CmafGroupSettings.Builder	videoCompositionOffsets(CmafVideoCompositionOffsets videoCompositionOffsets) Specify the video sample composition time offset mode in the output fMP4 TRUN box.
CmafGroupSettings.Builder	videoCompositionOffsets(String videoCompositionOffsets) Specify the video sample composition time offset mode in the output fMP4 TRUN box.
CmafGroupSettings.Builder	writeDashManifest(CmafWriteDASHManifest writeDashManifest) When set to ENABLED, a DASH MPD manifest will be generated for this output.
CmafGroupSettings.Builder	writeDashManifest(String writeDashManifest) When set to ENABLED, a DASH MPD manifest will be generated for this output.
CmafGroupSettings.Builder	writeHlsManifest(CmafWriteHLSManifest writeHlsManifest) When set to ENABLED, an Apple HLS manifest will be generated for this output.
CmafGroupSettings.Builder	writeHlsManifest(String writeHlsManifest) When set to ENABLED, an Apple HLS manifest will be generated for this output.
CmafGroupSettings.Builder	writeSegmentTimelineInRepresentation(CmafWriteSegmentTimelineInRepresentation writeSegmentTimelineInRepresentation) When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations.
CmafGroupSettings.Builder	writeSegmentTimelineInRepresentation(String writeSegmentTimelineInRepresentation) When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations.

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

additionalManifests

CmafGroupSettings.Builder additionalManifests(Collection<CmafAdditionalManifest> additionalManifests)

By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job. These default manifests reference 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. For each additional manifest that you specify, the service creates one HLS manifest and one DASH manifest.

Parameters:

additionalManifests - By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job. These default manifests reference 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. For each additional manifest that you specify, the service creates one HLS manifest and one DASH manifest.

Returns:

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

additionalManifests

CmafGroupSettings.Builder additionalManifests(CmafAdditionalManifest... additionalManifests)

By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job. These default manifests reference 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. For each additional manifest that you specify, the service creates one HLS manifest and one DASH manifest.

Parameters:

additionalManifests - By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job. These default manifests reference 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. For each additional manifest that you specify, the service creates one HLS manifest and one DASH manifest.

Returns:

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

additionalManifests

CmafGroupSettings.Builder additionalManifests(Consumer<CmafAdditionalManifest.Builder>... additionalManifests)

By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each CMAF output group in your job. These default manifests reference 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. For each additional manifest that you specify, the service creates one HLS manifest and one DASH manifest. This is a convenience method that creates an instance of the CmafAdditionalManifest.Builder avoiding the need to create one manually via CmafAdditionalManifest.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 CmafAdditionalManifest.Builder

Returns:

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

See Also:

#additionalManifests(java.util.Collection)

baseUrl

CmafGroupSettings.Builder baseUrl(String baseUrl)

A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.

Parameters:

baseUrl - A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.

Returns:

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

clientCache

CmafGroupSettings.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:

CmafClientCache, CmafClientCache

clientCache

CmafGroupSettings.Builder clientCache(CmafClientCache 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:

CmafClientCache, CmafClientCache

codecSpecification

CmafGroupSettings.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:

CmafCodecSpecification, CmafCodecSpecification

codecSpecification

CmafGroupSettings.Builder codecSpecification(CmafCodecSpecification 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:

CmafCodecSpecification, CmafCodecSpecification

destination

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

CmafGroupSettings.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 CmafGroupSettings.Builder destinationSettings(Consumer<DestinationSettings.Builder> destinationSettings)

Settings associated with the destination. Will vary based on the type of destination This is a convenience method 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)

encryption

CmafGroupSettings.Builder encryption(CmafEncryptionSettings encryption)

DRM settings.

Parameters:

encryption - DRM settings.

Returns:

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

encryption

default CmafGroupSettings.Builder encryption(Consumer<CmafEncryptionSettings.Builder> encryption)

DRM settings. This is a convenience method that creates an instance of the CmafEncryptionSettings.Builder avoiding the need to create one manually via CmafEncryptionSettings.builder().

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

Parameters:

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

Returns:

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

See Also:

encryption(CmafEncryptionSettings)

fragmentLength

CmafGroupSettings.Builder fragmentLength(Integer fragmentLength)

Specify the length, in whole seconds, of the mp4 fragments. When you don't specify a value, MediaConvert defaults to 2. Related setting: Use Fragment length control (FragmentLengthControl) to specify whether the encoder enforces this value strictly.

Parameters:

fragmentLength - Specify the length, in whole seconds, of the mp4 fragments. When you don't specify a value, MediaConvert defaults to 2. Related setting: Use Fragment length control (FragmentLengthControl) to specify whether the encoder enforces this value strictly.

Returns:

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

imageBasedTrickPlay

CmafGroupSettings.Builder imageBasedTrickPlay(String imageBasedTrickPlay)

Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest (WriteHlsManifest), MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest (WriteDashManifest), MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. 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 (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest (WriteHlsManifest), MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest (WriteDashManifest), MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. 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:

CmafImageBasedTrickPlay, CmafImageBasedTrickPlay

imageBasedTrickPlay

CmafGroupSettings.Builder imageBasedTrickPlay(CmafImageBasedTrickPlay imageBasedTrickPlay)

Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest (WriteHlsManifest), MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest (WriteDashManifest), MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. 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 (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest (WriteHlsManifest), MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest (WriteDashManifest), MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. 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:

CmafImageBasedTrickPlay, CmafImageBasedTrickPlay

imageBasedTrickPlaySettings

CmafGroupSettings.Builder imageBasedTrickPlaySettings(CmafImageBasedTrickPlaySettings 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.

imageBasedTrickPlaySettings

default CmafGroupSettings.Builder imageBasedTrickPlaySettings(Consumer<CmafImageBasedTrickPlaySettings.Builder> imageBasedTrickPlaySettings)

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED This is a convenience method that creates an instance of the CmafImageBasedTrickPlaySettings.Builder avoiding the need to create one manually via CmafImageBasedTrickPlaySettings.builder().

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

Parameters:

imageBasedTrickPlaySettings - a consumer that will call methods on CmafImageBasedTrickPlaySettings.Builder

Returns:

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

See Also:

imageBasedTrickPlaySettings(CmafImageBasedTrickPlaySettings)

manifestCompression

CmafGroupSettings.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:

CmafManifestCompression, CmafManifestCompression

manifestCompression

CmafGroupSettings.Builder manifestCompression(CmafManifestCompression 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:

CmafManifestCompression, CmafManifestCompression

manifestDurationFormat

CmafGroupSettings.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:

CmafManifestDurationFormat, CmafManifestDurationFormat

manifestDurationFormat

CmafGroupSettings.Builder manifestDurationFormat(CmafManifestDurationFormat 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:

CmafManifestDurationFormat, CmafManifestDurationFormat

minBufferTime

CmafGroupSettings.Builder minBufferTime(Integer minBufferTime)

Minimum time of initially buffered media that is needed to ensure smooth playout.

Parameters:

minBufferTime - Minimum time of initially buffered media that is needed to ensure smooth playout.

Returns:

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

minFinalSegmentLength

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

mpdManifestBandwidthType

CmafGroupSettings.Builder mpdManifestBandwidthType(String mpdManifestBandwidthType)

Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second.

Parameters:

mpdManifestBandwidthType - Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second.

Returns:

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

See Also:

CmafMpdManifestBandwidthType, CmafMpdManifestBandwidthType

mpdManifestBandwidthType

CmafGroupSettings.Builder mpdManifestBandwidthType(CmafMpdManifestBandwidthType mpdManifestBandwidthType)

Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second.

Parameters:

mpdManifestBandwidthType - Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwidth type that is compatible with your downstream player configuration. Max: Use the same value that you specify for Max bitrate in the video output, in bits per second. Average: Use the calculated average bitrate of the encoded video output, in bits per second.

Returns:

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

See Also:

CmafMpdManifestBandwidthType, CmafMpdManifestBandwidthType

mpdProfile

CmafGroupSettings.Builder mpdProfile(String mpdProfile)

Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

Parameters:

mpdProfile - Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

Returns:

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

See Also:

CmafMpdProfile, CmafMpdProfile

mpdProfile

CmafGroupSettings.Builder mpdProfile(CmafMpdProfile mpdProfile)

Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

Parameters:

mpdProfile - Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

Returns:

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

See Also:

CmafMpdProfile, CmafMpdProfile

ptsOffsetHandlingForBFrames

CmafGroupSettings.Builder ptsOffsetHandlingForBFrames(String ptsOffsetHandlingForBFrames)

Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

Parameters:

ptsOffsetHandlingForBFrames - Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

Returns:

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

See Also:

CmafPtsOffsetHandlingForBFrames, CmafPtsOffsetHandlingForBFrames

ptsOffsetHandlingForBFrames

CmafGroupSettings.Builder ptsOffsetHandlingForBFrames(CmafPtsOffsetHandlingForBFrames ptsOffsetHandlingForBFrames)

Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

Parameters:

ptsOffsetHandlingForBFrames - Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

Returns:

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

See Also:

CmafPtsOffsetHandlingForBFrames, CmafPtsOffsetHandlingForBFrames

segmentControl

CmafGroupSettings.Builder segmentControl(String segmentControl)

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

Parameters:

segmentControl - When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

Returns:

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

See Also:

CmafSegmentControl, CmafSegmentControl

segmentControl

CmafGroupSettings.Builder segmentControl(CmafSegmentControl segmentControl)

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

Parameters:

segmentControl - When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

Returns:

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

See Also:

CmafSegmentControl, CmafSegmentControl

segmentLength

CmafGroupSettings.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 (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (CmafSegmentControl) 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 (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (CmafSegmentControl) 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

CmafGroupSettings.Builder segmentLengthControl(String segmentLengthControl)

Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) 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 (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) 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:

CmafSegmentLengthControl, CmafSegmentLengthControl

segmentLengthControl

CmafGroupSettings.Builder segmentLengthControl(CmafSegmentLengthControl segmentLengthControl)

Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) 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 (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) 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:

CmafSegmentLengthControl, CmafSegmentLengthControl

streamInfResolution

CmafGroupSettings.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:

CmafStreamInfResolution, CmafStreamInfResolution

streamInfResolution

CmafGroupSettings.Builder streamInfResolution(CmafStreamInfResolution 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:

CmafStreamInfResolution, CmafStreamInfResolution

targetDurationCompatibilityMode

CmafGroupSettings.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:

CmafTargetDurationCompatibilityMode, CmafTargetDurationCompatibilityMode

targetDurationCompatibilityMode

CmafGroupSettings.Builder targetDurationCompatibilityMode(CmafTargetDurationCompatibilityMode 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:

CmafTargetDurationCompatibilityMode, CmafTargetDurationCompatibilityMode

videoCompositionOffsets

CmafGroupSettings.Builder videoCompositionOffsets(String videoCompositionOffsets)

Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers.

Parameters:

videoCompositionOffsets - Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers.

Returns:

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

See Also:

CmafVideoCompositionOffsets, CmafVideoCompositionOffsets

videoCompositionOffsets

CmafGroupSettings.Builder videoCompositionOffsets(CmafVideoCompositionOffsets videoCompositionOffsets)

Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers.

Parameters:

videoCompositionOffsets - Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or leave blank. The earliest presentation time may be greater than zero, and sample composition time offsets will increment using unsigned integers. For strict fMP4 video and audio timing, set Video composition offsets to Signed. The earliest presentation time will be equal to zero, and sample composition time offsets will increment using signed integers.

Returns:

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

See Also:

CmafVideoCompositionOffsets, CmafVideoCompositionOffsets

writeDashManifest

CmafGroupSettings.Builder writeDashManifest(String writeDashManifest)

When set to ENABLED, a DASH MPD manifest will be generated for this output.

Parameters:

writeDashManifest - When set to ENABLED, a DASH MPD manifest will be generated for this output.

Returns:

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

See Also:

CmafWriteDASHManifest, CmafWriteDASHManifest

writeDashManifest

CmafGroupSettings.Builder writeDashManifest(CmafWriteDASHManifest writeDashManifest)

When set to ENABLED, a DASH MPD manifest will be generated for this output.

Parameters:

writeDashManifest - When set to ENABLED, a DASH MPD manifest will be generated for this output.

Returns:

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

See Also:

CmafWriteDASHManifest, CmafWriteDASHManifest

writeHlsManifest

CmafGroupSettings.Builder writeHlsManifest(String writeHlsManifest)

When set to ENABLED, an Apple HLS manifest will be generated for this output.

Parameters:

writeHlsManifest - When set to ENABLED, an Apple HLS manifest will be generated for this output.

Returns:

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

See Also:

CmafWriteHLSManifest, CmafWriteHLSManifest

writeHlsManifest

CmafGroupSettings.Builder writeHlsManifest(CmafWriteHLSManifest writeHlsManifest)

When set to ENABLED, an Apple HLS manifest will be generated for this output.

Parameters:

writeHlsManifest - When set to ENABLED, an Apple HLS manifest will be generated for this output.

Returns:

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

See Also:

CmafWriteHLSManifest, CmafWriteHLSManifest

writeSegmentTimelineInRepresentation

CmafGroupSettings.Builder writeSegmentTimelineInRepresentation(String writeSegmentTimelineInRepresentation)

When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.

Parameters:

writeSegmentTimelineInRepresentation - When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.

Returns:

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

See Also:

CmafWriteSegmentTimelineInRepresentation, CmafWriteSegmentTimelineInRepresentation

writeSegmentTimelineInRepresentation

CmafGroupSettings.Builder writeSegmentTimelineInRepresentation(CmafWriteSegmentTimelineInRepresentation writeSegmentTimelineInRepresentation)

When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.

Parameters:

writeSegmentTimelineInRepresentation - When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.

Returns:

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

See Also:

CmafWriteSegmentTimelineInRepresentation, CmafWriteSegmentTimelineInRepresentation