view release on metacpan or  search on metacpan

lib/Paws/ElasticTranscoder/PresetWatermark.pm  view on Meta::CPAN

# Generated by default/object.tt
package Paws::ElasticTranscoder::PresetWatermark;
  use Moose;
  has HorizontalAlign => (is => 'ro', isa => 'Str');
  has HorizontalOffset => (is => 'ro', isa => 'Str');
  has Id => (is => 'ro', isa => 'Str');
  has MaxHeight => (is => 'ro', isa => 'Str');
  has MaxWidth => (is => 'ro', isa => 'Str');
  has Opacity => (is => 'ro', isa => 'Str');
  has SizingPolicy => (is => 'ro', isa => 'Str');
  has Target => (is => 'ro', isa => 'Str');
  has VerticalAlign => (is => 'ro', isa => 'Str');
  has VerticalOffset => (is => 'ro', isa => 'Str');

1;

### main pod documentation begin ###

=head1 NAME

Paws::ElasticTranscoder::PresetWatermark

=head1 USAGE

This class represents one of two things:

=head3 Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. 
Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::ElasticTranscoder::PresetWatermark object:

  $service_obj->Method(Att1 => { HorizontalAlign => $value, ..., VerticalOffset => $value  });

=head3 Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::PresetWatermark object:

  $result = $service_obj->Method(...);
  $result->Att1->HorizontalAlign

=head1 DESCRIPTION

Settings for the size, location, and opacity of graphics that you want
Elastic Transcoder to overlay over videos that are transcoded using
this preset. You can specify settings for up to four watermarks.
Watermarks appear in the specified size and location, and with the
specified opacity for the duration of the transcoded video.

Watermarks can be in .png or .jpg format. If you want to display a
watermark that is not rectangular, use the .png format, which supports
transparency.

When you create a job that uses this preset, you specify the .png or
.jpg graphics that you want Elastic Transcoder to include in the
transcoded videos. You can specify fewer graphics in the job than you
specify watermark settings in the preset, which allows you to use the
same preset for up to four watermarks that have different dimensions.

=head1 ATTRIBUTES


=head2 HorizontalAlign => Str

The horizontal position of the watermark unless you specify a non-zero
value for C<HorizontalOffset>:

=over

=item *

B<Left>: The left edge of the watermark is aligned with the left border
of the video.

=item *

B<Right>: The right edge of the watermark is aligned with the right
border of the video.

=item *

B<Center>: The watermark is centered between the left and right
borders.

=back



=head2 HorizontalOffset => Str

The amount by which you want the horizontal position of the watermark
to be offset from the position specified by HorizontalAlign:

=over

=item *

number of pixels (px): The minimum value is 0 pixels, and the maximum
value is the value of MaxWidth.

=item *

integer percentage (%): The range of valid values is 0 to 100.

=back