You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ElasticTranscoder::Types::Artwork
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElasticTranscoder::Types::Artwork
- Defined in:
- (unknown)
Overview
When passing Artwork as input to an Aws::Client method, you can use a vanilla Hash:
{
input_key: "WatermarkKey",
max_width: "DigitsOrAuto",
max_height: "DigitsOrAuto",
sizing_policy: "SizingPolicy",
padding_policy: "PaddingPolicy",
album_art_format: "JpgOrPng",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
}
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.
Instance Attribute Summary collapse
-
#album_art_format ⇒ String
The format of album art, if any.
-
#encryption ⇒ Types::Encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
-
#input_key ⇒ String
The name of the file to be used as album art.
-
#max_height ⇒ String
The maximum height of the output album art in pixels.
-
#max_width ⇒ String
The maximum width of the output album art in pixels.
-
#padding_policy ⇒ String
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
. -
#sizing_policy ⇒ String
Specify one of the following values to control scaling of the output album art:.
Instance Attribute Details
#album_art_format ⇒ String
The format of album art, if any. Valid formats are .jpg
and .png
.
#encryption ⇒ Types::Encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
#input_key ⇒ String
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.
#max_height ⇒ String
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.
#max_width ⇒ String
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.
#padding_policy ⇒ String
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
.
#sizing_policy ⇒ String
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.