File Coverage

blib/lib/Paws/ElasticTranscoder/CreateJobOutput.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::ElasticTranscoder::CreateJobOutput;
2 1     1   501 use Moose;
  1         2  
  1         8  
3             has AlbumArt => (is => 'ro', isa => 'Paws::ElasticTranscoder::JobAlbumArt');
4             has Captions => (is => 'ro', isa => 'Paws::ElasticTranscoder::Captions');
5             has Composition => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::Clip]');
6             has Encryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption');
7             has Key => (is => 'ro', isa => 'Str');
8             has PresetId => (is => 'ro', isa => 'Str');
9             has Rotate => (is => 'ro', isa => 'Str');
10             has SegmentDuration => (is => 'ro', isa => 'Str');
11             has ThumbnailEncryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption');
12             has ThumbnailPattern => (is => 'ro', isa => 'Str');
13             has Watermarks => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::JobWatermark]');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::ElasticTranscoder::CreateJobOutput
21              
22             =head1 USAGE
23              
24             This class represents one of two things:
25              
26             =head3 Arguments in a call to a service
27              
28             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29             Each attribute should be used as a named argument in the calls that expect this type of object.
30              
31             As an example, if Att1 is expected to be a Paws::ElasticTranscoder::CreateJobOutput object:
32              
33             $service_obj->Method(Att1 => { AlbumArt => $value, ..., Watermarks => $value });
34              
35             =head3 Results returned from an API call
36              
37             Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::CreateJobOutput object:
38              
39             $result = $service_obj->Method(...);
40             $result->Att1->AlbumArt
41              
42             =head1 DESCRIPTION
43              
44             The C<CreateJobOutput> structure.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 AlbumArt => L<Paws::ElasticTranscoder::JobAlbumArt>
50              
51             Information about the album art that you want Elastic Transcoder to add
52             to the file during transcoding. You can specify up to twenty album
53             artworks for each output. Settings for each artwork must be defined in
54             the job for the current output.
55              
56              
57             =head2 Captions => L<Paws::ElasticTranscoder::Captions>
58              
59             You can configure Elastic Transcoder to transcode captions, or
60             subtitles, from one format to another. All captions must be in UTF-8.
61             Elastic Transcoder supports two types of captions:
62              
63             =over
64              
65             =item *
66              
67             B<Embedded:> Embedded captions are included in the same file as the
68             audio and video. Elastic Transcoder supports only one embedded caption
69             per language, to a maximum of 300 embedded captions per file.
70              
71             Valid input values include: C<CEA-608 (EIA-608>, first non-empty
72             channel only), C<CEA-708 (EIA-708>, first non-empty channel only), and
73             C<mov-text>
74              
75             Valid outputs include: C<mov-text>
76              
77             Elastic Transcoder supports a maximum of one embedded format per
78             output.
79              
80             =item *
81              
82             B<Sidecar:> Sidecar captions are kept in a separate metadata file from
83             the audio and video data. Sidecar captions require a player that is
84             capable of understanding the relationship between the video file and
85             the sidecar file. Elastic Transcoder supports only one sidecar caption
86             per language, to a maximum of 20 sidecar captions per file.
87              
88             Valid input values include: C<dfxp> (first div element only),
89             C<ebu-tt>, C<scc>, C<smpt>, C<srt>, C<ttml> (first div element only),
90             and C<webvtt>
91              
92             Valid outputs include: C<dfxp> (first div element only), C<scc>,
93             C<srt>, and C<webvtt>.
94              
95             =back
96              
97             If you want ttml or smpte-tt compatible captions, specify dfxp as your
98             output format.
99              
100             Elastic Transcoder does not support OCR (Optical Character
101             Recognition), does not accept pictures as a valid input for captions,
102             and is not available for audio-only transcoding. Elastic Transcoder
103             does not preserve text formatting (for example, italics) during the
104             transcoding process.
105              
106             To remove captions or leave the captions empty, set C<Captions> to
107             null. To pass through existing captions unchanged, set the
108             C<MergePolicy> to C<MergeRetain>, and pass in a null C<CaptionSources>
109             array.
110              
111             For more information on embedded files, see the Subtitles Wikipedia
112             page.
113              
114             For more information on sidecar files, see the Extensible Metadata
115             Platform and Sidecar file Wikipedia pages.
116              
117              
118             =head2 Composition => ArrayRef[L<Paws::ElasticTranscoder::Clip>]
119              
120             You can create an output file that contains an excerpt from the input
121             file. This excerpt, called a clip, can come from the beginning, middle,
122             or end of the file. The Composition object contains settings for the
123             clips that make up an output file. For the current release, you can
124             only specify settings for a single clip per output file. The
125             Composition object cannot be null.
126              
127              
128             =head2 Encryption => L<Paws::ElasticTranscoder::Encryption>
129              
130             You can specify encryption settings for any output files that you want
131             to use for a transcoding job. This includes the output file and any
132             watermarks, thumbnails, album art, or captions that you want to use.
133             You must specify encryption settings for each file individually.
134              
135              
136             =head2 Key => Str
137              
138             The name to assign to the transcoded file. Elastic Transcoder saves the
139             file in the Amazon S3 bucket specified by the C<OutputBucket> object in
140             the pipeline that is specified by the pipeline ID. If a file with the
141             specified name already exists in the output bucket, the job fails.
142              
143              
144             =head2 PresetId => Str
145              
146             The C<Id> of the preset to use for this job. The preset determines the
147             audio, video, and thumbnail settings that Elastic Transcoder uses for
148             transcoding.
149              
150              
151             =head2 Rotate => Str
152              
153             The number of degrees clockwise by which you want Elastic Transcoder to
154             rotate the output relative to the input. Enter one of the following
155             values: C<auto>, C<0>, C<90>, C<180>, C<270>. The value C<auto>
156             generally works only if the file that you're transcoding contains
157             rotation metadata.
158              
159              
160             =head2 SegmentDuration => Str
161              
162             (Outputs in Fragmented MP4 or MPEG-TS format only.
163              
164             If you specify a preset in C<PresetId> for which the value of
165             C<Container> is C<fmp4> (Fragmented MP4) or C<ts> (MPEG-TS),
166             C<SegmentDuration> is the target maximum duration of each segment in
167             seconds. For C<HLSv3> format playlists, each media segment is stored in
168             a separate C<.ts> file. For C<HLSv4> and C<Smooth> playlists, all media
169             segments for an output are stored in a single file. Each segment is
170             approximately the length of the C<SegmentDuration>, though individual
171             segments might be shorter or longer.
172              
173             The range of valid values is 1 to 60 seconds. If the duration of the
174             video is not evenly divisible by C<SegmentDuration>, the duration of
175             the last segment is the remainder of total length/SegmentDuration.
176              
177             Elastic Transcoder creates an output-specific playlist for each output
178             C<HLS> output that you specify in OutputKeys. To add an output to the
179             master playlist for this job, include it in the C<OutputKeys> of the
180             associated playlist.
181              
182              
183             =head2 ThumbnailEncryption => L<Paws::ElasticTranscoder::Encryption>
184              
185             The encryption settings, if any, that you want Elastic Transcoder to
186             apply to your thumbnail.
187              
188              
189             =head2 ThumbnailPattern => Str
190              
191             Whether you want Elastic Transcoder to create thumbnails for your
192             videos and, if so, how you want Elastic Transcoder to name the files.
193              
194             If you don't want Elastic Transcoder to create thumbnails, specify "".
195              
196             If you do want Elastic Transcoder to create thumbnails, specify the
197             information that you want to include in the file name for each
198             thumbnail. You can specify the following values in any sequence:
199              
200             =over
201              
202             =item *
203              
204             B<C<{count}> (Required)>: If you want to create thumbnails, you must
205             include C<{count}> in the C<ThumbnailPattern> object. Wherever you
206             specify C<{count}>, Elastic Transcoder adds a five-digit sequence
207             number (beginning with B<00001>) to thumbnail file names. The number
208             indicates where a given thumbnail appears in the sequence of thumbnails
209             for a transcoded file.
210              
211             If you specify a literal value and/or C<{resolution}> but you omit
212             C<{count}>, Elastic Transcoder returns a validation error and does not
213             create the job.
214              
215             =item *
216              
217             B<Literal values (Optional)>: You can specify literal values anywhere
218             in the C<ThumbnailPattern> object. For example, you can include them as
219             a file name prefix or as a delimiter between C<{resolution}> and
220             C<{count}>.
221              
222             =item *
223              
224             B<C<{resolution}> (Optional)>: If you want Elastic Transcoder to
225             include the resolution in the file name, include C<{resolution}> in the
226             C<ThumbnailPattern> object.
227              
228             =back
229              
230             When creating thumbnails, Elastic Transcoder automatically saves the
231             files in the format (.jpg or .png) that appears in the preset that you
232             specified in the C<PresetID> value of C<CreateJobOutput>. Elastic
233             Transcoder also appends the applicable file name extension.
234              
235              
236             =head2 Watermarks => ArrayRef[L<Paws::ElasticTranscoder::JobWatermark>]
237              
238             Information about the watermarks that you want Elastic Transcoder to
239             add to the video during transcoding. You can specify up to four
240             watermarks for each output. Settings for each watermark must be defined
241             in the preset for the current output.
242              
243              
244              
245             =head1 SEE ALSO
246              
247             This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder>
248              
249             =head1 BUGS and CONTRIBUTIONS
250              
251             The source code is located here: https://github.com/pplu/aws-sdk-perl
252              
253             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
254              
255             =cut
256