Class Thumbnails
- java.lang.Object
-
- software.amazon.awssdk.services.elastictranscoder.model.Thumbnails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Thumbnails.Builder,Thumbnails>
@Generated("software.amazon.awssdk:codegen") public final class Thumbnails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Thumbnails.Builder,Thumbnails>
Thumbnails for videos.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceThumbnails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaspectRatio()static Thumbnails.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Stringformat()The format of thumbnails, if any.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringinterval()The approximate number of seconds between thumbnails.StringmaxHeight()The maximum height of thumbnails in pixels.StringmaxWidth()The maximum width of thumbnails in pixels.StringpaddingPolicy()When you setPaddingPolicytoPad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnailMaxWidthandMaxHeightsettings.Stringresolution()List<SdkField<?>>sdkFields()static Class<? extends Thumbnails.Builder>serializableBuilderClass()StringsizingPolicy()Specify one of the following values to control scaling of thumbnails:Thumbnails.BuildertoBuilder()StringtoString()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
-
format
public final String format()
The format of thumbnails, if any. Valid values are
jpgandpng.You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
- Returns:
- The format of thumbnails, if any. Valid values are
jpgandpng.You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
-
interval
public final String interval()
The approximate number of seconds between thumbnails. Specify an integer value.
- Returns:
- The approximate number of seconds between thumbnails. Specify an integer value.
-
resolution
public final String resolution()
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values
MaxWidth,MaxHeight,SizingPolicy, andPaddingPolicyinstead ofResolutionandAspectRatio. The two groups of settings are mutually exclusive. Do not use them together.The width and height of thumbnail files in pixels. Specify a value in the format
widthxheightwhere both values are even integers. The values cannot exceed the width and height that you specified in theVideo:Resolutionobject.- Returns:
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values
MaxWidth,MaxHeight,SizingPolicy, andPaddingPolicyinstead ofResolutionandAspectRatio. The two groups of settings are mutually exclusive. Do not use them together.The width and height of thumbnail files in pixels. Specify a value in the format
widthxheightwhere both values are even integers. The values cannot exceed the width and height that you specified in theVideo:Resolutionobject.
-
aspectRatio
public final String aspectRatio()
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values
MaxWidth,MaxHeight,SizingPolicy, andPaddingPolicyinstead ofResolutionandAspectRatio. The two groups of settings are mutually exclusive. Do not use them together.The aspect ratio of thumbnails. Valid values include:
auto,1:1,4:3,3:2,16:9If you specify
auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.- Returns:
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values
MaxWidth,MaxHeight,SizingPolicy, andPaddingPolicyinstead ofResolutionandAspectRatio. The two groups of settings are mutually exclusive. Do not use them together.The aspect ratio of thumbnails. Valid values include:
auto,1:1,4:3,3:2,16:9If you specify
auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.
-
maxWidth
public final String maxWidth()
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
- Returns:
- The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
-
maxHeight
public final String maxHeight()
The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.
- Returns:
- The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.
-
sizingPolicy
public final String sizingPolicy()
Specify one of the following values to control scaling of thumbnails:
-
Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. -
Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnailMaxWidthorMaxHeightsettings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value. -
Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnailMaxWidthandMaxHeightsettings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted. -
Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnailMaxWidthandMaxHeightsettings, Elastic Transcoder crops the thumbnails. -
ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnailMaxWidthandMaxHeightwithout exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up. -
ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
- Returns:
- Specify one of the following values to control scaling of thumbnails:
-
Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. -
Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnailMaxWidthorMaxHeightsettings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value. -
Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnailMaxWidthandMaxHeightsettings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted. -
Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnailMaxWidthandMaxHeightsettings, Elastic Transcoder crops the thumbnails. -
ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnailMaxWidthandMaxHeightwithout exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up. -
ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
-
-
-
paddingPolicy
public final String paddingPolicy()
When you set
PaddingPolicytoPad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnailMaxWidthandMaxHeightsettings.- Returns:
- When you set
PaddingPolicytoPad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnailMaxWidthandMaxHeightsettings.
-
toBuilder
public Thumbnails.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Thumbnails.Builder,Thumbnails>
-
builder
public static Thumbnails.Builder builder()
-
serializableBuilderClass
public static Class<? extends Thumbnails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-