AWS SDK for C++  1.9.68
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticTranscoder::Model::Artwork Class Reference

#include <Artwork.h>

Public Member Functions

 Artwork ()
 
 Artwork (Aws::Utils::Json::JsonView jsonValue)
 
Artworkoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetInputKey () const
 
bool InputKeyHasBeenSet () const
 
void SetInputKey (const Aws::String &value)
 
void SetInputKey (Aws::String &&value)
 
void SetInputKey (const char *value)
 
ArtworkWithInputKey (const Aws::String &value)
 
ArtworkWithInputKey (Aws::String &&value)
 
ArtworkWithInputKey (const char *value)
 
const Aws::StringGetMaxWidth () const
 
bool MaxWidthHasBeenSet () const
 
void SetMaxWidth (const Aws::String &value)
 
void SetMaxWidth (Aws::String &&value)
 
void SetMaxWidth (const char *value)
 
ArtworkWithMaxWidth (const Aws::String &value)
 
ArtworkWithMaxWidth (Aws::String &&value)
 
ArtworkWithMaxWidth (const char *value)
 
const Aws::StringGetMaxHeight () const
 
bool MaxHeightHasBeenSet () const
 
void SetMaxHeight (const Aws::String &value)
 
void SetMaxHeight (Aws::String &&value)
 
void SetMaxHeight (const char *value)
 
ArtworkWithMaxHeight (const Aws::String &value)
 
ArtworkWithMaxHeight (Aws::String &&value)
 
ArtworkWithMaxHeight (const char *value)
 
const Aws::StringGetSizingPolicy () const
 
bool SizingPolicyHasBeenSet () const
 
void SetSizingPolicy (const Aws::String &value)
 
void SetSizingPolicy (Aws::String &&value)
 
void SetSizingPolicy (const char *value)
 
ArtworkWithSizingPolicy (const Aws::String &value)
 
ArtworkWithSizingPolicy (Aws::String &&value)
 
ArtworkWithSizingPolicy (const char *value)
 
const Aws::StringGetPaddingPolicy () const
 
bool PaddingPolicyHasBeenSet () const
 
void SetPaddingPolicy (const Aws::String &value)
 
void SetPaddingPolicy (Aws::String &&value)
 
void SetPaddingPolicy (const char *value)
 
ArtworkWithPaddingPolicy (const Aws::String &value)
 
ArtworkWithPaddingPolicy (Aws::String &&value)
 
ArtworkWithPaddingPolicy (const char *value)
 
const Aws::StringGetAlbumArtFormat () const
 
bool AlbumArtFormatHasBeenSet () const
 
void SetAlbumArtFormat (const Aws::String &value)
 
void SetAlbumArtFormat (Aws::String &&value)
 
void SetAlbumArtFormat (const char *value)
 
ArtworkWithAlbumArtFormat (const Aws::String &value)
 
ArtworkWithAlbumArtFormat (Aws::String &&value)
 
ArtworkWithAlbumArtFormat (const char *value)
 
const EncryptionGetEncryption () const
 
bool EncryptionHasBeenSet () const
 
void SetEncryption (const Encryption &value)
 
void SetEncryption (Encryption &&value)
 
ArtworkWithEncryption (const Encryption &value)
 
ArtworkWithEncryption (Encryption &&value)
 

Detailed Description

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:

AWS API Reference

Definition at line 38 of file Artwork.h.

Constructor & Destructor Documentation

◆ Artwork() [1/2]

Aws::ElasticTranscoder::Model::Artwork::Artwork ( )

◆ Artwork() [2/2]

Aws::ElasticTranscoder::Model::Artwork::Artwork ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AlbumArtFormatHasBeenSet()

bool Aws::ElasticTranscoder::Model::Artwork::AlbumArtFormatHasBeenSet ( ) const
inline

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

Definition at line 574 of file Artwork.h.

◆ EncryptionHasBeenSet()

bool Aws::ElasticTranscoder::Model::Artwork::EncryptionHasBeenSet ( ) const
inline

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

Definition at line 623 of file Artwork.h.

◆ GetAlbumArtFormat()

const Aws::String& Aws::ElasticTranscoder::Model::Artwork::GetAlbumArtFormat ( ) const
inline

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

Definition at line 568 of file Artwork.h.

◆ GetEncryption()

const Encryption& Aws::ElasticTranscoder::Model::Artwork::GetEncryption ( ) const
inline

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

Definition at line 617 of file Artwork.h.

◆ GetInputKey()

const Aws::String& Aws::ElasticTranscoder::Model::Artwork::GetInputKey ( ) const
inline

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.

Definition at line 55 of file Artwork.h.

◆ GetMaxHeight()

