You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticTranscoder::Types::Artwork

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb

Overview

Note:

When making an API call, you may pass Artwork data as a 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

Instance Attribute Details

#album_art_formatString

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

Returns:

  • (String)


119
120
121
122
123
124
125
126
127
128
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 119

class Artwork < Struct.new(
  :input_key,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy,
  :album_art_format,
  :encryption)
  include Aws::Structure
end

#encryptionTypes::Encryption

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

Returns:



119
120
121
122
123
124
125
126
127
128
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 119

class Artwork < Struct.new(
  :input_key,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy,
  :album_art_format,
  :encryption)
  include Aws::Structure
end

#input_keyString

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:

  • (String)


119
120
121
122
123
124
125
126
127
128
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 119

class Artwork < Struct.new(
  :input_key,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy,
  :album_art_format,
  :encryption)
  include Aws::Structure
end

#max_heightString

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:

  • (String)


119
120
121
122
123
124
125
126
127
128
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 119

class Artwork < Struct.new(
  :input_key,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy,
  :album_art_format,
  :encryption)
  include Aws::Structure
end

#max_widthString

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:

  • (String)


119
120
121
122
123
124
125
126
127
128
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 119

class Artwork < Struct.new(
  :input_key,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy,
  :album_art_format,
  :encryption)
  include Aws::Structure
end

#padding_policyString

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:

  • (String)


119
120
121
122
123
124
125
126
127
128
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 119

class Artwork < Struct.new(
  :input_key,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy,
  :album_art_format,
  :encryption)
  include Aws::Structure
end

#sizing_policyString

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:

  • (String)


119
120
121
122
123
124
125
126
127
128
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 119

class Artwork < Struct.new(
  :input_key,
  :max_width,
  :max_height,
  :sizing_policy,
  :padding_policy,
  :album_art_format,
  :encryption)
  include Aws::Structure
end