blib/lib/Paws/ElasticTranscoder/JobOutput.pm untested

filter: Statementstmt 0.0% 0 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 25 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::ElasticTranscoder::JobOutput;
3 use Moose;
4 has AlbumArt => (is => 'ro', isa => 'Paws::ElasticTranscoder::JobAlbumArt');
5 has AppliedColorSpaceConversion => (is => 'ro', isa => 'Str');
6 has Captions => (is => 'ro', isa => 'Paws::ElasticTranscoder::Captions');
7 has Composition => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::Clip]');
8 has Duration => (is => 'ro', isa => 'Int');
9 has DurationMillis => (is => 'ro', isa => 'Int');
10 has Encryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption');
11 has FileSize => (is => 'ro', isa => 'Int');
12 has FrameRate => (is => 'ro', isa => 'Str');
13 has Height => (is => 'ro', isa => 'Int');
14 has Id => (is => 'ro', isa => 'Str');
15 has Key => (is => 'ro', isa => 'Str');
16 has PresetId => (is => 'ro', isa => 'Str');
17 has Rotate => (is => 'ro', isa => 'Str');
18 has SegmentDuration => (is => 'ro', isa => 'Str');
19 has Status => (is => 'ro', isa => 'Str');
20 has StatusDetail => (is => 'ro', isa => 'Str');
21 has ThumbnailEncryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption');
22 has ThumbnailPattern => (is => 'ro', isa => 'Str');
23 has Watermarks => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::JobWatermark]');
24 has Width => (is => 'ro', isa => 'Int');
25  
26 1;
27  
28 ### main pod documentation begin ###
29  
30 =head1 NAME
31  
32 Paws::ElasticTranscoder::JobOutput
33  
34 =head1 USAGE
35  
36 This class represents one of two things:
37  
38 =head3 Arguments in a call to a service
39  
40 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
41 Each attribute should be used as a named argument in the calls that expect this type of object.
42  
43 As an example, if Att1 is expected to be a Paws::ElasticTranscoder::JobOutput object:
44  
45 $service_obj->Method(Att1 => { AlbumArt => $value, ..., Width => $value });
46  
47 =head3 Results returned from an API call
48  
49 Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::JobOutput object:
50  
51 $result = $service_obj->Method(...);
52 $result->Att1->AlbumArt
53  
54 =head1 DESCRIPTION
55  
56 Outputs recommended instead.
57  
58 If you specified one output for a job, information about that output.
59 If you specified multiple outputs for a job, the C<Output> object lists
60 information about the first output. This duplicates the information
61 that is listed for the first output in the C<Outputs> object.
62  
63 =head1 ATTRIBUTES
64  
65  
66 =head2 AlbumArt => L<Paws::ElasticTranscoder::JobAlbumArt>
67  
68 The album art to be associated with the output file, if any.
69  
70  
71 =head2 AppliedColorSpaceConversion => Str
72  
73 If Elastic Transcoder used a preset with a C<ColorSpaceConversionMode>
74 to transcode the output file, the C<AppliedColorSpaceConversion>
75 parameter shows the conversion used. If no C<ColorSpaceConversionMode>
76 was defined in the preset, this parameter is not be included in the job
77 response.
78  
79  
80 =head2 Captions => L<Paws::ElasticTranscoder::Captions>
81  
82 You can configure Elastic Transcoder to transcode captions, or
83 subtitles, from one format to another. All captions must be in UTF-8.
84 Elastic Transcoder supports two types of captions:
85  
86 =over
87  
88 =item *
89  
90 B<Embedded:> Embedded captions are included in the same file as the
91 audio and video. Elastic Transcoder supports only one embedded caption
92 per language, to a maximum of 300 embedded captions per file.
93  
94 Valid input values include: C<CEA-608 (EIA-608>, first non-empty
95 channel only), C<CEA-708 (EIA-708>, first non-empty channel only), and
96 C<mov-text>
97  
98 Valid outputs include: C<mov-text>
99  
100 Elastic Transcoder supports a maximum of one embedded format per
101 output.
102  
103 =item *
104  
105 B<Sidecar:> Sidecar captions are kept in a separate metadata file from
106 the audio and video data. Sidecar captions require a player that is
107 capable of understanding the relationship between the video file and
108 the sidecar file. Elastic Transcoder supports only one sidecar caption
109 per language, to a maximum of 20 sidecar captions per file.
110  
111 Valid input values include: C<dfxp> (first div element only),
112 C<ebu-tt>, C<scc>, C<smpt>, C<srt>, C<ttml> (first div element only),
113 and C<webvtt>
114  
115 Valid outputs include: C<dfxp> (first div element only), C<scc>,
116 C<srt>, and C<webvtt>.
117  
118 =back
119  
120 If you want ttml or smpte-tt compatible captions, specify dfxp as your
121 output format.
122  
123 Elastic Transcoder does not support OCR (Optical Character
124 Recognition), does not accept pictures as a valid input for captions,
125 and is not available for audio-only transcoding. Elastic Transcoder
126 does not preserve text formatting (for example, italics) during the
127 transcoding process.
128  
129 To remove captions or leave the captions empty, set C<Captions> to
130 null. To pass through existing captions unchanged, set the
131 C<MergePolicy> to C<MergeRetain>, and pass in a null C<CaptionSources>
132 array.
133  
134 For more information on embedded files, see the Subtitles Wikipedia
135 page.
136  
137 For more information on sidecar files, see the Extensible Metadata
138 Platform and Sidecar file Wikipedia pages.
139  
140  
141 =head2 Composition => ArrayRef[L<Paws::ElasticTranscoder::Clip>]
142  
143 You can create an output file that contains an excerpt from the input
144 file. This excerpt, called a clip, can come from the beginning, middle,
145 or end of the file. The Composition object contains settings for the
146 clips that make up an output file. For the current release, you can
147 only specify settings for a single clip per output file. The
148 Composition object cannot be null.
149  
150  
151 =head2 Duration => Int
152  
153 Duration of the output file, in seconds.
154  
155  
156 =head2 DurationMillis => Int
157  
158 Duration of the output file, in milliseconds.
159  
160  
161 =head2 Encryption => L<Paws::ElasticTranscoder::Encryption>
162  
163 The encryption settings, if any, that you want Elastic Transcoder to
164 apply to your output files. If you choose to use encryption, you must
165 specify a mode to use. If you choose not to use encryption, Elastic
166 Transcoder writes an unencrypted file to your Amazon S3 bucket.
167  
168  
169 =head2 FileSize => Int
170  
171 File size of the output file, in bytes.
172  
173  
174 =head2 FrameRate => Str
175  
176 Frame rate of the output file, in frames per second.
177  
178  
179 =head2 Height => Int
180  
181 Height of the output file, in pixels.
182  
183  
184 =head2 Id => Str
185  
186 A sequential counter, starting with 1, that identifies an output among
187 the outputs from the current job. In the Output syntax, this value is
188 always 1.
189  
190  
191 =head2 Key => Str
192  
193 The name to assign to the transcoded file. Elastic Transcoder saves the
194 file in the Amazon S3 bucket specified by the C<OutputBucket> object in
195 the pipeline that is specified by the pipeline ID.
196  
197  
198 =head2 PresetId => Str
199  
200 The value of the C<Id> object for the preset that you want to use for
201 this job. The preset determines the audio, video, and thumbnail
202 settings that Elastic Transcoder uses for transcoding. To use a preset
203 that you created, specify the preset ID that Elastic Transcoder
204 returned in the response when you created the preset. You can also use
205 the Elastic Transcoder system presets, which you can get with
206 C<ListPresets>.
207  
208  
209 =head2 Rotate => Str
210  
211 The number of degrees clockwise by which you want Elastic Transcoder to
212 rotate the output relative to the input. Enter one of the following
213 values:
214  
215 C<auto>, C<0>, C<90>, C<180>, C<270>
216  
217 The value C<auto> generally works only if the file that you're
218 transcoding contains rotation metadata.
219  
220  
221 =head2 SegmentDuration => Str
222  
223 (Outputs in Fragmented MP4 or MPEG-TS format only.
224  
225 If you specify a preset in C<PresetId> for which the value of
226 C<Container> is C<fmp4> (Fragmented MP4) or C<ts> (MPEG-TS),
227 C<SegmentDuration> is the target maximum duration of each segment in
228 seconds. For C<HLSv3> format playlists, each media segment is stored in
229 a separate C<.ts> file. For C<HLSv4>, C<MPEG-DASH>, and C<Smooth>
230 playlists, all media segments for an output are stored in a single
231 file. Each segment is approximately the length of the
232 C<SegmentDuration>, though individual segments might be shorter or
233 longer.
234  
235 The range of valid values is 1 to 60 seconds. If the duration of the
236 video is not evenly divisible by C<SegmentDuration>, the duration of
237 the last segment is the remainder of total length/SegmentDuration.
238  
239 Elastic Transcoder creates an output-specific playlist for each output
240 C<HLS> output that you specify in OutputKeys. To add an output to the
241 master playlist for this job, include it in the C<OutputKeys> of the
242 associated playlist.
243  
244  
245 =head2 Status => Str
246  
247 The status of one output in a job. If you specified only one output for
248 the job, C<Outputs:Status> is always the same as C<Job:Status>. If you
249 specified more than one output:
250  
251 =over
252  
253 =item *
254  
255 C<Job:Status> and C<Outputs:Status> for all of the outputs is Submitted
256 until Elastic Transcoder starts to process the first output.
257  
258 =item *
259  
260 When Elastic Transcoder starts to process the first output,
261 C<Outputs:Status> for that output and C<Job:Status> both change to
262 Progressing. For each output, the value of C<Outputs:Status> remains
263 Submitted until Elastic Transcoder starts to process the output.
264  
265 =item *
266  
267 Job:Status remains Progressing until all of the outputs reach a
268 terminal status, either Complete or Error.
269  
270 =item *
271  
272 When all of the outputs reach a terminal status, C<Job:Status> changes
273 to Complete only if C<Outputs:Status> for all of the outputs is
274 C<Complete>. If C<Outputs:Status> for one or more outputs is C<Error>,
275 the terminal status for C<Job:Status> is also C<Error>.
276  
277 =back
278  
279 The value of C<Status> is one of the following: C<Submitted>,
280 C<Progressing>, C<Complete>, C<Canceled>, or C<Error>.
281  
282  
283 =head2 StatusDetail => Str
284  
285 Information that further explains C<Status>.
286  
287  
288 =head2 ThumbnailEncryption => L<Paws::ElasticTranscoder::Encryption>
289  
290 The encryption settings, if any, that you want Elastic Transcoder to
291 apply to your thumbnail.
292  
293  
294 =head2 ThumbnailPattern => Str
295  
296 Whether you want Elastic Transcoder to create thumbnails for your
297 videos and, if so, how you want Elastic Transcoder to name the files.
298  
299 If you don't want Elastic Transcoder to create thumbnails, specify "".
300  
301 If you do want Elastic Transcoder to create thumbnails, specify the
302 information that you want to include in the file name for each
303 thumbnail. You can specify the following values in any sequence:
304  
305 =over
306  
307 =item *
308  
309 B<C<{count}> (Required)>: If you want to create thumbnails, you must
310 include C<{count}> in the C<ThumbnailPattern> object. Wherever you
311 specify C<{count}>, Elastic Transcoder adds a five-digit sequence
312 number (beginning with B<00001>) to thumbnail file names. The number
313 indicates where a given thumbnail appears in the sequence of thumbnails
314 for a transcoded file.
315  
316 If you specify a literal value and/or C<{resolution}> but you omit
317 C<{count}>, Elastic Transcoder returns a validation error and does not
318 create the job.
319  
320 =item *
321  
322 B<Literal values (Optional)>: You can specify literal values anywhere
323 in the C<ThumbnailPattern> object. For example, you can include them as
324 a file name prefix or as a delimiter between C<{resolution}> and
325 C<{count}>.
326  
327 =item *
328  
329 B<C<{resolution}> (Optional)>: If you want Elastic Transcoder to
330 include the resolution in the file name, include C<{resolution}> in the
331 C<ThumbnailPattern> object.
332  
333 =back
334  
335 When creating thumbnails, Elastic Transcoder automatically saves the
336 files in the format (.jpg or .png) that appears in the preset that you
337 specified in the C<PresetID> value of C<CreateJobOutput>. Elastic
338 Transcoder also appends the applicable file name extension.
339  
340  
341 =head2 Watermarks => ArrayRef[L<Paws::ElasticTranscoder::JobWatermark>]
342  
343 Information about the watermarks that you want Elastic Transcoder to
344 add to the video during transcoding. You can specify up to four
345 watermarks for each output. Settings for each watermark must be defined
346 in the preset that you specify in C<Preset> for the current output.
347  
348 Watermarks are added to the output video in the sequence in which you
349 list them in the job outputE<mdash>the first watermark in the list is
350 added to the output video first, the second watermark in the list is
351 added next, and so on. As a result, if the settings in a preset cause
352 Elastic Transcoder to place all watermarks in the same location, the
353 second watermark that you add covers the first one, the third one
354 covers the second, and the fourth one covers the third.
355  
356  
357 =head2 Width => Int
358  
359 Specifies the width of the output file in pixels.
360  
361  
362  
363 =head1 SEE ALSO
364  
365 This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder>
366  
367 =head1 BUGS and CONTRIBUTIONS
368  
369 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
370  
371 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
372  
373 =cut
374