const Aws::String& Aws::ElasticTranscoder::Model::Artwork::GetMaxHeight ( ) const
inline

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.

Definition at line 199 of file Artwork.h.

◆ GetMaxWidth()

const Aws::String& Aws::ElasticTranscoder::Model::Artwork::GetMaxWidth ( ) const
inline

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.

Definition at line 134 of file Artwork.h.

◆ GetPaddingPolicy()

const Aws::String& Aws::ElasticTranscoder::Model::Artwork::GetPaddingPolicy ( ) const
inline

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.

Definition at line 498 of file Artwork.h.

◆ GetSizingPolicy()

const Aws::String& Aws::ElasticTranscoder::Model::Artwork::GetSizingPolicy ( ) const
inline

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.

Definition at line 285 of file Artwork.h.

◆ InputKeyHasBeenSet()

bool Aws::ElasticTranscoder::Model::Artwork::InputKeyHasBeenSet ( ) const
inline

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.

Definition at line 65 of file Artwork.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ElasticTranscoder::Model::Artwork::Jsonize ( ) const

◆ MaxHeightHasBeenSet()

bool Aws::ElasticTranscoder::Model::Artwork::MaxHeightHasBeenSet ( ) const
inline

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.

Definition at line 207 of file Artwork.h.

◆ MaxWidthHasBeenSet()

bool Aws::ElasticTranscoder::Model::Artwork::MaxWidthHasBeenSet ( ) const
inline

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.

Definition at line 142 of file Artwork.h.

◆ operator=()

Artwork& Aws::ElasticTranscoder::Model::Artwork::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PaddingPolicyHasBeenSet()

bool Aws::ElasticTranscoder::Model::Artwork::PaddingPolicyHasBeenSet ( ) const
inline

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.

Definition at line 507 of file Artwork.h.

◆ SetAlbumArtFormat() [1/3]

void Aws::ElasticTranscoder::Model::Artwork::SetAlbumArtFormat ( Aws::String &&  value)
inline

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

Definition at line 586 of file Artwork.h.

◆ SetAlbumArtFormat() [2/3]

void Aws::ElasticTranscoder::Model::Artwork::SetAlbumArtFormat ( const Aws::String value)
inline

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

Definition at line 580 of file Artwork.h.

◆ SetAlbumArtFormat() [3/3]

void Aws::ElasticTranscoder::Model::Artwork::SetAlbumArtFormat ( const char *  value)
inline

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

Definition at line 592 of file Artwork.h.

◆ SetEncryption() [1/2]

void Aws::ElasticTranscoder::Model::Artwork::SetEncryption ( const Encryption value)
inline

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

Definition at line 629 of file Artwork.h.

◆ SetEncryption() [2/2]

void Aws::ElasticTranscoder::Model::Artwork::SetEncryption ( Encryption &&  value)
inline

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

Definition at line 635 of file Artwork.h.

◆ SetInputKey() [1/3]

void Aws::ElasticTranscoder::Model::Artwork::SetInputKey ( Aws::String &&  value)
inline

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.

Definition at line 85 of file Artwork.h.

◆ SetInputKey() [2/3]

void Aws::ElasticTranscoder::Model::Artwork::SetInputKey ( const Aws::String value)
inline

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.

Definition at line 75 of file Artwork.h.

◆ SetInputKey() [3/3]

void Aws::ElasticTranscoder::Model::Artwork::SetInputKey ( const char *  value)
inline

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.

Definition at line 95 of file Artwork.h.

◆ SetMaxHeight() [1/3]

void Aws::ElasticTranscoder::Model::Artwork::SetMaxHeight ( Aws::String &&  value)
inline

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.

Definition at line 223 of file Artwork.h.

◆ SetMaxHeight() [2/3]

void Aws::ElasticTranscoder::Model::Artwork::SetMaxHeight ( const Aws::String value)
inline

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.

Definition at line 215 of file Artwork.h.

◆ SetMaxHeight() [3/3]

void Aws::ElasticTranscoder::Model::Artwork::SetMaxHeight ( const char *  value)
inline

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.

Definition at line 231 of file Artwork.h.

◆ SetMaxWidth() [1/3]

void Aws::ElasticTranscoder::Model::Artwork::SetMaxWidth ( Aws::String &&  value)
inline

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.

Definition at line 158 of file Artwork.h.

◆ SetMaxWidth() [2/3]

void Aws::ElasticTranscoder::Model::Artwork::SetMaxWidth ( const Aws::String value)
inline

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.

Definition at line 150 of file Artwork.h.

◆ SetMaxWidth() [3/3]

void Aws::ElasticTranscoder::Model::Artwork::SetMaxWidth ( const char *  value)
inline

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.

