Artwork (AWS SDK for Java - 2.0.0-preview-1)

java.lang.Object
- software.amazon.awssdk.services.elastictranscoder.model.Artwork

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Artwork.Builder,Artwork>
```
@Generated("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.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Artwork.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`Artwork.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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)`
`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()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - inputKey
```
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.
    
    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; 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.
  - maxWidth
```
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.
    
    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.
  - maxHeight
```
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.
    
    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.
  - sizingPolicy
```
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.
    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 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.
  - paddingPolicy
```
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.
    
    Returns:
    
    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.
  - albumArtFormat
```
public String albumArtFormat()
```
    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.
  - encryption
```
public Encryption encryption()
```
    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.
  - toBuilder
```
public Artwork.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<Artwork.Builder,Artwork>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Artwork.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Artwork.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class Artwork

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

inputKey

maxWidth

maxHeight

sizingPolicy

paddingPolicy

albumArtFormat

encryption

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall