software.amazon.awssdk.services.ivs.model

Class ThumbnailConfiguration

java.lang.Object

software.amazon.awssdk.services.ivs.model.ThumbnailConfiguration

All Implemented Interfaces:

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

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

An object representing a configuration of thumbnails for recorded video.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ThumbnailConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ThumbnailConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RecordingMode	recordingMode() Thumbnail recording mode.
String	recordingModeAsString() Thumbnail recording mode.
List<SdkField<?>>	sdkFields()
static Class<? extends ThumbnailConfiguration.Builder>	serializableBuilderClass()
Long	targetIntervalSeconds() The targeted thumbnail-generation interval in seconds.
ThumbnailConfiguration.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

recordingMode

public final RecordingMode recordingMode()

Thumbnail recording mode. Default: INTERVAL.

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

Returns:

Thumbnail recording mode. Default: INTERVAL.

See Also:

RecordingMode

recordingModeAsString

public final String recordingModeAsString()

Thumbnail recording mode. Default: INTERVAL.

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

Returns:

Thumbnail recording mode. Default: INTERVAL.

See Also:

RecordingMode

targetIntervalSeconds

public final Long targetIntervalSeconds()

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Returns:

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

toBuilder

public ThumbnailConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ThumbnailConfiguration.Builder,ThumbnailConfiguration>

builder

public static ThumbnailConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ThumbnailConfiguration.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