« blib/lib/Paws/MediaLive/CaptionLanguageMapping.pm
↑ Summary
blib/lib/Paws/MediaLive/CaptionSelector.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaLive::CaptionRectangle; | ||
| 3 | use Moose; | ||
| 4 | has Height => (is => 'ro', isa => 'Num', request_name => 'height', traits => ['NameInRequest'], required => 1); | ||
| 5 | has LeftOffset => (is => 'ro', isa => 'Num', request_name => 'leftOffset', traits => ['NameInRequest'], required => 1); | ||
| 6 | has TopOffset => (is => 'ro', isa => 'Num', request_name => 'topOffset', traits => ['NameInRequest'], required => 1); | ||
| 7 | has Width => (is => 'ro', isa => 'Num', request_name => 'width', traits => ['NameInRequest'], required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::MediaLive::CaptionRectangle | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::MediaLive::CaptionRectangle object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Height => $value, ..., Width => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaLive::CaptionRectangle object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Height | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Caption Rectangle | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> Height => Num | ||
| 45 | |||
| 46 | See the description in leftOffset. For height, specify the entire | ||
| 47 | height of the rectangle as a percentage of the underlying frame height. | ||
| 48 | For example, \"80\" means the rectangle height is 80% of the underlying | ||
| 49 | frame height. The topOffset and rectangleHeight must add up to 100% or | ||
| 50 | less. This field corresponds to tts:extent - Y in the TTML standard. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> LeftOffset => Num | ||
| 54 | |||
| 55 | Applies only if you plan to convert these source captions to EBU-TT-D | ||
| 56 | or TTML in an output. (Make sure to leave the default if you don't have | ||
| 57 | either of these formats in the output.) You can define a display | ||
| 58 | rectangle for the captions that is smaller than the underlying video | ||
| 59 | frame. You define the rectangle by specifying the position of the left | ||
| 60 | edge, top edge, bottom edge, and right edge of the rectangle, all | ||
| 61 | within the underlying video frame. The units for the measurements are | ||
| 62 | percentages. If you specify a value for one of these fields, you must | ||
| 63 | specify a value for all of them. For leftOffset, specify the position | ||
| 64 | of the left edge of the rectangle, as a percentage of the underlying | ||
| 65 | frame width, and relative to the left edge of the frame. For example, | ||
| 66 | \"10\" means the measurement is 10% of the underlying frame width. The | ||
| 67 | rectangle left edge starts at that position from the left edge of the | ||
| 68 | frame. This field corresponds to tts:origin - X in the TTML standard. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> TopOffset => Num | ||
| 72 | |||
| 73 | See the description in leftOffset. For topOffset, specify the position | ||
| 74 | of the top edge of the rectangle, as a percentage of the underlying | ||
| 75 | frame height, and relative to the top edge of the frame. For example, | ||
| 76 | \"10\" means the measurement is 10% of the underlying frame height. The | ||
| 77 | rectangle top edge starts at that position from the top edge of the | ||
| 78 | frame. This field corresponds to tts:origin - Y in the TTML standard. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> Width => Num | ||
| 82 | |||
| 83 | See the description in leftOffset. For width, specify the entire width | ||
| 84 | of the rectangle as a percentage of the underlying frame width. For | ||
| 85 | example, \"80\" means the rectangle width is 80% of the underlying | ||
| 86 | frame width. The leftOffset and rectangleWidth must add up to 100% or | ||
| 87 | less. This field corresponds to tts:extent - X in the TTML standard. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaLive> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |