« blib/lib/Paws/ElasticTranscoder/TestRoleResponse.pm
↑ Summary
blib/lib/Paws/ElasticTranscoder/TimeSpan.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElasticTranscoder::Thumbnails; | ||
| 3 | use Moose; | ||
| 4 | has AspectRatio => (is => 'ro', isa => 'Str'); | ||
| 5 | has Format => (is => 'ro', isa => 'Str'); | ||
| 6 | has Interval => (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 Resolution => (is => 'ro', isa => 'Str'); | ||
| 11 | has SizingPolicy => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ElasticTranscoder::Thumbnails | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::ElasticTranscoder::Thumbnails object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { AspectRatio => $value, ..., SizingPolicy => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::Thumbnails object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->AspectRatio | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Thumbnails for videos. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 AspectRatio => Str | ||
| 49 | |||
| 50 | To better control resolution and aspect ratio of thumbnails, we | ||
| 51 | recommend that you use the values C<MaxWidth>, C<MaxHeight>, | ||
| 52 | C<SizingPolicy>, and C<PaddingPolicy> instead of C<Resolution> and | ||
| 53 | C<AspectRatio>. The two groups of settings are mutually exclusive. Do | ||
| 54 | not use them together. | ||
| 55 | |||
| 56 | The aspect ratio of thumbnails. Valid values include: | ||
| 57 | |||
| 58 | C<auto>, C<1:1>, C<4:3>, C<3:2>, C<16:9> | ||
| 59 | |||
| 60 | If you specify C<auto>, Elastic Transcoder tries to preserve the aspect | ||
| 61 | ratio of the video in the output file. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Format => Str | ||
| 65 | |||
| 66 | The format of thumbnails, if any. Valid values are C<jpg> and C<png>. | ||
| 67 | |||
| 68 | You specify whether you want Elastic Transcoder to create thumbnails | ||
| 69 | when you create a job. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Interval => Str | ||
| 73 | |||
| 74 | The approximate number of seconds between thumbnails. Specify an | ||
| 75 | integer value. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 MaxHeight => Str | ||
| 79 | |||
| 80 | The maximum height of thumbnails in pixels. If you specify auto, | ||
| 81 | Elastic Transcoder uses 1080 (Full HD) as the default value. If you | ||
| 82 | specify a numeric value, enter an even integer between 32 and 3072. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 MaxWidth => Str | ||
| 86 | |||
| 87 | The maximum width of thumbnails in pixels. If you specify auto, Elastic | ||
| 88 | Transcoder uses 1920 (Full HD) as the default value. If you specify a | ||
| 89 | numeric value, enter an even integer between 32 and 4096. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 PaddingPolicy => Str | ||
| 93 | |||
| 94 | When you set C<PaddingPolicy> to C<Pad>, Elastic Transcoder may add | ||
| 95 | black bars to the top and bottom and/or left and right sides of | ||
| 96 | thumbnails to make the total size of the thumbnails match the values | ||
| 97 | that you specified for thumbnail C<MaxWidth> and C<MaxHeight> settings. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 Resolution => Str | ||
| 101 | |||
| 102 | To better control resolution and aspect ratio of thumbnails, we | ||
| 103 | recommend that you use the values C<MaxWidth>, C<MaxHeight>, | ||
| 104 | C<SizingPolicy>, and C<PaddingPolicy> instead of C<Resolution> and | ||
| 105 | C<AspectRatio>. The two groups of settings are mutually exclusive. Do | ||
| 106 | not use them together. | ||
| 107 | |||
| 108 | The width and height of thumbnail files in pixels. Specify a value in | ||
| 109 | the format C< I<width> > x C< I<height> > where both values are even | ||
| 110 | integers. The values cannot exceed the width and height that you | ||
| 111 | specified in the C<Video:Resolution> object. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 SizingPolicy => Str | ||
| 115 | |||
| 116 | Specify one of the following values to control scaling of thumbnails: | ||
| 117 | |||
| 118 | =over | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | C<Fit>: Elastic Transcoder scales thumbnails so they match the value | ||
| 123 | that you specified in thumbnail MaxWidth or MaxHeight settings without | ||
| 124 | exceeding the other value. | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | C<Fill>: Elastic Transcoder scales thumbnails so they match the value | ||
| 129 | that you specified in thumbnail C<MaxWidth> or C<MaxHeight> settings | ||
| 130 | and matches or exceeds the other value. Elastic Transcoder centers the | ||
| 131 | image in thumbnails and then crops in the dimension (if any) that | ||
| 132 | exceeds the maximum value. | ||
| 133 | |||
| 134 | =item * | ||
| 135 | |||
| 136 | C<Stretch>: Elastic Transcoder stretches thumbnails to match the values | ||
| 137 | that you specified for thumbnail C<MaxWidth> and C<MaxHeight> settings. | ||
| 138 | If the relative proportions of the input video and thumbnails are | ||
| 139 | different, the thumbnails will be distorted. | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | C<Keep>: Elastic Transcoder does not scale thumbnails. If either | ||
| 144 | dimension of the input video exceeds the values that you specified for | ||
| 145 | thumbnail C<MaxWidth> and C<MaxHeight> settings, Elastic Transcoder | ||
| 146 | crops the thumbnails. | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | C<ShrinkToFit>: Elastic Transcoder scales thumbnails down so that their | ||
| 151 | dimensions match the values that you specified for at least one of | ||
| 152 | thumbnail C<MaxWidth> and C<MaxHeight> without exceeding either value. | ||
| 153 | If you specify this option, Elastic Transcoder does not scale | ||
| 154 | thumbnails up. | ||
| 155 | |||
| 156 | =item * | ||
| 157 | |||
| 158 | C<ShrinkToFill>: Elastic Transcoder scales thumbnails down so that | ||
| 159 | their dimensions match the values that you specified for at least one | ||
| 160 | of C<MaxWidth> and C<MaxHeight> without dropping below either value. If | ||
| 161 | you specify this option, Elastic Transcoder does not scale thumbnails | ||
| 162 | up. | ||
| 163 | |||
| 164 | =back | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head1 SEE ALSO | ||
| 170 | |||
| 171 | This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder> | ||
| 172 | |||
| 173 | =head1 BUGS and CONTRIBUTIONS | ||
| 174 | |||
| 175 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 176 | |||
| 177 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 178 | |||
| 179 | =cut | ||
| 180 |