@Generated(value="software.amazon.awssdk:codegen") public final class CmafGroupSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CmafGroupSettings.Builder,CmafGroupSettings>
Modifier and Type | Class and Description |
---|---|
static interface |
CmafGroupSettings.Builder |
Modifier and Type | Method and Description |
---|---|
List<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.
|
String |
baseUrl()
A partial URI prefix that will be put in the manifest file at the top level BaseURL element.
|
static CmafGroupSettings.Builder |
builder() |
CmafClientCache |
clientCache()
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
|
String |
clientCacheAsString()
Disable this setting only when your workflow requires the #EXT-X-ALLOW-CACHE:no tag.
|
CmafCodecSpecification |
codecSpecification()
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
|
String |
codecSpecificationAsString()
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
|
DashManifestStyle |
dashManifestStyle()
Specify how MediaConvert writes SegmentTimeline in your output DASH manifest.
|
String |
dashManifestStyleAsString()
Specify how MediaConvert writes SegmentTimeline in your output DASH manifest.
|
String |
destination()
Use Destination to specify the S3 output location and the output filename base.
|
DestinationSettings |
destinationSettings()
Settings associated with the destination.
|
CmafEncryptionSettings |
encryption()
DRM settings.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Integer |
fragmentLength()
Specify the length, in whole seconds, of the mp4 fragments.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAdditionalManifests()
For responses, this returns true if the service returned a value for the AdditionalManifests property.
|
int |
hashCode() |
CmafImageBasedTrickPlay |
imageBasedTrickPlay()
Specify whether MediaConvert generates images for trick play.
|
String |
imageBasedTrickPlayAsString()
Specify whether MediaConvert generates images for trick play.
|
CmafImageBasedTrickPlaySettings |
imageBasedTrickPlaySettings()
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
|
CmafManifestCompression |
manifestCompression()
When set to GZIP, compresses HLS playlist.
|
String |
manifestCompressionAsString()
When set to GZIP, compresses HLS playlist.
|
CmafManifestDurationFormat |
manifestDurationFormat()
Indicates whether the output manifest should use floating point values for segment duration.
|
String |
manifestDurationFormatAsString()
Indicates whether the output manifest should use floating point values for segment duration.
|
Integer |
minBufferTime()
Minimum time of initially buffered media that is needed to ensure smooth playout.
|
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.
|
CmafMpdManifestBandwidthType |
mpdManifestBandwidthType()
Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest.
|
String |
mpdManifestBandwidthTypeAsString()
Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest.
|
CmafMpdProfile |
mpdProfile()
Specify whether your DASH profile is on-demand or main.
|
String |
mpdProfileAsString()
Specify whether your DASH profile is on-demand or main.
|
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).
|
String |
ptsOffsetHandlingForBFramesAsString()
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).
|
List<SdkField<?>> |
sdkFields() |
CmafSegmentControl |
segmentControl()
When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment
Length and Segment Length.
|
String |
segmentControlAsString()
When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment
Length and Segment Length.
|
Integer |
segmentLength()
Specify the length, in whole seconds, of each segment.
|
CmafSegmentLengthControl |
segmentLengthControl()
Specify how you want MediaConvert to determine the segment length.
|
String |
segmentLengthControlAsString()
Specify how you want MediaConvert to determine the segment length.
|
static Class<? extends CmafGroupSettings.Builder> |
serializableBuilderClass() |
CmafStreamInfResolution |
streamInfResolution()
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
|
String |
streamInfResolutionAsString()
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
|
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.
|
String |
targetDurationCompatibilityModeAsString()
When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its
current value in seconds.
|
CmafGroupSettings.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
CmafVideoCompositionOffsets |
videoCompositionOffsets()
Specify the video sample composition time offset mode in the output fMP4 TRUN box.
|
String |
videoCompositionOffsetsAsString()
Specify the video sample composition time offset mode in the output fMP4 TRUN box.
|
CmafWriteDASHManifest |
writeDashManifest()
When set to ENABLED, a DASH MPD manifest will be generated for this output.
|
String |
writeDashManifestAsString()
When set to ENABLED, a DASH MPD manifest will be generated for this output.
|
CmafWriteHLSManifest |
writeHlsManifest()
When set to ENABLED, an Apple HLS manifest will be generated for this output.
|
String |
writeHlsManifestAsString()
When set to ENABLED, an Apple HLS manifest will be generated for this output.
|
CmafWriteSegmentTimelineInRepresentation |
writeSegmentTimelineInRepresentation()
When you enable Precise segment duration in DASH manifests, your DASH manifest shows precise segment durations.
|
String |
writeSegmentTimelineInRepresentationAsString()
When you enable Precise segment duration in DASH manifests, your DASH manifest shows precise segment durations.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasAdditionalManifests()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<CmafAdditionalManifest> additionalManifests()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAdditionalManifests()
method.
public final String baseUrl()
public final CmafClientCache clientCache()
If the service returns an enum value that is not available in the current SDK version, clientCache
will
return CmafClientCache.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
clientCacheAsString()
.
CmafClientCache
public final String clientCacheAsString()
If the service returns an enum value that is not available in the current SDK version, clientCache
will
return CmafClientCache.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
clientCacheAsString()
.
CmafClientCache
public final CmafCodecSpecification codecSpecification()
If the service returns an enum value that is not available in the current SDK version,
codecSpecification
will return CmafCodecSpecification.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from codecSpecificationAsString()
.
CmafCodecSpecification
public final String codecSpecificationAsString()
If the service returns an enum value that is not available in the current SDK version,
codecSpecification
will return CmafCodecSpecification.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from codecSpecificationAsString()
.
CmafCodecSpecification
public final DashManifestStyle dashManifestStyle()
If the service returns an enum value that is not available in the current SDK version, dashManifestStyle
will return DashManifestStyle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from dashManifestStyleAsString()
.
DashManifestStyle
public final String dashManifestStyleAsString()
If the service returns an enum value that is not available in the current SDK version, dashManifestStyle
will return DashManifestStyle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from dashManifestStyleAsString()
.
DashManifestStyle
public final String destination()
public final DestinationSettings destinationSettings()
public final CmafEncryptionSettings encryption()
public final Integer fragmentLength()
public final CmafImageBasedTrickPlay imageBasedTrickPlay()
If the service returns an enum value that is not available in the current SDK version,
imageBasedTrickPlay
will return CmafImageBasedTrickPlay.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from imageBasedTrickPlayAsString()
.
CmafImageBasedTrickPlay
public final String imageBasedTrickPlayAsString()
If the service returns an enum value that is not available in the current SDK version,
imageBasedTrickPlay
will return CmafImageBasedTrickPlay.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from imageBasedTrickPlayAsString()
.
CmafImageBasedTrickPlay
public final CmafImageBasedTrickPlaySettings imageBasedTrickPlaySettings()
public final CmafManifestCompression manifestCompression()
If the service returns an enum value that is not available in the current SDK version,
manifestCompression
will return CmafManifestCompression.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from manifestCompressionAsString()
.
CmafManifestCompression
public final String manifestCompressionAsString()
If the service returns an enum value that is not available in the current SDK version,
manifestCompression
will return CmafManifestCompression.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from manifestCompressionAsString()
.
CmafManifestCompression
public final CmafManifestDurationFormat manifestDurationFormat()
If the service returns an enum value that is not available in the current SDK version,
manifestDurationFormat
will return CmafManifestDurationFormat.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from manifestDurationFormatAsString()
.
CmafManifestDurationFormat
public final String manifestDurationFormatAsString()
If the service returns an enum value that is not available in the current SDK version,
manifestDurationFormat
will return CmafManifestDurationFormat.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from manifestDurationFormatAsString()
.
CmafManifestDurationFormat
public final Integer minBufferTime()
public final Double minFinalSegmentLength()
public final CmafMpdManifestBandwidthType mpdManifestBandwidthType()
If the service returns an enum value that is not available in the current SDK version,
mpdManifestBandwidthType
will return CmafMpdManifestBandwidthType.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from mpdManifestBandwidthTypeAsString()
.
CmafMpdManifestBandwidthType
public final String mpdManifestBandwidthTypeAsString()
If the service returns an enum value that is not available in the current SDK version,
mpdManifestBandwidthType
will return CmafMpdManifestBandwidthType.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from mpdManifestBandwidthTypeAsString()
.
CmafMpdManifestBandwidthType
public final CmafMpdProfile mpdProfile()
If the service returns an enum value that is not available in the current SDK version, mpdProfile
will
return CmafMpdProfile.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
mpdProfileAsString()
.
CmafMpdProfile
public final String mpdProfileAsString()
If the service returns an enum value that is not available in the current SDK version, mpdProfile
will
return CmafMpdProfile.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
mpdProfileAsString()
.
CmafMpdProfile
public final CmafPtsOffsetHandlingForBFrames ptsOffsetHandlingForBFrames()
If the service returns an enum value that is not available in the current SDK version,
ptsOffsetHandlingForBFrames
will return CmafPtsOffsetHandlingForBFrames.UNKNOWN_TO_SDK_VERSION
.
The raw value returned by the service is available from ptsOffsetHandlingForBFramesAsString()
.
CmafPtsOffsetHandlingForBFrames
public final String ptsOffsetHandlingForBFramesAsString()
If the service returns an enum value that is not available in the current SDK version,
ptsOffsetHandlingForBFrames
will return CmafPtsOffsetHandlingForBFrames.UNKNOWN_TO_SDK_VERSION
.
The raw value returned by the service is available from ptsOffsetHandlingForBFramesAsString()
.
CmafPtsOffsetHandlingForBFrames
public final CmafSegmentControl segmentControl()
If the service returns an enum value that is not available in the current SDK version, segmentControl
will return CmafSegmentControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from segmentControlAsString()
.
CmafSegmentControl
public final String segmentControlAsString()
If the service returns an enum value that is not available in the current SDK version, segmentControl
will return CmafSegmentControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from segmentControlAsString()
.
CmafSegmentControl
public final Integer segmentLength()
public final CmafSegmentLengthControl segmentLengthControl()
If the service returns an enum value that is not available in the current SDK version,
segmentLengthControl
will return CmafSegmentLengthControl.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from segmentLengthControlAsString()
.
CmafSegmentLengthControl
public final String segmentLengthControlAsString()
If the service returns an enum value that is not available in the current SDK version,
segmentLengthControl
will return CmafSegmentLengthControl.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from segmentLengthControlAsString()
.
CmafSegmentLengthControl
public final CmafStreamInfResolution streamInfResolution()
If the service returns an enum value that is not available in the current SDK version,
streamInfResolution
will return CmafStreamInfResolution.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from streamInfResolutionAsString()
.
CmafStreamInfResolution
public final String streamInfResolutionAsString()
If the service returns an enum value that is not available in the current SDK version,
streamInfResolution
will return CmafStreamInfResolution.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from streamInfResolutionAsString()
.
CmafStreamInfResolution
public final CmafTargetDurationCompatibilityMode targetDurationCompatibilityMode()
If the service returns an enum value that is not available in the current SDK version,
targetDurationCompatibilityMode
will return
CmafTargetDurationCompatibilityMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from targetDurationCompatibilityModeAsString()
.
CmafTargetDurationCompatibilityMode
public final String targetDurationCompatibilityModeAsString()
If the service returns an enum value that is not available in the current SDK version,
targetDurationCompatibilityMode
will return
CmafTargetDurationCompatibilityMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from targetDurationCompatibilityModeAsString()
.
CmafTargetDurationCompatibilityMode
public final CmafVideoCompositionOffsets videoCompositionOffsets()
If the service returns an enum value that is not available in the current SDK version,
videoCompositionOffsets
will return CmafVideoCompositionOffsets.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from videoCompositionOffsetsAsString()
.
CmafVideoCompositionOffsets
public final String videoCompositionOffsetsAsString()
If the service returns an enum value that is not available in the current SDK version,
videoCompositionOffsets
will return CmafVideoCompositionOffsets.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from videoCompositionOffsetsAsString()
.
CmafVideoCompositionOffsets
public final CmafWriteDASHManifest writeDashManifest()
If the service returns an enum value that is not available in the current SDK version, writeDashManifest
will return CmafWriteDASHManifest.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from writeDashManifestAsString()
.
CmafWriteDASHManifest
public final String writeDashManifestAsString()
If the service returns an enum value that is not available in the current SDK version, writeDashManifest
will return CmafWriteDASHManifest.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from writeDashManifestAsString()
.
CmafWriteDASHManifest
public final CmafWriteHLSManifest writeHlsManifest()
If the service returns an enum value that is not available in the current SDK version, writeHlsManifest
will return CmafWriteHLSManifest.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from writeHlsManifestAsString()
.
CmafWriteHLSManifest
public final String writeHlsManifestAsString()
If the service returns an enum value that is not available in the current SDK version, writeHlsManifest
will return CmafWriteHLSManifest.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from writeHlsManifestAsString()
.
CmafWriteHLSManifest
public final CmafWriteSegmentTimelineInRepresentation writeSegmentTimelineInRepresentation()
If the service returns an enum value that is not available in the current SDK version,
writeSegmentTimelineInRepresentation
will return
CmafWriteSegmentTimelineInRepresentation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from writeSegmentTimelineInRepresentationAsString()
.
CmafWriteSegmentTimelineInRepresentation
public final String writeSegmentTimelineInRepresentationAsString()
If the service returns an enum value that is not available in the current SDK version,
writeSegmentTimelineInRepresentation
will return
CmafWriteSegmentTimelineInRepresentation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from writeSegmentTimelineInRepresentationAsString()
.
CmafWriteSegmentTimelineInRepresentation
public CmafGroupSettings.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CmafGroupSettings.Builder,CmafGroupSettings>
public static CmafGroupSettings.Builder builder()
public static Class<? extends CmafGroupSettings.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.