« blib/lib/Paws/MediaConvert/M3u8Settings.pm
↑ Summary
blib/lib/Paws/MediaConvert/MotionImageInsertionFramerate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::MotionImageInserter; | ||
| 3 | use Moose; | ||
| 4 | has Framerate => (is => 'ro', isa => 'Paws::MediaConvert::MotionImageInsertionFramerate', request_name => 'framerate', traits => ['NameInRequest']); | ||
| 5 | has Input => (is => 'ro', isa => 'Str', request_name => 'input', traits => ['NameInRequest']); | ||
| 6 | has InsertionMode => (is => 'ro', isa => 'Str', request_name => 'insertionMode', traits => ['NameInRequest']); | ||
| 7 | has Offset => (is => 'ro', isa => 'Paws::MediaConvert::MotionImageInsertionOffset', request_name => 'offset', traits => ['NameInRequest']); | ||
| 8 | has Playback => (is => 'ro', isa => 'Str', request_name => 'playback', traits => ['NameInRequest']); | ||
| 9 | has StartTime => (is => 'ro', isa => 'Str', request_name => 'startTime', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::MediaConvert::MotionImageInserter | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::MediaConvert::MotionImageInserter object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Framerate => $value, ..., StartTime => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::MotionImageInserter object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Framerate | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Overlay motion graphics on top of your video. The motion graphics that | ||
| 42 | you specify here appear on all outputs in all output groups. For more | ||
| 43 | information, see | ||
| 44 | https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Framerate => L<Paws::MediaConvert::MotionImageInsertionFramerate> | ||
| 50 | |||
| 51 | If your motion graphic asset is a .mov file, keep this setting | ||
| 52 | unspecified. If your motion graphic asset is a series of .png files, | ||
| 53 | specify the frame rate of the overlay in frames per second, as a | ||
| 54 | fraction. For example, specify 24 fps as 24/1. Make sure that the | ||
| 55 | number of images in your series matches the frame rate and your | ||
| 56 | intended overlay duration. For example, if you want a 30-second overlay | ||
| 57 | at 30 fps, you should have 900 .png images. This overlay frame rate | ||
| 58 | doesn't need to match the frame rate of the underlying video. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Input => Str | ||
| 62 | |||
| 63 | Specify the .mov file or series of .png files that you want to overlay | ||
| 64 | on your video. For .png files, provide the file name of the first file | ||
| 65 | in the series. Make sure that the names of the .png files end with | ||
| 66 | sequential numbers that specify the order that they are played in. For | ||
| 67 | example, overlay_000.png, overlay_001.png, overlay_002.png, and so on. | ||
| 68 | The sequence must start at zero, and each image file name must have the | ||
| 69 | same number of digits. Pad your initial file names with enough zeros to | ||
| 70 | complete the sequence. For example, if the first image is | ||
| 71 | overlay_0.png, there can be only 10 images in the sequence, with the | ||
| 72 | last image being overlay_9.png. But if the first image is | ||
| 73 | overlay_00.png, there can be 100 images in the sequence. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 InsertionMode => Str | ||
| 77 | |||
| 78 | Choose the type of motion graphic asset that you are providing for your | ||
| 79 | overlay. You can choose either a .mov file or a series of .png files. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 Offset => L<Paws::MediaConvert::MotionImageInsertionOffset> | ||
| 83 | |||
| 84 | Use Offset to specify the placement of your motion graphic overlay on | ||
| 85 | the video frame. Specify in pixels, from the upper-left corner of the | ||
| 86 | frame. If you don't specify an offset, the service scales your overlay | ||
| 87 | to the full size of the frame. Otherwise, the service inserts the | ||
| 88 | overlay at its native resolution and scales the size up or down with | ||
| 89 | any video scaling. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 Playback => Str | ||
| 93 | |||
| 94 | Specify whether your motion graphic overlay repeats on a loop or plays | ||
| 95 | only once. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 StartTime => Str | ||
| 99 | |||
| 100 | Specify when the motion overlay begins. Use timecode format | ||
| 101 | (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide | ||
| 102 | here takes into account how you have set up your timecode configuration | ||
| 103 | under both job settings and input settings. The simplest way to do that | ||
| 104 | is to set both to start at 0. If you need to set up your job to follow | ||
| 105 | timecodes embedded in your source that don't start at zero, make sure | ||
| 106 | that you specify a start time that is after the first embedded | ||
| 107 | timecode. For more information, see | ||
| 108 | https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html | ||
| 109 | Find job-wide and input timecode configuration settings in your JSON | ||
| 110 | job settings specification at settingsE<gt>timecodeConfigE<gt>source | ||
| 111 | and settingsE<gt>inputsE<gt>timecodeSource. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head1 SEE ALSO | ||
| 116 | |||
| 117 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 118 | |||
| 119 | =head1 BUGS and CONTRIBUTIONS | ||
| 120 | |||
| 121 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 122 | |||
| 123 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 124 | |||
| 125 | =cut | ||
| 126 |