Interface Artwork.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Artwork.Builder,
,Artwork> SdkBuilder<Artwork.Builder,
,Artwork> SdkPojo
- Enclosing class:
Artwork
-
Method Summary
Modifier and TypeMethodDescriptionalbumArtFormat
(String albumArtFormat) The format of album art, if any.default Artwork.Builder
encryption
(Consumer<Encryption.Builder> encryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.encryption
(Encryption encryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.The name of the file to be used as album art.The maximum height of the output album art in pixels.The maximum width of the output album art in pixels.paddingPolicy
(String paddingPolicy) When you setPaddingPolicy
toPad
, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified forMaxWidth
andMaxHeight
.sizingPolicy
(String sizingPolicy) Specify one of the following values to control scaling of the output album art:Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
inputKey
The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by
PipelineId
; theInputBucket
object in that pipeline identifies the bucket.If the file name includes a prefix, for example,
cooking/pie.jpg
, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.- Parameters:
inputKey
- The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified byPipelineId
; theInputBucket
object in that pipeline identifies the bucket.If the file name includes a prefix, for example,
cooking/pie.jpg
, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxWidth
The maximum width of the output album art in pixels. If you specify
auto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.- Parameters:
maxWidth
- The maximum width of the output album art in pixels. If you specifyauto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxHeight
The maximum height of the output album art in pixels. If you specify
auto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.- Parameters:
maxHeight
- The maximum height of the output album art in pixels. If you specifyauto
, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sizingPolicy
Specify one of the following values to control scaling of the output album art:
-
Fit:
Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidth
orMaxHeight
without exceeding the other value. -
Fill:
Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidth
orMaxHeight
and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value. -
Stretch:
Elastic Transcoder stretches the output art to match the values that you specified forMaxWidth
andMaxHeight
. If the relative proportions of the input art and the output art are different, the output art will be distorted. -
Keep:
Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified forMaxWidth
andMaxHeight
, Elastic Transcoder crops the output art. -
ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up. -
ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.
- Parameters:
sizingPolicy
- Specify one of the following values to control scaling of the output album art:-
Fit:
Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidth
orMaxHeight
without exceeding the other value. -
Fill:
Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidth
orMaxHeight
and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value. -
Stretch:
Elastic Transcoder stretches the output art to match the values that you specified forMaxWidth
andMaxHeight
. If the relative proportions of the input art and the output art are different, the output art will be distorted. -
Keep:
Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified forMaxWidth
andMaxHeight
, Elastic Transcoder crops the output art. -
ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up. -
ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one ofMaxWidth
andMaxHeight
without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
paddingPolicy
When you set
PaddingPolicy
toPad
, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified forMaxWidth
andMaxHeight
.- Parameters:
paddingPolicy
- When you setPaddingPolicy
toPad
, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified forMaxWidth
andMaxHeight
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
albumArtFormat
The format of album art, if any. Valid formats are
.jpg
and.png
.- Parameters:
albumArtFormat
- The format of album art, if any. Valid formats are.jpg
and.png
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
- Parameters:
encryption
- The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
This is a convenience method that creates an instance of theEncryption.Builder
avoiding the need to create one manually viaEncryption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryption(Encryption)
.- Parameters:
encryption
- a consumer that will call methods onEncryption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-