| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::InsertableImage; | ||
| 3 | use Moose; | ||
| 4 | has Duration => (is => 'ro', isa => 'Int', request_name => 'duration', traits => ['NameInRequest']); | ||
| 5 | has FadeIn => (is => 'ro', isa => 'Int', request_name => 'fadeIn', traits => ['NameInRequest']); | ||
| 6 | has FadeOut => (is => 'ro', isa => 'Int', request_name => 'fadeOut', traits => ['NameInRequest']); | ||
| 7 | has Height => (is => 'ro', isa => 'Int', request_name => 'height', traits => ['NameInRequest']); | ||
| 8 | has ImageInserterInput => (is => 'ro', isa => 'Str', request_name => 'imageInserterInput', traits => ['NameInRequest']); | ||
| 9 | has ImageX => (is => 'ro', isa => 'Int', request_name => 'imageX', traits => ['NameInRequest']); | ||
| 10 | has ImageY => (is => 'ro', isa => 'Int', request_name => 'imageY', traits => ['NameInRequest']); | ||
| 11 | has Layer => (is => 'ro', isa => 'Int', request_name => 'layer', traits => ['NameInRequest']); | ||
| 12 | has Opacity => (is => 'ro', isa => 'Int', request_name => 'opacity', traits => ['NameInRequest']); | ||
| 13 | has StartTime => (is => 'ro', isa => 'Str', request_name => 'startTime', traits => ['NameInRequest']); | ||
| 14 | has Width => (is => 'ro', isa => 'Int', request_name => 'width', traits => ['NameInRequest']); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::MediaConvert::InsertableImage | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::MediaConvert::InsertableImage object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { Duration => $value, ..., Width => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::InsertableImage object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->Duration | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | These settings apply to a specific graphic overlay. You can include | ||
| 47 | multiple overlays in your job. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Duration => Int | ||
| 53 | |||
| 54 | Specify the time, in milliseconds, for the image to remain on the | ||
| 55 | output video. This duration includes fade-in time but not fade-out | ||
| 56 | time. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 FadeIn => Int | ||
| 60 | |||
| 61 | Specify the length of time, in milliseconds, between the Start time | ||
| 62 | that you specify for the image insertion and the time that the image | ||
| 63 | appears at full opacity. Full opacity is the level that you specify for | ||
| 64 | the opacity setting. If you don't specify a value for Fade-in, the | ||
| 65 | image will appear abruptly at the overlay start time. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 FadeOut => Int | ||
| 69 | |||
| 70 | Specify the length of time, in milliseconds, between the end of the | ||
| 71 | time that you have specified for the image overlay Duration and when | ||
| 72 | the overlaid image has faded to total transparency. If you don't | ||
| 73 | specify a value for Fade-out, the image will disappear abruptly at the | ||
| 74 | end of the inserted image duration. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Height => Int | ||
| 78 | |||
| 79 | Specify the height of the inserted image in pixels. If you specify a | ||
| 80 | value that's larger than the video resolution height, the service will | ||
| 81 | crop your overlaid image to fit. To use the native height of the image, | ||
| 82 | keep this setting blank. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 ImageInserterInput => Str | ||
| 86 | |||
| 87 | Specify the HTTP, HTTPS, or Amazon S3 location of the image that you | ||
| 88 | want to overlay on the video. Use a PNG or TGA file. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 ImageX => Int | ||
| 92 | |||
| 93 | Specify the distance, in pixels, between the inserted image and the | ||
| 94 | left edge of the video frame. Required for any image overlay that you | ||
| 95 | specify. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 ImageY => Int | ||
| 99 | |||
| 100 | Specify the distance, in pixels, between the overlaid image and the top | ||
| 101 | edge of the video frame. Required for any image overlay that you | ||
| 102 | specify. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 Layer => Int | ||
| 106 | |||
| 107 | Specify how overlapping inserted images appear. Images with higher | ||
| 108 | values for Layer appear on top of images with lower values for Layer. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 Opacity => Int | ||
| 112 | |||
| 113 | Use Opacity (Opacity) to specify how much of the underlying video shows | ||
| 114 | through the inserted image. 0 is transparent and 100 is fully opaque. | ||
| 115 | Default is 50. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 StartTime => Str | ||
| 119 | |||
| 120 | Specify the timecode of the frame that you want the overlay to first | ||
| 121 | appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) | ||
| 122 | format. Remember to take into account your timecode source settings. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 Width => Int | ||
| 126 | |||
| 127 | Specify the width of the inserted image in pixels. If you specify a | ||
| 128 | value that's larger than the video resolution width, the service will | ||
| 129 | crop your overlaid image to fit. To use the native width of the image, | ||
| 130 | keep this setting blank. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |