Class Artwork
- All Implemented Interfaces:
Serializable
,Cloneable
The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20.
To remove artwork or leave the artwork empty, you can either set
Artwork
to null, or set the Merge Policy
to
"Replace" and use an empty Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to "Prepend", "Append", or "Fallback", and use an empty Artwork
array.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The format of album art, if any.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.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
.Specify one of the following values to control scaling of the output album art:int
hashCode()
void
setAlbumArtFormat
(String albumArtFormat) The format of album art, if any.void
setEncryption
(Encryption encryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.void
setInputKey
(String inputKey) The name of the file to be used as album art.void
setMaxHeight
(String maxHeight) The maximum height of the output album art in pixels.void
setMaxWidth
(String maxWidth) The maximum width of the output album art in pixels.void
setPaddingPolicy
(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
.void
setSizingPolicy
(String sizingPolicy) Specify one of the following values to control scaling of the output album art:toString()
Returns a string representation of this object; useful for testing and debugging.withAlbumArtFormat
(String albumArtFormat) The format of album art, if any.withEncryption
(Encryption encryption) The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.withInputKey
(String inputKey) The name of the file to be used as album art.withMaxHeight
(String maxHeight) The maximum height of the output album art in pixels.withMaxWidth
(String maxWidth) The maximum width of the output album art in pixels.withPaddingPolicy
(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
.withSizingPolicy
(String sizingPolicy) Specify one of the following values to control scaling of the output album art:
-
Constructor Details
-
Artwork
public Artwork()
-
-
Method Details
-
setInputKey
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.
-
getInputKey
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.- Returns:
- 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.
-
withInputKey
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.
-
setMaxWidth
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.
-
getMaxWidth
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.- Returns:
- 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.
-
withMaxWidth
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.
-
setMaxHeight
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.
-
getMaxHeight
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.- Returns:
- 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.
-
withMaxHeight
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.
-
setSizingPolicy
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.
-
-
-
getSizingPolicy
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:
- 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.
-
-
-
withSizingPolicy
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.
-
-
setPaddingPolicy
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
.
-
getPaddingPolicy
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
.- Returns:
- 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
.
-
withPaddingPolicy
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.
-
setAlbumArtFormat
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
.
-
getAlbumArtFormat
The format of album art, if any. Valid formats are
.jpg
and.png
.- Returns:
- The format of album art, if any. Valid formats are
.jpg
and.png
.
-
withAlbumArtFormat
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.
-
setEncryption
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.
-
getEncryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
- Returns:
- The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
-
withEncryption
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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-