Package software.amazon.awssdk.services.ivsrealtime.model

Class ParticipantThumbnailConfiguration

java.lang.Object

software.amazon.awssdk.services.ivsrealtime.model.ParticipantThumbnailConfiguration

All Implemented Interfaces:

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

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

An object representing a configuration of thumbnails for recorded video from an individual participant.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParticipantThumbnailConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ParticipantThumbnailConfiguration.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.
ThumbnailRecordingMode	recordingMode()	Thumbnail recording mode.
String	recordingModeAsString()	Thumbnail recording mode.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ParticipantThumbnailConfiguration.Builder>	serializableBuilderClass()
List<ThumbnailStorageType>	storage()	Indicates the format in which thumbnails are recorded.
List<String>	storageAsStrings()	Indicates the format in which thumbnails are recorded.
Integer	targetIntervalSeconds()	The targeted thumbnail-generation interval in seconds.
ParticipantThumbnailConfiguration.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

targetIntervalSeconds

public final Integer targetIntervalSeconds()

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

Returns:

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

storage

public final List<ThumbnailStorageType> storage()

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

recordingMode

public final ThumbnailRecordingMode recordingMode()

Thumbnail recording mode. Default: DISABLED.

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

Returns:

Thumbnail recording mode. Default: DISABLED.

See Also:

ThumbnailRecordingMode

recordingModeAsString

public final String recordingModeAsString()

Thumbnail recording mode. Default: DISABLED.

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

Returns:

Thumbnail recording mode. Default: DISABLED.

See Also:

ThumbnailRecordingMode

toBuilder

public ParticipantThumbnailConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParticipantThumbnailConfiguration.Builder,ParticipantThumbnailConfiguration>

builder

public static ParticipantThumbnailConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo