File Coverage

blib/lib/Paws/ElasticTranscoder/Artwork.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

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