@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CmafGroupSettings extends Object implements Serializable, Cloneable, StructuredPojo
Constructor and Description |
---|
CmafGroupSettings() |
Modifier and Type | Method and Description |
---|---|
CmafGroupSettings |
clone() |
boolean |
equals(Object obj) |
List<CmafAdditionalManifest> |
getAdditionalManifests()
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.
|
String |
getBaseUrl()
A partial URI prefix that will be put in the manifest file at the top level BaseURL element.
|
String |
getClientCache()
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
|
String |
getCodecSpecification()
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
|
String |
getDashIFrameTrickPlayNameModifier()
Specify whether MediaConvert generates I-frame only video segments for DASH trick play, also known as trick mode.
|
String |
getDashManifestStyle()
Specify how MediaConvert writes SegmentTimeline in your output DASH manifest.
|
String |
getDestination()
Use Destination to specify the S3 output location and the output filename base.
|
DestinationSettings |
getDestinationSettings()
Settings associated with the destination.
|
CmafEncryptionSettings |
getEncryption()
DRM settings.
|
Integer |
getFragmentLength()
Specify the length, in whole seconds, of the mp4 fragments.
|
String |
getImageBasedTrickPlay()
Specify whether MediaConvert generates images for trick play.
|
CmafImageBasedTrickPlaySettings |
getImageBasedTrickPlaySettings()
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
|
String |
getManifestCompression()
When set to GZIP, compresses HLS playlist.
|
String |
getManifestDurationFormat()
Indicates whether the output manifest should use floating point values for segment duration.
|
Integer |
getMinBufferTime()
Minimum time of initially buffered media that is needed to ensure smooth playout.
|
Double |
getMinFinalSegmentLength()
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.
|
String |
getMpdManifestBandwidthType()
Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest.
|
String |
getMpdProfile()
Specify whether your DASH profile is on-demand or main.
|
String |
getPtsOffsetHandlingForBFrames()
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).
|
String |
getSegmentControl()
When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment
Length and Segment Length.
|
Integer |
getSegmentLength()
Specify the length, in whole seconds, of each segment.
|
String |
getSegmentLengthControl()
Specify how you want MediaConvert to determine the segment length.
|
String |
getStreamInfResolution()
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
|
String |
getTargetDurationCompatibilityMode()
When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its
current value in seconds.
|
String |
getVideoCompositionOffsets()
Specify the video sample composition time offset mode in the output fMP4 TRUN box.
|
String |
getWriteDashManifest()
When set to ENABLED, a DASH MPD manifest will be generated for this output.
|
String |
getWriteHlsManifest()
When set to ENABLED, an Apple HLS manifest will be generated for this output.
|
String |
getWriteSegmentTimelineInRepresentation()
When you enable Precise segment duration in DASH manifests, your DASH manifest shows precise segment durations.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAdditionalManifests(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.
|
void |
setBaseUrl(String baseUrl)
A partial URI prefix that will be put in the manifest file at the top level BaseURL element.
|
void |
setClientCache(String clientCache)
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
|
void |
setCodecSpecification(String codecSpecification)
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
|
void |
setDashIFrameTrickPlayNameModifier(String dashIFrameTrickPlayNameModifier)
Specify whether MediaConvert generates I-frame only video segments for DASH trick play, also known as trick mode.
|
void |
setDashManifestStyle(String dashManifestStyle)
Specify how MediaConvert writes SegmentTimeline in your output DASH manifest.
|
void |
setDestination(String destination)
Use Destination to specify the S3 output location and the output filename base.
|
void |
setDestinationSettings(DestinationSettings destinationSettings)
Settings associated with the destination.
|
void |
setEncryption(CmafEncryptionSettings encryption)
DRM settings.
|
void |
setFragmentLength(Integer fragmentLength)
Specify the length, in whole seconds, of the mp4 fragments.
|
void |
setImageBasedTrickPlay(String imageBasedTrickPlay)
Specify whether MediaConvert generates images for trick play.
|
void |
setImageBasedTrickPlaySettings(CmafImageBasedTrickPlaySettings imageBasedTrickPlaySettings)
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
|
void |
setManifestCompression(String manifestCompression)
When set to GZIP, compresses HLS playlist.
|
void |
setManifestDurationFormat(String manifestDurationFormat)
Indicates whether the output manifest should use floating point values for segment duration.
|
void |
setMinBufferTime(Integer minBufferTime)
Minimum time of initially buffered media that is needed to ensure smooth playout.
|
void |
setMinFinalSegmentLength(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.
|
void |
setMpdManifestBandwidthType(String mpdManifestBandwidthType)
Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest.
|
void |
setMpdProfile(String mpdProfile)
Specify whether your DASH profile is on-demand or main.
|
void |
setPtsOffsetHandlingForBFrames(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).
|
void |
setSegmentControl(String segmentControl)
When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment
Length and Segment Length.
|
void |
setSegmentLength(Integer segmentLength)
Specify the length, in whole seconds, of each segment.
|
void |
setSegmentLengthControl(String segmentLengthControl)
Specify how you want MediaConvert to determine the segment length.
|
void |
setStreamInfResolution(String streamInfResolution)
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
|
void |
setTargetDurationCompatibilityMode(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.
|
void |
setVideoCompositionOffsets(String videoCompositionOffsets)
Specify the video sample composition time offset mode in the output fMP4 TRUN box.
|
void |
setWriteDashManifest(String writeDashManifest)
When set to ENABLED, a DASH MPD manifest will be generated for this output.
|
void |
setWriteHlsManifest(String writeHlsManifest)
When set to ENABLED, an Apple HLS manifest will be generated for this output.
|
void |
setWriteSegmentTimelineInRepresentation(String writeSegmentTimelineInRepresentation)
When you enable Precise segment duration in DASH manifests, your DASH manifest shows precise segment durations.
|
String |
toString()
Returns a string representation of this object.
|
CmafGroupSettings |
withAdditionalManifests(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 |
withAdditionalManifests(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 |
withBaseUrl(String baseUrl)
A partial URI prefix that will be put in the manifest file at the top level BaseURL element.
|
CmafGroupSettings |
withClientCache(CmafClientCache clientCache)
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
|
CmafGroupSettings |
withClientCache(String clientCache)
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
|
CmafGroupSettings |
withCodecSpecification(CmafCodecSpecification codecSpecification)
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
|
CmafGroupSettings |
withCodecSpecification(String codecSpecification)
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
|
CmafGroupSettings |
withDashIFrameTrickPlayNameModifier(String dashIFrameTrickPlayNameModifier)
Specify whether MediaConvert generates I-frame only video segments for DASH trick play, also known as trick mode.
|
CmafGroupSettings |
withDashManifestStyle(DashManifestStyle dashManifestStyle)
Specify how MediaConvert writes SegmentTimeline in your output DASH manifest.
|
CmafGroupSettings |
withDashManifestStyle(String dashManifestStyle)
Specify how MediaConvert writes SegmentTimeline in your output DASH manifest.
|
CmafGroupSettings |
withDestination(String destination)
Use Destination to specify the S3 output location and the output filename base.
|
CmafGroupSettings |
withDestinationSettings(DestinationSettings destinationSettings)
Settings associated with the destination.
|
CmafGroupSettings |
withEncryption(CmafEncryptionSettings encryption)
DRM settings.
|
CmafGroupSettings |
withFragmentLength(Integer fragmentLength)
Specify the length, in whole seconds, of the mp4 fragments.
|
CmafGroupSettings |
withImageBasedTrickPlay(CmafImageBasedTrickPlay imageBasedTrickPlay)
Specify whether MediaConvert generates images for trick play.
|
CmafGroupSettings |
withImageBasedTrickPlay(String imageBasedTrickPlay)
Specify whether MediaConvert generates images for trick play.
|
CmafGroupSettings |
withImageBasedTrickPlaySettings(CmafImageBasedTrickPlaySettings imageBasedTrickPlaySettings)
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
|
CmafGroupSettings |
withManifestCompression(CmafManifestCompression manifestCompression)
When set to GZIP, compresses HLS playlist.
|
CmafGroupSettings |
withManifestCompression(String manifestCompression)
When set to GZIP, compresses HLS playlist.
|
CmafGroupSettings |
withManifestDurationFormat(CmafManifestDurationFormat manifestDurationFormat)
Indicates whether the output manifest should use floating point values for segment duration.
|
CmafGroupSettings |
withManifestDurationFormat(String manifestDurationFormat)
Indicates whether the output manifest should use floating point values for segment duration.
|
CmafGroupSettings |
withMinBufferTime(Integer minBufferTime)
Minimum time of initially buffered media that is needed to ensure smooth playout.
|
CmafGroupSettings |
withMinFinalSegmentLength(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 |
withMpdManifestBandwidthType(CmafMpdManifestBandwidthType mpdManifestBandwidthType)
Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest.
|
CmafGroupSettings |
withMpdManifestBandwidthType(String mpdManifestBandwidthType)
Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest.
|
CmafGroupSettings |
withMpdProfile(CmafMpdProfile mpdProfile)
Specify whether your DASH profile is on-demand or main.
|
CmafGroupSettings |
withMpdProfile(String mpdProfile)
Specify whether your DASH profile is on-demand or main.
|
CmafGroupSettings |
withPtsOffsetHandlingForBFrames(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 |
withPtsOffsetHandlingForBFrames(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 |
withSegmentControl(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 |
withSegmentControl(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 |
withSegmentLength(Integer segmentLength)
Specify the length, in whole seconds, of each segment.
|
CmafGroupSettings |
withSegmentLengthControl(CmafSegmentLengthControl segmentLengthControl)
Specify how you want MediaConvert to determine the segment length.
|
CmafGroupSettings |
withSegmentLengthControl(String segmentLengthControl)
Specify how you want MediaConvert to determine the segment length.
|
CmafGroupSettings |
withStreamInfResolution(CmafStreamInfResolution streamInfResolution)
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
|
CmafGroupSettings |
withStreamInfResolution(String streamInfResolution)
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
|
CmafGroupSettings |
withTargetDurationCompatibilityMode(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 |
withTargetDurationCompatibilityMode(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 |
withVideoCompositionOffsets(CmafVideoCompositionOffsets videoCompositionOffsets)
Specify the video sample composition time offset mode in the output fMP4 TRUN box.
|
CmafGroupSettings |
withVideoCompositionOffsets(String videoCompositionOffsets)
Specify the video sample composition time offset mode in the output fMP4 TRUN box.
|
CmafGroupSettings |
withWriteDashManifest(CmafWriteDASHManifest writeDashManifest)
When set to ENABLED, a DASH MPD manifest will be generated for this output.
|
CmafGroupSettings |
withWriteDashManifest(String writeDashManifest)
When set to ENABLED, a DASH MPD manifest will be generated for this output.
|
CmafGroupSettings |
withWriteHlsManifest(CmafWriteHLSManifest writeHlsManifest)
When set to ENABLED, an Apple HLS manifest will be generated for this output.
|
CmafGroupSettings |
withWriteHlsManifest(String writeHlsManifest)
When set to ENABLED, an Apple HLS manifest will be generated for this output.
|
CmafGroupSettings |
withWriteSegmentTimelineInRepresentation(CmafWriteSegmentTimelineInRepresentation writeSegmentTimelineInRepresentation)
When you enable Precise segment duration in DASH manifests, your DASH manifest shows precise segment durations.
|
CmafGroupSettings |
withWriteSegmentTimelineInRepresentation(String writeSegmentTimelineInRepresentation)
When you enable Precise segment duration in DASH manifests, your DASH manifest shows precise segment durations.
|
public List<CmafAdditionalManifest> getAdditionalManifests()
public void setAdditionalManifests(Collection<CmafAdditionalManifest> additionalManifests)
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.public CmafGroupSettings withAdditionalManifests(CmafAdditionalManifest... additionalManifests)
NOTE: This method appends the values to the existing list (if any). Use
setAdditionalManifests(java.util.Collection)
or withAdditionalManifests(java.util.Collection)
if you want to override the existing values.
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.public CmafGroupSettings withAdditionalManifests(Collection<CmafAdditionalManifest> additionalManifests)
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.public void setBaseUrl(String baseUrl)
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.public String getBaseUrl()
public CmafGroupSettings withBaseUrl(String baseUrl)
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.public void setClientCache(String clientCache)
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.CmafClientCache
public String getClientCache()
CmafClientCache
public CmafGroupSettings withClientCache(String clientCache)
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.CmafClientCache
public CmafGroupSettings withClientCache(CmafClientCache clientCache)
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.CmafClientCache
public void setCodecSpecification(String codecSpecification)
codecSpecification
- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.CmafCodecSpecification
public String getCodecSpecification()
CmafCodecSpecification
public CmafGroupSettings withCodecSpecification(String codecSpecification)
codecSpecification
- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.CmafCodecSpecification
public CmafGroupSettings withCodecSpecification(CmafCodecSpecification codecSpecification)
codecSpecification
- Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.CmafCodecSpecification
public void setDashIFrameTrickPlayNameModifier(String dashIFrameTrickPlayNameModifier)
dashIFrameTrickPlayNameModifier
- Specify whether MediaConvert generates I-frame only video segments for DASH trick play, also known as
trick mode. When specified, the I-frame only video segments are included within an additional
AdaptationSet in your DASH output manifest. To generate I-frame only video segments: Enter a name as a
text string, up to 256 character long. This name is appended to the end of this output group's base
filename, that you specify as part of your destination URI, and used for the I-frame only video segment
files. You may also include format identifiers. For more information, see:
https://docs.aws.amazon.com/mediaconvert
/latest/ug/using-variables-in-your-job-settings.html#using-settings-variables-with-streaming-outputs To
not generate I-frame only video segments: Leave blank.public String getDashIFrameTrickPlayNameModifier()
public CmafGroupSettings withDashIFrameTrickPlayNameModifier(String dashIFrameTrickPlayNameModifier)
dashIFrameTrickPlayNameModifier
- Specify whether MediaConvert generates I-frame only video segments for DASH trick play, also known as
trick mode. When specified, the I-frame only video segments are included within an additional
AdaptationSet in your DASH output manifest. To generate I-frame only video segments: Enter a name as a
text string, up to 256 character long. This name is appended to the end of this output group's base
filename, that you specify as part of your destination URI, and used for the I-frame only video segment
files. You may also include format identifiers. For more information, see:
https://docs.aws.amazon.com/mediaconvert
/latest/ug/using-variables-in-your-job-settings.html#using-settings-variables-with-streaming-outputs To
not generate I-frame only video segments: Leave blank.public void setDashManifestStyle(String dashManifestStyle)
dashManifestStyle
- Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To write a SegmentTimeline
in each video Representation: Keep the default value, Basic. To write a common SegmentTimeline in the
video AdaptationSet: Choose Compact. Note that MediaConvert will still write a SegmentTimeline in any
Representation that does not share a common timeline. To write a video AdaptationSet for each different
output framerate, and a common SegmentTimeline in each AdaptationSet: Choose Distinct.DashManifestStyle
public String getDashManifestStyle()
DashManifestStyle
public CmafGroupSettings withDashManifestStyle(String dashManifestStyle)
dashManifestStyle
- Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To write a SegmentTimeline
in each video Representation: Keep the default value, Basic. To write a common SegmentTimeline in the
video AdaptationSet: Choose Compact. Note that MediaConvert will still write a SegmentTimeline in any
Representation that does not share a common timeline. To write a video AdaptationSet for each different
output framerate, and a common SegmentTimeline in each AdaptationSet: Choose Distinct.DashManifestStyle
public CmafGroupSettings withDashManifestStyle(DashManifestStyle dashManifestStyle)
dashManifestStyle
- Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To write a SegmentTimeline
in each video Representation: Keep the default value, Basic. To write a common SegmentTimeline in the
video AdaptationSet: Choose Compact. Note that MediaConvert will still write a SegmentTimeline in any
Representation that does not share a common timeline. To write a video AdaptationSet for each different
output framerate, and a common SegmentTimeline in each AdaptationSet: Choose Distinct.DashManifestStyle
public void setDestination(String destination)
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.public String getDestination()
public CmafGroupSettings withDestination(String destination)
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.public void setDestinationSettings(DestinationSettings destinationSettings)
destinationSettings
- Settings associated with the destination. Will vary based on the type of destinationpublic DestinationSettings getDestinationSettings()
public CmafGroupSettings withDestinationSettings(DestinationSettings destinationSettings)
destinationSettings
- Settings associated with the destination. Will vary based on the type of destinationpublic void setEncryption(CmafEncryptionSettings encryption)
encryption
- DRM settings.public CmafEncryptionSettings getEncryption()
public CmafGroupSettings withEncryption(CmafEncryptionSettings encryption)
encryption
- DRM settings.public void setFragmentLength(Integer fragmentLength)
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 to specify whether the encoder enforces this
value strictly.public Integer getFragmentLength()
public CmafGroupSettings withFragmentLength(Integer fragmentLength)
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 to specify whether the encoder enforces this
value strictly.public void setImageBasedTrickPlay(String imageBasedTrickPlay)
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. When you enable Write HLS manifest,
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, 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.mdCmafImageBasedTrickPlay
public String getImageBasedTrickPlay()
CmafImageBasedTrickPlay
public CmafGroupSettings withImageBasedTrickPlay(String imageBasedTrickPlay)
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. When you enable Write HLS manifest,
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, 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.mdCmafImageBasedTrickPlay
public CmafGroupSettings withImageBasedTrickPlay(CmafImageBasedTrickPlay imageBasedTrickPlay)
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. When you enable Write HLS manifest,
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, 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.mdCmafImageBasedTrickPlay
public void setImageBasedTrickPlaySettings(CmafImageBasedTrickPlaySettings imageBasedTrickPlaySettings)
imageBasedTrickPlaySettings
- Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCEDpublic CmafImageBasedTrickPlaySettings getImageBasedTrickPlaySettings()
public CmafGroupSettings withImageBasedTrickPlaySettings(CmafImageBasedTrickPlaySettings imageBasedTrickPlaySettings)
imageBasedTrickPlaySettings
- Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCEDpublic void setManifestCompression(String manifestCompression)
manifestCompression
- When set to GZIP, compresses HLS playlist.CmafManifestCompression
public String getManifestCompression()
CmafManifestCompression
public CmafGroupSettings withManifestCompression(String manifestCompression)
manifestCompression
- When set to GZIP, compresses HLS playlist.CmafManifestCompression
public CmafGroupSettings withManifestCompression(CmafManifestCompression manifestCompression)
manifestCompression
- When set to GZIP, compresses HLS playlist.CmafManifestCompression
public void setManifestDurationFormat(String manifestDurationFormat)
manifestDurationFormat
- Indicates whether the output manifest should use floating point values for segment duration.CmafManifestDurationFormat
public String getManifestDurationFormat()
CmafManifestDurationFormat
public CmafGroupSettings withManifestDurationFormat(String manifestDurationFormat)
manifestDurationFormat
- Indicates whether the output manifest should use floating point values for segment duration.CmafManifestDurationFormat
public CmafGroupSettings withManifestDurationFormat(CmafManifestDurationFormat manifestDurationFormat)
manifestDurationFormat
- Indicates whether the output manifest should use floating point values for segment duration.CmafManifestDurationFormat
public void setMinBufferTime(Integer minBufferTime)
minBufferTime
- Minimum time of initially buffered media that is needed to ensure smooth playout.public Integer getMinBufferTime()
public CmafGroupSettings withMinBufferTime(Integer minBufferTime)
minBufferTime
- Minimum time of initially buffered media that is needed to ensure smooth playout.public void setMinFinalSegmentLength(Double minFinalSegmentLength)
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.public Double getMinFinalSegmentLength()
public CmafGroupSettings withMinFinalSegmentLength(Double minFinalSegmentLength)
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.public void setMpdManifestBandwidthType(String mpdManifestBandwidthType)
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.CmafMpdManifestBandwidthType
public String getMpdManifestBandwidthType()
CmafMpdManifestBandwidthType
public CmafGroupSettings withMpdManifestBandwidthType(String mpdManifestBandwidthType)
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.CmafMpdManifestBandwidthType
public CmafGroupSettings withMpdManifestBandwidthType(CmafMpdManifestBandwidthType mpdManifestBandwidthType)
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.CmafMpdManifestBandwidthType
public void setMpdProfile(String mpdProfile)
mpdProfile
- Specify whether your DASH profile is on-demand or main. When you choose Main profile, the service signals
urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand, 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 to Single file.CmafMpdProfile
public String getMpdProfile()
CmafMpdProfile
public CmafGroupSettings withMpdProfile(String mpdProfile)
mpdProfile
- Specify whether your DASH profile is on-demand or main. When you choose Main profile, the service signals
urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand, 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 to Single file.CmafMpdProfile
public CmafGroupSettings withMpdProfile(CmafMpdProfile mpdProfile)
mpdProfile
- Specify whether your DASH profile is on-demand or main. When you choose Main profile, the service signals
urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand, 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 to Single file.CmafMpdProfile
public void setPtsOffsetHandlingForBFrames(String ptsOffsetHandlingForBFrames)
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 when you want MediaConvert
to use the initial PTS as the first time stamp in the manifest. Choose 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.CmafPtsOffsetHandlingForBFrames
public String getPtsOffsetHandlingForBFrames()
CmafPtsOffsetHandlingForBFrames
public CmafGroupSettings withPtsOffsetHandlingForBFrames(String ptsOffsetHandlingForBFrames)
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 when you want MediaConvert
to use the initial PTS as the first time stamp in the manifest. Choose 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.CmafPtsOffsetHandlingForBFrames
public CmafGroupSettings withPtsOffsetHandlingForBFrames(CmafPtsOffsetHandlingForBFrames ptsOffsetHandlingForBFrames)
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 when you want MediaConvert
to use the initial PTS as the first time stamp in the manifest. Choose 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.CmafPtsOffsetHandlingForBFrames
public void setSegmentControl(String segmentControl)
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.CmafSegmentControl
public String getSegmentControl()
CmafSegmentControl
public CmafGroupSettings withSegmentControl(String segmentControl)
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.CmafSegmentControl
public CmafGroupSettings withSegmentControl(CmafSegmentControl segmentControl)
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.CmafSegmentControl
public void setSegmentLength(Integer segmentLength)
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.public Integer getSegmentLength()
public CmafGroupSettings withSegmentLength(Integer segmentLength)
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.public void setSegmentLengthControl(String segmentLengthControl)
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.CmafSegmentLengthControl
public String getSegmentLengthControl()
CmafSegmentLengthControl
public CmafGroupSettings withSegmentLengthControl(String segmentLengthControl)
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.CmafSegmentLengthControl
public CmafGroupSettings withSegmentLengthControl(CmafSegmentLengthControl segmentLengthControl)
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.CmafSegmentLengthControl
public void setStreamInfResolution(String streamInfResolution)
streamInfResolution
- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.CmafStreamInfResolution
public String getStreamInfResolution()
CmafStreamInfResolution
public CmafGroupSettings withStreamInfResolution(String streamInfResolution)
streamInfResolution
- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.CmafStreamInfResolution
public CmafGroupSettings withStreamInfResolution(CmafStreamInfResolution streamInfResolution)
streamInfResolution
- Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.CmafStreamInfResolution
public void setTargetDurationCompatibilityMode(String targetDurationCompatibilityMode)
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.CmafTargetDurationCompatibilityMode
public String getTargetDurationCompatibilityMode()
CmafTargetDurationCompatibilityMode
public CmafGroupSettings withTargetDurationCompatibilityMode(String targetDurationCompatibilityMode)
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.CmafTargetDurationCompatibilityMode
public CmafGroupSettings withTargetDurationCompatibilityMode(CmafTargetDurationCompatibilityMode targetDurationCompatibilityMode)
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.CmafTargetDurationCompatibilityMode
public void setVideoCompositionOffsets(String videoCompositionOffsets)
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.CmafVideoCompositionOffsets
public String getVideoCompositionOffsets()
CmafVideoCompositionOffsets
public CmafGroupSettings withVideoCompositionOffsets(String videoCompositionOffsets)
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.CmafVideoCompositionOffsets
public CmafGroupSettings withVideoCompositionOffsets(CmafVideoCompositionOffsets videoCompositionOffsets)
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.CmafVideoCompositionOffsets
public void setWriteDashManifest(String writeDashManifest)
writeDashManifest
- When set to ENABLED, a DASH MPD manifest will be generated for this output.CmafWriteDASHManifest
public String getWriteDashManifest()
CmafWriteDASHManifest
public CmafGroupSettings withWriteDashManifest(String writeDashManifest)
writeDashManifest
- When set to ENABLED, a DASH MPD manifest will be generated for this output.CmafWriteDASHManifest
public CmafGroupSettings withWriteDashManifest(CmafWriteDASHManifest writeDashManifest)
writeDashManifest
- When set to ENABLED, a DASH MPD manifest will be generated for this output.CmafWriteDASHManifest
public void setWriteHlsManifest(String writeHlsManifest)
writeHlsManifest
- When set to ENABLED, an Apple HLS manifest will be generated for this output.CmafWriteHLSManifest
public String getWriteHlsManifest()
CmafWriteHLSManifest
public CmafGroupSettings withWriteHlsManifest(String writeHlsManifest)
writeHlsManifest
- When set to ENABLED, an Apple HLS manifest will be generated for this output.CmafWriteHLSManifest
public CmafGroupSettings withWriteHlsManifest(CmafWriteHLSManifest writeHlsManifest)
writeHlsManifest
- When set to ENABLED, an Apple HLS manifest will be generated for this output.CmafWriteHLSManifest
public void setWriteSegmentTimelineInRepresentation(String writeSegmentTimelineInRepresentation)
writeSegmentTimelineInRepresentation
- When you enable Precise segment duration in DASH manifests, 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.CmafWriteSegmentTimelineInRepresentation
public String getWriteSegmentTimelineInRepresentation()
CmafWriteSegmentTimelineInRepresentation
public CmafGroupSettings withWriteSegmentTimelineInRepresentation(String writeSegmentTimelineInRepresentation)
writeSegmentTimelineInRepresentation
- When you enable Precise segment duration in DASH manifests, 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.CmafWriteSegmentTimelineInRepresentation
public CmafGroupSettings withWriteSegmentTimelineInRepresentation(CmafWriteSegmentTimelineInRepresentation writeSegmentTimelineInRepresentation)
writeSegmentTimelineInRepresentation
- When you enable Precise segment duration in DASH manifests, 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.CmafWriteSegmentTimelineInRepresentation
public String toString()
toString
in class Object
Object.toString()
public CmafGroupSettings clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.