software.amazon.awssdk.services.mediaconvert.model

Class CmafGroupSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.CmafGroupSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CmafGroupSettings.Builder,CmafGroupSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class CmafGroupSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CmafGroupSettings.Builder,CmafGroupSettings>

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CmafGroupSettings.Builder

Method Summary

Modifier and Type	Method and Description
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() Returns the value of the ClientCache property for this object.
String	clientCacheAsString() Returns the value of the ClientCache property for this object.
CmafCodecSpecification	codecSpecification() Returns the value of the CodecSpecification property for this object.
String	codecSpecificationAsString() Returns the value of the CodecSpecification property for this object.
String	destination() Use Destination (Destination) to specify the S3 output location and the output filename base.
CmafEncryptionSettings	encryption() DRM settings.
boolean	equals(Object obj)
Integer	fragmentLength() Length of fragments to generate (in seconds).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
CmafManifestCompression	manifestCompression() Returns the value of the ManifestCompression property for this object.
String	manifestCompressionAsString() Returns the value of the ManifestCompression property for this object.
CmafManifestDurationFormat	manifestDurationFormat() Returns the value of the ManifestDurationFormat property for this object.
String	manifestDurationFormatAsString() Returns the value of the ManifestDurationFormat property for this object.
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.
List<SdkField<?>>	sdkFields()
CmafSegmentControl	segmentControl() Returns the value of the SegmentControl property for this object.
String	segmentControlAsString() Returns the value of the SegmentControl property for this object.
Integer	segmentLength() Use this setting to specify the length, in seconds, of each individual CMAF segment.
static Class<? extends CmafGroupSettings.Builder>	serializableBuilderClass()
CmafStreamInfResolution	streamInfResolution() Returns the value of the StreamInfResolution property for this object.
String	streamInfResolutionAsString() Returns the value of the StreamInfResolution property for this object.
CmafGroupSettings.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
CmafWriteDASHManifest	writeDashManifest() Returns the value of the WriteDashManifest property for this object.
String	writeDashManifestAsString() Returns the value of the WriteDashManifest property for this object.
CmafWriteHLSManifest	writeHlsManifest() Returns the value of the WriteHlsManifest property for this object.
String	writeHlsManifestAsString() Returns the value of the WriteHlsManifest property for this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

baseUrl

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

Returns:

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.

clientCache

public CmafClientCache clientCache()

Returns the value of the ClientCache property for this object.

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

Returns:

The value of the ClientCache property for this object.

See Also:

CmafClientCache

clientCacheAsString

public String clientCacheAsString()

Returns the value of the ClientCache property for this object.

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

Returns:

The value of the ClientCache property for this object.

See Also:

CmafClientCache

codecSpecification

public CmafCodecSpecification codecSpecification()

Returns the value of the CodecSpecification property for this object.

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

Returns:

The value of the CodecSpecification property for this object.

See Also:

CmafCodecSpecification

codecSpecificationAsString

public String codecSpecificationAsString()

Returns the value of the CodecSpecification property for this object.

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

Returns:

The value of the CodecSpecification property for this object.

See Also:

CmafCodecSpecification

destination

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

Returns:

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.

encryption

public CmafEncryptionSettings encryption()

DRM settings.

Returns:

DRM settings.

fragmentLength

public Integer fragmentLength()

Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.

Returns:

Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.

manifestCompression

public CmafManifestCompression manifestCompression()

Returns the value of the ManifestCompression property for this object.

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

Returns:

The value of the ManifestCompression property for this object.

See Also:

CmafManifestCompression

manifestCompressionAsString

public String manifestCompressionAsString()

Returns the value of the ManifestCompression property for this object.

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

Returns:

The value of the ManifestCompression property for this object.

See Also:

CmafManifestCompression

manifestDurationFormat

public CmafManifestDurationFormat manifestDurationFormat()

Returns the value of the ManifestDurationFormat property for this object.

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

Returns:

The value of the ManifestDurationFormat property for this object.

See Also:

CmafManifestDurationFormat

manifestDurationFormatAsString

public String manifestDurationFormatAsString()

Returns the value of the ManifestDurationFormat property for this object.

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

Returns:

The value of the ManifestDurationFormat property for this object.

See Also:

CmafManifestDurationFormat

minBufferTime

public Integer minBufferTime()

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

Returns:

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

minFinalSegmentLength

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

Returns:

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.

segmentControl

public CmafSegmentControl segmentControl()

Returns the value of the SegmentControl property for this object.

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

Returns:

The value of the SegmentControl property for this object.

See Also:

CmafSegmentControl

segmentControlAsString

public String segmentControlAsString()

Returns the value of the SegmentControl property for this object.

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

Returns:

The value of the SegmentControl property for this object.

See Also:

CmafSegmentControl

segmentLength

public Integer segmentLength()

Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment.

Returns:

Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment.

streamInfResolution

public CmafStreamInfResolution streamInfResolution()

Returns the value of the StreamInfResolution property for this object.

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

Returns:

The value of the StreamInfResolution property for this object.

See Also:

CmafStreamInfResolution

streamInfResolutionAsString

public String streamInfResolutionAsString()

Returns the value of the StreamInfResolution property for this object.

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

Returns:

The value of the StreamInfResolution property for this object.

See Also:

CmafStreamInfResolution

writeDashManifest

public CmafWriteDASHManifest writeDashManifest()

Returns the value of the WriteDashManifest property for this object.

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

Returns:

The value of the WriteDashManifest property for this object.

See Also:

CmafWriteDASHManifest

writeDashManifestAsString

public String writeDashManifestAsString()

Returns the value of the WriteDashManifest property for this object.

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

Returns:

The value of the WriteDashManifest property for this object.

See Also:

CmafWriteDASHManifest

writeHlsManifest

public CmafWriteHLSManifest writeHlsManifest()

Returns the value of the WriteHlsManifest property for this object.

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

Returns:

The value of the WriteHlsManifest property for this object.

See Also:

CmafWriteHLSManifest

writeHlsManifestAsString

public String writeHlsManifestAsString()

Returns the value of the WriteHlsManifest property for this object.

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

Returns:

The value of the WriteHlsManifest property for this object.

See Also:

CmafWriteHLSManifest

toBuilder

public CmafGroupSettings.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CmafGroupSettings.Builder,CmafGroupSettings>

Returns:

a builder for type T

builder

public static CmafGroupSettings.Builder builder()

serializableBuilderClass

public static Class<? extends CmafGroupSettings.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.