Artwork (AWS SDK for Java 1.7.15 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.elastictranscoder.model
Class Artwork

java.lang.Object
  com.amazonaws.services.elastictranscoder.model.Artwork

All Implemented Interfaces:: Serializable

public class Artwork
extends Object
implements Serializable
extends Object
implements Serializable

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:: Serialized Form

Constructor Summary
`Artwork()`

Method Summary
`boolean`	`equals(Object obj)`
`String`	`getAlbumArtFormat()` The format of album art, if any.
`String`	`getInputKey()` The name of the file to be used as album art.
`String`	`getMaxHeight()` The maximum height of the output album art in pixels.
`String`	`getMaxWidth()` The maximum width of the output album art in pixels.
`String`	`getPaddingPolicy()` 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`.
`String`	`getSizingPolicy()` 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`	`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 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`.
`void`	`setSizingPolicy(String sizingPolicy)` Specify one of the following values to control scaling of the output album art:
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Artwork`	`withAlbumArtFormat(String albumArtFormat)` The format of album art, if any.
`Artwork`	`withInputKey(String inputKey)` The name of the file to be used as album art.
`Artwork`	`withMaxHeight(String maxHeight)` The maximum height of the output album art in pixels.
`Artwork`	`withMaxWidth(String maxWidth)` The maximum width of the output album art in pixels.
`Artwork`	`withPaddingPolicy(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`.
`Artwork`	`withSizingPolicy(String sizingPolicy)` Specify one of the following values to control scaling of the output album art:

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

Constructor Detail

Artwork

public Artwork()

Method Detail

getInputKey

public String 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; 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.

Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)

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.

setInputKey

public void setInputKey(String inputKey)

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.

Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)

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 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.

withInputKey

public Artwork withInputKey(String inputKey)

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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)

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 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:: A reference to this updated object so that method calls can be chained together.

getMaxWidth

public String 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.