Definition at line 166 of file Artwork.h.

◆ SetPaddingPolicy() [1/3]

void Aws::ElasticTranscoder::Model::Artwork::SetPaddingPolicy ( Aws::String &&  value)
inline

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.

Definition at line 525 of file Artwork.h.

◆ SetPaddingPolicy() [2/3]

void Aws::ElasticTranscoder::Model::Artwork::SetPaddingPolicy ( const Aws::String value)
inline

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.

Definition at line 516 of file Artwork.h.

◆ SetPaddingPolicy() [3/3]

void Aws::ElasticTranscoder::Model::Artwork::SetPaddingPolicy ( const char *  value)
inline

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.

Definition at line 534 of file Artwork.h.

◆ SetSizingPolicy() [1/3]

void Aws::ElasticTranscoder::Model::Artwork::SetSizingPolicy ( Aws::String &&  value)
inline

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.

Definition at line 372 of file Artwork.h.

◆ SetSizingPolicy() [2/3]

void Aws::ElasticTranscoder::Model::Artwork::SetSizingPolicy ( const Aws::String value)
inline

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.

Definition at line 343 of file Artwork.h.

◆ SetSizingPolicy() [3/3]

void Aws::ElasticTranscoder::Model::Artwork::SetSizingPolicy ( const char *  value)
inline

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.

Definition at line 401 of file Artwork.h.

◆ SizingPolicyHasBeenSet()

bool Aws::ElasticTranscoder::Model::Artwork::SizingPolicyHasBeenSet ( ) const
inline

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.

Definition at line 314 of file Artwork.h.

◆ WithAlbumArtFormat() [1/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithAlbumArtFormat ( Aws::String &&  value)
inline

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

Definition at line 604 of file Artwork.h.

◆ WithAlbumArtFormat() [2/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithAlbumArtFormat ( const Aws::String value)
inline

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

Definition at line 598 of file Artwork.h.

◆ WithAlbumArtFormat() [3/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithAlbumArtFormat ( const char *  value)
inline

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

Definition at line 610 of file Artwork.h.

◆ WithEncryption() [1/2]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithEncryption ( const Encryption value)
inline

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

Definition at line 641 of file Artwork.h.

◆ WithEncryption() [2/2]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithEncryption ( Encryption &&  value)
inline

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

Definition at line 647 of file Artwork.h.

◆ WithInputKey() [1/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithInputKey ( Aws::String &&  value)
inline

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.

Definition at line 115 of file Artwork.h.

◆ WithInputKey() [2/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithInputKey ( const Aws::String value)
inline

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.

Definition at line 105 of file Artwork.h.

◆ WithInputKey() [3/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithInputKey ( const char *  value)
inline

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.

Definition at line 125 of file Artwork.h.

◆ WithMaxHeight() [1/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithMaxHeight ( Aws::String &&  value)
inline

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.

Definition at line 247 of file Artwork.h.

◆ WithMaxHeight() [2/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithMaxHeight ( const Aws::String value)
inline

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.

Definition at line 239 of file Artwork.h.

◆ WithMaxHeight() [3/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithMaxHeight ( const char *  value)
inline

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.

Definition at line 255 of file Artwork.h.

◆ WithMaxWidth() [1/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithMaxWidth ( Aws::String &&  value)
inline

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.

Definition at line 182 of file Artwork.h.

◆ WithMaxWidth() [2/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithMaxWidth ( const Aws::String value)
inline

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.

Definition at line 174 of file Artwork.h.

◆ WithMaxWidth() [3/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithMaxWidth ( const char *  value)
inline

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.

Definition at line 190 of file Artwork.h.

◆ WithPaddingPolicy() [1/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithPaddingPolicy ( Aws::String &&  value)
inline

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.

Definition at line 552 of file Artwork.h.

◆ WithPaddingPolicy() [2/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithPaddingPolicy ( const Aws::String value)
inline

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.

Definition at line 543 of file Artwork.h.

◆ WithPaddingPolicy() [3/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithPaddingPolicy ( const char *  value)
inline

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.

Definition at line 561 of file Artwork.h.

◆ WithSizingPolicy() [1/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithSizingPolicy ( Aws::String &&  value)
inline

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.

Definition at line 459 of file Artwork.h.

◆ WithSizingPolicy() [2/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithSizingPolicy ( const Aws::String value)
inline

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.

Definition at line 430 of file Artwork.h.

◆ WithSizingPolicy() [3/3]

Artwork& Aws::ElasticTranscoder::Model::Artwork::WithSizingPolicy ( const char *  value)
inline

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.

Definition at line 488 of file Artwork.h.


The documentation for this class was generated from the following file: