Amazonka.ElasticTranscoder.Types.Artwork

Documentation

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

See: newArtwork smart constructor.

Constructors

Artwork'

Fields

• albumArtFormat :: Maybe Text

  The format of album art, if any. Valid formats are .jpg and .png.

• encryption :: Maybe Encryption

  The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.

• inputKey :: Maybe Text

  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.

• maxHeight :: Maybe Text

  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.

• maxWidth :: Maybe Text

  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.

• paddingPolicy :: Maybe Text

  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.

• sizingPolicy :: Maybe Text

  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.

Instances

FromJSON Artwork

Defined in Amazonka.ElasticTranscoder.Types.Artwork

Methods

parseJSON :: Value -> Parser Artwork

parseJSONList :: Value -> Parser [Artwork]

ToJSON Artwork

Defined in Amazonka.ElasticTranscoder.Types.Artwork

Methods

toJSON :: Artwork -> Value

toEncoding :: Artwork -> Encoding

toJSONList :: [Artwork] -> Value

toEncodingList :: [Artwork] -> Encoding

Generic Artwork

Defined in Amazonka.ElasticTranscoder.Types.Artwork

Associated Types

type Rep Artwork :: Type -> Type

Methods

from :: Artwork -> Rep Artwork x

to :: Rep Artwork x -> Artwork

Read Artwork

Defined in Amazonka.ElasticTranscoder.Types.Artwork

Methods

readsPrec :: Int -> ReadS Artwork

readList :: ReadS [Artwork]

readPrec :: ReadPrec Artwork

readListPrec :: ReadPrec [Artwork]

Show Artwork

Defined in Amazonka.ElasticTranscoder.Types.Artwork

Methods

showsPrec :: Int -> Artwork -> ShowS

show :: Artwork -> String

showList :: [Artwork] -> ShowS

NFData Artwork

Defined in Amazonka.ElasticTranscoder.Types.Artwork

Methods

rnf :: Artwork -> ()

Eq Artwork

Defined in Amazonka.ElasticTranscoder.Types.Artwork

Methods

(==) :: Artwork -> Artwork -> Bool

(/=) :: Artwork -> Artwork -> Bool

Hashable Artwork

Defined in Amazonka.ElasticTranscoder.Types.Artwork

Methods

hashWithSalt :: Int -> Artwork -> Int

hash :: Artwork -> Int

type Rep Artwork

Defined in Amazonka.ElasticTranscoder.Types.Artwork

type Rep Artwork = D1 ('MetaData "Artwork" "Amazonka.ElasticTranscoder.Types.Artwork" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "Artwork'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "albumArtFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "encryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Encryption)) :*: S1 ('MetaSel ('Just "inputKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "maxHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "paddingPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sizingPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newArtwork :: Artwork

Create a value of Artwork with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:albumArtFormat:Artwork', artwork_albumArtFormat - The format of album art, if any. Valid formats are .jpg and .png.

$sel:encryption:Artwork', artwork_encryption - The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.

$sel:inputKey:Artwork', artwork_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.

$sel:maxHeight:Artwork', artwork_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.

$sel:maxWidth:Artwork', artwork_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.

$sel:paddingPolicy:Artwork', artwork_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.

$sel:sizingPolicy:Artwork', artwork_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.

artwork_albumArtFormat :: Lens' Artwork (Maybe Text)

The format of album art, if any. Valid formats are .jpg and .png.

artwork_encryption :: Lens' Artwork (Maybe Encryption)

The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.

artwork_inputKey :: Lens' Artwork (Maybe Text)

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.

artwork_maxHeight :: Lens' Artwork (Maybe Text)

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.

artwork_maxWidth :: Lens' Artwork (Maybe Text)

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.

artwork_paddingPolicy :: Lens' Artwork (Maybe Text)

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_sizingPolicy :: Lens' Artwork (Maybe Text)

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.