Class ThumbnailConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ThumbnailConfiguration.Builder,
ThumbnailConfiguration>
An object representing a configuration of thumbnails for recorded video.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Storage property.final RecordingMode
Thumbnail recording mode.final String
Thumbnail recording mode.Indicates the desired resolution of recorded thumbnails.final String
Indicates the desired resolution of recorded thumbnails.static Class
<? extends ThumbnailConfiguration.Builder> storage()
Indicates the format in which thumbnails are recorded.Indicates the format in which thumbnails are recorded.final Long
The targeted thumbnail-generation interval in seconds.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
recordingMode
Thumbnail recording mode. Default:
INTERVAL
.If the service returns an enum value that is not available in the current SDK version,
recordingMode
will returnRecordingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrecordingModeAsString()
.- Returns:
- Thumbnail recording mode. Default:
INTERVAL
. - See Also:
-
recordingModeAsString
Thumbnail recording mode. Default:
INTERVAL
.If the service returns an enum value that is not available in the current SDK version,
recordingMode
will returnRecordingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrecordingModeAsString()
.- Returns:
- Thumbnail recording mode. Default:
INTERVAL
. - See Also:
-
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 returnThumbnailConfigurationResolution.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresolutionAsString()
.- 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:
-
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 returnThumbnailConfigurationResolution.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresolutionAsString()
.- 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:
-
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 bytargetIntervalSeconds
. You can enable bothSEQUENTIAL
andLATEST
. 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 bytargetIntervalSeconds
. You can enable bothSEQUENTIAL
andLATEST
. 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 theisEmpty()
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
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 bytargetIntervalSeconds
. You can enable bothSEQUENTIAL
andLATEST
. 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 bytargetIntervalSeconds
. You can enable bothSEQUENTIAL
andLATEST
. Default:SEQUENTIAL
.
-
targetIntervalSeconds
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if
recordingMode
isINTERVAL
. Default: 60.Important: For the
BASIC
channel type, setting a value fortargetIntervalSeconds
does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at thetargetIntervalSeconds
interval, theIDR/Keyframe
value for the input video must be less than thetargetIntervalSeconds
value. See Amazon IVS Streaming Configuration for information on settingIDR/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
isINTERVAL
. Default: 60.Important: For the
BASIC
channel type, setting a value fortargetIntervalSeconds
does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at thetargetIntervalSeconds
interval, theIDR/Keyframe
value for the input video must be less than thetargetIntervalSeconds
value. See Amazon IVS Streaming Configuration for information on settingIDR/Keyframe
to the recommended value in video-encoder settings.
-
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 interfaceToCopyableBuilder<ThumbnailConfiguration.Builder,
ThumbnailConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-