| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElasticTranscoder::PresetWatermark; | ||
| 3 | use Moose; | ||
| 4 | has HorizontalAlign => (is => 'ro', isa => 'Str'); | ||
| 5 | has HorizontalOffset => (is => 'ro', isa => 'Str'); | ||
| 6 | has Id => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxHeight => (is => 'ro', isa => 'Str'); | ||
| 8 | has MaxWidth => (is => 'ro', isa => 'Str'); | ||
| 9 | has Opacity => (is => 'ro', isa => 'Str'); | ||
| 10 | has SizingPolicy => (is => 'ro', isa => 'Str'); | ||
| 11 | has Target => (is => 'ro', isa => 'Str'); | ||
| 12 | has VerticalAlign => (is => 'ro', isa => 'Str'); | ||
| 13 | has VerticalOffset => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ElasticTranscoder::PresetWatermark | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::ElasticTranscoder::PresetWatermark object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { HorizontalAlign => $value, ..., VerticalOffset => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::PresetWatermark object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->HorizontalAlign | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Settings for the size, location, and opacity of graphics that you want | ||
| 46 | Elastic Transcoder to overlay over videos that are transcoded using | ||
| 47 | this preset. You can specify settings for up to four watermarks. | ||
| 48 | Watermarks appear in the specified size and location, and with the | ||
| 49 | specified opacity for the duration of the transcoded video. | ||
| 50 | |||
| 51 | Watermarks can be in .png or .jpg format. If you want to display a | ||
| 52 | watermark that is not rectangular, use the .png format, which supports | ||
| 53 | transparency. | ||
| 54 | |||
| 55 | When you create a job that uses this preset, you specify the .png or | ||
| 56 | .jpg graphics that you want Elastic Transcoder to include in the | ||
| 57 | transcoded videos. You can specify fewer graphics in the job than you | ||
| 58 | specify watermark settings in the preset, which allows you to use the | ||
| 59 | same preset for up to four watermarks that have different dimensions. | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 HorizontalAlign => Str | ||
| 65 | |||
| 66 | The horizontal position of the watermark unless you specify a non-zero | ||
| 67 | value for C<HorizontalOffset>: | ||
| 68 | |||
| 69 | =over | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | B<Left>: The left edge of the watermark is aligned with the left border | ||
| 74 | of the video. | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | B<Right>: The right edge of the watermark is aligned with the right | ||
| 79 | border of the video. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | B<Center>: The watermark is centered between the left and right | ||
| 84 | borders. | ||
| 85 | |||
| 86 | =back | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 HorizontalOffset => Str | ||
| 91 | |||
| 92 | The amount by which you want the horizontal position of the watermark | ||
| 93 | to be offset from the position specified by HorizontalAlign: | ||
| 94 | |||
| 95 | =over | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | number of pixels (px): The minimum value is 0 pixels, and the maximum | ||
| 100 | value is the value of MaxWidth. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | integer percentage (%): The range of valid values is 0 to 100. | ||
| 105 | |||
| 106 | =back | ||
| 107 | |||
| 108 | For example, if you specify Left for C<HorizontalAlign> and 5px for | ||
| 109 | C<HorizontalOffset>, the left side of the watermark appears 5 pixels | ||
| 110 | from the left border of the output video. | ||
| 111 | |||
| 112 | C<HorizontalOffset> is only valid when the value of C<HorizontalAlign> | ||
| 113 | is C<Left> or C<Right>. If you specify an offset that causes the | ||
| 114 | watermark to extend beyond the left or right border and Elastic | ||
| 115 | Transcoder has not added black bars, the watermark is cropped. If | ||
| 116 | Elastic Transcoder has added black bars, the watermark extends into the | ||
| 117 | black bars. If the watermark extends beyond the black bars, it is | ||
| 118 | cropped. | ||
| 119 | |||
| 120 | Use the value of C<Target> to specify whether you want to include the | ||
| 121 | black bars that are added by Elastic Transcoder, if any, in the offset | ||
| 122 | calculation. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 Id => Str | ||
| 126 | |||
| 127 | A unique identifier for the settings for one watermark. The value of | ||
| 128 | C<Id> can be up to 40 characters long. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 MaxHeight => Str | ||
| 132 | |||
| 133 | The maximum height of the watermark in one of the following formats: | ||
| 134 | |||
| 135 | =over | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | number of pixels (px): The minimum value is 16 pixels, and the maximum | ||
| 140 | value is the value of C<MaxHeight>. | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | integer percentage (%): The range of valid values is 0 to 100. Use the | ||
| 145 | value of C<Target> to specify whether you want Elastic Transcoder to | ||
| 146 | include the black bars that are added by Elastic Transcoder, if any, in | ||
| 147 | the calculation. | ||
| 148 | |||
| 149 | =back | ||
| 150 | |||
| 151 | If you specify the value in pixels, it must be less than or equal to | ||
| 152 | the value of C<MaxHeight>. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 MaxWidth => Str | ||
| 156 | |||
| 157 | The maximum width of the watermark in one of the following formats: | ||
| 158 | |||
| 159 | =over | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | number of pixels (px): The minimum value is 16 pixels, and the maximum | ||
| 164 | value is the value of C<MaxWidth>. | ||
| 165 | |||
| 166 | =item * | ||
| 167 | |||
| 168 | integer percentage (%): The range of valid values is 0 to 100. Use the | ||
| 169 | value of C<Target> to specify whether you want Elastic Transcoder to | ||
| 170 | include the black bars that are added by Elastic Transcoder, if any, in | ||
| 171 | the calculation. | ||
| 172 | |||
| 173 | If you specify the value in pixels, it must be less than or equal to | ||
| 174 | the value of C<MaxWidth>. | ||
| 175 | |||
| 176 | =back | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head2 Opacity => Str | ||
| 181 | |||
| 182 | A percentage that indicates how much you want a watermark to obscure | ||
| 183 | the video in the location where it appears. Valid values are 0 (the | ||
| 184 | watermark is invisible) to 100 (the watermark completely obscures the | ||
| 185 | video in the specified location). The datatype of C<Opacity> is float. | ||
| 186 | |||
| 187 | Elastic Transcoder supports transparent .png graphics. If you use a | ||
| 188 | transparent .png, the transparent portion of the video appears as if | ||
| 189 | you had specified a value of 0 for C<Opacity>. The .jpg file format | ||
| 190 | doesn't support transparency. | ||
| 191 | |||
| 192 | |||
| 193 | =head2 SizingPolicy => Str | ||
| 194 | |||
| 195 | A value that controls scaling of the watermark: | ||
| 196 | |||
| 197 | =over | ||
| 198 | |||
| 199 | =item * | ||
| 200 | |||
| 201 | B<Fit>: Elastic Transcoder scales the watermark so it matches the value | ||
| 202 | that you specified in either C<MaxWidth> or C<MaxHeight> without | ||
| 203 | exceeding the other value. | ||
| 204 | |||
| 205 | =item * | ||
| 206 | |||
| 207 | B<Stretch>: Elastic Transcoder stretches the watermark to match the | ||
| 208 | values that you specified for C<MaxWidth> and C<MaxHeight>. If the | ||
| 209 | relative proportions of the watermark and the values of C<MaxWidth> and | ||
| 210 | C<MaxHeight> are different, the watermark will be distorted. | ||
| 211 | |||
| 212 | =item * | ||
| 213 | |||
| 214 | B<ShrinkToFit>: Elastic Transcoder scales the watermark down so that | ||
| 215 | its dimensions match the values that you specified for at least one of | ||
| 216 | C<MaxWidth> and C<MaxHeight> without exceeding either value. If you | ||
| 217 | specify this option, Elastic Transcoder does not scale the watermark | ||
| 218 | up. | ||
| 219 | |||
| 220 | =back | ||
| 221 | |||
| 222 | |||
| 223 | |||
| 224 | =head2 Target => Str | ||
| 225 | |||
| 226 | A value that determines how Elastic Transcoder interprets values that | ||
| 227 | you specified for C<HorizontalOffset>, C<VerticalOffset>, C<MaxWidth>, | ||
| 228 | and C<MaxHeight>: | ||
| 229 | |||
| 230 | =over | ||
| 231 | |||
| 232 | =item * | ||
| 233 | |||
| 234 | B<Content>: C<HorizontalOffset> and C<VerticalOffset> values are | ||
| 235 | calculated based on the borders of the video excluding black bars added | ||
| 236 | by Elastic Transcoder, if any. In addition, C<MaxWidth> and | ||
| 237 | C<MaxHeight>, if specified as a percentage, are calculated based on the | ||
| 238 | borders of the video excluding black bars added by Elastic Transcoder, | ||
| 239 | if any. | ||
| 240 | |||
| 241 | =item * | ||
| 242 | |||
| 243 | B<Frame>: C<HorizontalOffset> and C<VerticalOffset> values are | ||
| 244 | calculated based on the borders of the video including black bars added | ||
| 245 | by Elastic Transcoder, if any. In addition, C<MaxWidth> and | ||
| 246 | C<MaxHeight>, if specified as a percentage, are calculated based on the | ||
| 247 | borders of the video including black bars added by Elastic Transcoder, | ||
| 248 | if any. | ||
| 249 | |||
| 250 | =back | ||
| 251 | |||
| 252 | |||
| 253 | |||
| 254 | =head2 VerticalAlign => Str | ||
| 255 | |||
| 256 | The vertical position of the watermark unless you specify a non-zero | ||
| 257 | value for C<VerticalOffset>: | ||
| 258 | |||
| 259 | =over | ||
| 260 | |||
| 261 | =item * | ||
| 262 | |||
| 263 | B<Top>: The top edge of the watermark is aligned with the top border of | ||
| 264 | the video. | ||
| 265 | |||
| 266 | =item * | ||
| 267 | |||
| 268 | B<Bottom>: The bottom edge of the watermark is aligned with the bottom | ||
| 269 | border of the video. | ||
| 270 | |||
| 271 | =item * | ||
| 272 | |||
| 273 | B<Center>: The watermark is centered between the top and bottom | ||
| 274 | borders. | ||
| 275 | |||
| 276 | =back | ||
| 277 | |||
| 278 | |||
| 279 | |||
| 280 | =head2 VerticalOffset => Str | ||
| 281 | |||
| 282 | C<VerticalOffset> | ||
| 283 | |||
| 284 | The amount by which you want the vertical position of the watermark to | ||
| 285 | be offset from the position specified by VerticalAlign: | ||
| 286 | |||
| 287 | =over | ||
| 288 | |||
| 289 | =item * | ||
| 290 | |||
| 291 | number of pixels (px): The minimum value is 0 pixels, and the maximum | ||
| 292 | value is the value of C<MaxHeight>. | ||
| 293 | |||
| 294 | =item * | ||
| 295 | |||
| 296 | integer percentage (%): The range of valid values is 0 to 100. | ||
| 297 | |||
| 298 | =back | ||
| 299 | |||
| 300 | For example, if you specify C<Top> for C<VerticalAlign> and C<5px> for | ||
| 301 | C<VerticalOffset>, the top of the watermark appears 5 pixels from the | ||
| 302 | top border of the output video. | ||
| 303 | |||
| 304 | C<VerticalOffset> is only valid when the value of VerticalAlign is Top | ||
| 305 | or Bottom. | ||
| 306 | |||
| 307 | If you specify an offset that causes the watermark to extend beyond the | ||
| 308 | top or bottom border and Elastic Transcoder has not added black bars, | ||
| 309 | the watermark is cropped. If Elastic Transcoder has added black bars, | ||
| 310 | the watermark extends into the black bars. If the watermark extends | ||
| 311 | beyond the black bars, it is cropped. | ||
| 312 | |||
| 313 | Use the value of C<Target> to specify whether you want Elastic | ||
| 314 | Transcoder to include the black bars that are added by Elastic | ||
| 315 | Transcoder, if any, in the offset calculation. | ||
| 316 | |||
| 317 | |||
| 318 | |||
| 319 | =head1 SEE ALSO | ||
| 320 | |||
| 321 | This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder> | ||
| 322 | |||
| 323 | =head1 BUGS and CONTRIBUTIONS | ||
| 324 | |||
| 325 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 326 | |||
| 327 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 328 | |||
| 329 | =cut | ||
| 330 |