Package software.amazon.awssdk.services.mediaconvert.model

Class CmafImageBasedTrickPlaySettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.CmafImageBasedTrickPlaySettings

All Implemented Interfaces:

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

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

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CmafImageBasedTrickPlaySettings.Builder

Method Summary

Modifier and Type	Method	Description
static CmafImageBasedTrickPlaySettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
CmafIntervalCadence	intervalCadence()	The cadence MediaConvert follows for generating thumbnails.
String	intervalCadenceAsString()	The cadence MediaConvert follows for generating thumbnails.
List<SdkField<?>>	sdkFields()
static Class<? extends CmafImageBasedTrickPlaySettings.Builder>	serializableBuilderClass()
Integer	thumbnailHeight()	Height of each thumbnail within each tile image, in pixels.
Double	thumbnailInterval()	Enter the interval, in seconds, that MediaConvert uses to generate thumbnails.
Integer	thumbnailWidth()	Width of each thumbnail within each tile image, in pixels.
Integer	tileHeight()	Number of thumbnails in each column of a tile image.
Integer	tileWidth()	Number of thumbnails in each row of a tile image.
CmafImageBasedTrickPlaySettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

intervalCadence

public final CmafIntervalCadence intervalCadence()

The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

If the service returns an enum value that is not available in the current SDK version, intervalCadence will return CmafIntervalCadence.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalCadenceAsString().

Returns:

The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

See Also:

CmafIntervalCadence

intervalCadenceAsString

public final String intervalCadenceAsString()

The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

If the service returns an enum value that is not available in the current SDK version, intervalCadence will return CmafIntervalCadence.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalCadenceAsString().

Returns:

The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval.

See Also:

CmafIntervalCadence

thumbnailHeight

public final Integer thumbnailHeight()

Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2.

Returns:

Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2.

thumbnailInterval

public final Double thumbnailInterval()

Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails.

Returns:

Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails.

thumbnailWidth

public final Integer thumbnailWidth()

Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8.

Returns:

Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8.

tileHeight

public final Integer tileHeight()

Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2.

Returns:

Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2.

tileWidth

public final Integer tileWidth()

Number of thumbnails in each row of a tile image. Set a value between 1 and 512.

Returns:

Number of thumbnails in each row of a tile image. Set a value between 1 and 512.

toBuilder

public CmafImageBasedTrickPlaySettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CmafImageBasedTrickPlaySettings.Builder,CmafImageBasedTrickPlaySettings>

builder

public static CmafImageBasedTrickPlaySettings.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo