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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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, or the STANDARD channel type with multitrack input, 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, or the STANDARD channel type with multitrack input, 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()
      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 interface ToCopyableBuilder<ThumbnailConfiguration.Builder,ThumbnailConfiguration>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.