@Generated(value="software.amazon.awssdk:codegen") public class Artwork extends Object implements StructuredPojo, ToCopyableBuilder<Artwork.Builder,Artwork>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
Artwork.Builder |
Modifier and Type | Method and Description |
---|---|
String |
albumArtFormat()
The format of album art, if any.
|
static Artwork.Builder |
builder() |
Encryption |
encryption()
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
inputKey()
The name of the file to be used as album art.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
maxHeight()
The maximum height of the output album art in pixels.
|
String |
maxWidth()
The maximum width of the output album art in pixels.
|
String |
paddingPolicy()
When you set
PaddingPolicy to Pad , 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 for MaxWidth and MaxHeight . |
static Class<? extends Artwork.Builder> |
serializableBuilderClass() |
String |
sizingPolicy()
Specify one of the following values to control scaling of the output album art:
|
Artwork.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String 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
; the InputBucket
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.
PipelineId
; the
InputBucket
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.
public String 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.
auto
, Elastic Transcoder
uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096,
inclusive.public String 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.
auto
, Elastic
Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between
32 and 3072, inclusive.public String 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 either
MaxWidth
or MaxHeight
without exceeding the other value.
Fill:
Elastic Transcoder scales the output art so it matches the value that you specified in either
MaxWidth
or MaxHeight
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 for
MaxWidth
and MaxHeight
. 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 for MaxWidth
and MaxHeight
, 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 of MaxWidth
and MaxHeight
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 of MaxWidth
and MaxHeight
without dropping below
either value. If you specify this option, Elastic Transcoder does not scale the art up.
Fit:
Elastic Transcoder scales the output art so it matches the value that you specified in
either MaxWidth
or MaxHeight
without exceeding the other value.
Fill:
Elastic Transcoder scales the output art so it matches the value that you specified in
either MaxWidth
or MaxHeight
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
for MaxWidth
and MaxHeight
. 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 for MaxWidth
and MaxHeight
, 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 of MaxWidth
and MaxHeight
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 of MaxWidth
and MaxHeight
without
dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.
public String paddingPolicy()
When you set PaddingPolicy
to Pad
, 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 for MaxWidth
and MaxHeight
.
PaddingPolicy
to Pad
, 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 for MaxWidth
and MaxHeight
.public String albumArtFormat()
The format of album art, if any. Valid formats are .jpg
and .png
.
.jpg
and .png
.public Encryption encryption()
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
public Artwork.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Artwork.Builder,Artwork>
public static Artwork.Builder builder()
public static Class<? extends Artwork.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.