Package 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("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	Description
static interface	ThumbnailConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ThumbnailConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStorage()	For responses, this returns true if the service returned a value for the Storage property.
RecordingMode	recordingMode()	Thumbnail recording mode.
String	recordingModeAsString()	Thumbnail recording mode.
ThumbnailConfigurationResolution	resolution()	Indicates the desired resolution of recorded thumbnails.
String	resolutionAsString()	Indicates the desired resolution of recorded thumbnails.
List<SdkField<?>>	sdkFields()
static Class<? extends ThumbnailConfiguration.Builder>	serializableBuilderClass()
List<ThumbnailConfigurationStorage>	storage()	Indicates the format in which thumbnails are recorded.
List<String>	storageAsStrings()	Indicates the format in which thumbnails are recorded.
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

resolution

public final ThumbnailConfigurationResolution resolution()

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

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

Returns:

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

See Also:

ThumbnailConfigurationResolution

resolutionAsString

public final String resolutionAsString()

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

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

Returns:

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

See Also:

ThumbnailConfigurationResolution

storage

public final List<ThumbnailConfigurationStorage> storage()

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

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

Returns:

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

hasStorage

public final boolean hasStorage()

For responses, this returns true if the service returned a value for the Storage property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

storageAsStrings

public final List<String> storageAsStrings()

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

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

Returns:

Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

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: For the BASIC channel type, 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: For the BASIC channel type, 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