« blib/lib/Paws/ElasticInference/UntagResourceResult.pm
↑ Summary
blib/lib/Paws/ElasticTranscoder/AudioCodecOptions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElasticTranscoder::Artwork; | ||
| 3 | use Moose; | ||
| 4 | has AlbumArtFormat => (is => 'ro', isa => 'Str'); | ||
| 5 | has Encryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption'); | ||
| 6 | has InputKey => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxHeight => (is => 'ro', isa => 'Str'); | ||
| 8 | has MaxWidth => (is => 'ro', isa => 'Str'); | ||
| 9 | has PaddingPolicy => (is => 'ro', isa => 'Str'); | ||
| 10 | has SizingPolicy => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::ElasticTranscoder::Artwork | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::ElasticTranscoder::Artwork object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { AlbumArtFormat => $value, ..., SizingPolicy => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::Artwork object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->AlbumArtFormat | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | The file to be used as album art. There can be multiple artworks | ||
| 43 | associated with an audio file, to a maximum of 20. | ||
| 44 | |||
| 45 | To remove artwork or leave the artwork empty, you can either set | ||
| 46 | C<Artwork> to null, or set the C<Merge Policy> to "Replace" and use an | ||
| 47 | empty C<Artwork> array. | ||
| 48 | |||
| 49 | To pass through existing artwork unchanged, set the C<Merge Policy> to | ||
| 50 | "Prepend", "Append", or "Fallback", and use an empty C<Artwork> array. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 AlbumArtFormat => Str | ||
| 56 | |||
| 57 | The format of album art, if any. Valid formats are C<.jpg> and C<.png>. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Encryption => L<Paws::ElasticTranscoder::Encryption> | ||
| 61 | |||
| 62 | The encryption settings, if any, that you want Elastic Transcoder to | ||
| 63 | apply to your artwork. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 InputKey => Str | ||
| 67 | |||
| 68 | The name of the file to be used as album art. To determine which Amazon | ||
| 69 | S3 bucket contains the specified file, Elastic Transcoder checks the | ||
| 70 | pipeline specified by C<PipelineId>; the C<InputBucket> object in that | ||
| 71 | pipeline identifies the bucket. | ||
| 72 | |||
| 73 | If the file name includes a prefix, for example, C<cooking/pie.jpg>, | ||
| 74 | include the prefix in the key. If the file isn't in the specified | ||
| 75 | bucket, Elastic Transcoder returns an error. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 MaxHeight => Str | ||
| 79 | |||
| 80 | The maximum height of the output album art in pixels. If you specify | ||
| 81 | C<auto>, Elastic Transcoder uses 600 as the default value. If you | ||
| 82 | specify a numeric value, enter an even integer between 32 and 3072, | ||
| 83 | inclusive. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 MaxWidth => Str | ||
| 87 | |||
| 88 | The maximum width of the output album art in pixels. If you specify | ||
| 89 | C<auto>, Elastic Transcoder uses 600 as the default value. If you | ||
| 90 | specify a numeric value, enter an even integer between 32 and 4096, | ||
| 91 | inclusive. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 PaddingPolicy => Str | ||
| 95 | |||
| 96 | When you set C<PaddingPolicy> to C<Pad>, Elastic Transcoder may add | ||
| 97 | white bars to the top and bottom and/or left and right sides of the | ||
| 98 | output album art to make the total size of the output art match the | ||
| 99 | values that you specified for C<MaxWidth> and C<MaxHeight>. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 SizingPolicy => Str | ||
| 103 | |||
| 104 | Specify one of the following values to control scaling of the output | ||
| 105 | album art: | ||
| 106 | |||
| 107 | =over | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | C<Fit:> Elastic Transcoder scales the output art so it matches the | ||
| 112 | value that you specified in either C<MaxWidth> or C<MaxHeight> without | ||
| 113 | exceeding the other value. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | C<Fill:> Elastic Transcoder scales the output art so it matches the | ||
| 118 | value that you specified in either C<MaxWidth> or C<MaxHeight> and | ||
| 119 | matches or exceeds the other value. Elastic Transcoder centers the | ||
| 120 | output art and then crops it in the dimension (if any) that exceeds the | ||
| 121 | maximum value. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | C<Stretch:> Elastic Transcoder stretches the output art to match the | ||
| 126 | values that you specified for C<MaxWidth> and C<MaxHeight>. If the | ||
| 127 | relative proportions of the input art and the output art are different, | ||
| 128 | the output art will be distorted. | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | C<Keep:> Elastic Transcoder does not scale the output art. If either | ||
| 133 | dimension of the input art exceeds the values that you specified for | ||
| 134 | C<MaxWidth> and C<MaxHeight>, Elastic Transcoder crops the output art. | ||
| 135 | |||
| 136 | =item * | ||
| 137 | |||
| 138 | C<ShrinkToFit:> Elastic Transcoder scales the output art down so that | ||
| 139 | its dimensions match the values that you specified for at least one of | ||
| 140 | C<MaxWidth> and C<MaxHeight> without exceeding either value. If you | ||
| 141 | specify this option, Elastic Transcoder does not scale the art up. | ||
| 142 | |||
| 143 | =item * | ||
| 144 | |||
| 145 | C<ShrinkToFill> Elastic Transcoder scales the output art down so that | ||
| 146 | its dimensions match the values that you specified for at least one of | ||
| 147 | C<MaxWidth> and C<MaxHeight> without dropping below either value. If | ||
| 148 | you specify this option, Elastic Transcoder does not scale the art up. | ||
| 149 | |||
| 150 | =back | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head1 SEE ALSO | ||
| 156 | |||
| 157 | This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder> | ||
| 158 | |||
| 159 | =head1 BUGS and CONTRIBUTIONS | ||
| 160 | |||
| 161 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 162 | |||
| 163 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 164 | |||
| 165 | =cut | ||
| 166 |