forked from aws/aws-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCreateJobOutput.java
More file actions
1398 lines (1340 loc) · 77 KB
/
CreateJobOutput.java
File metadata and controls
1398 lines (1340 loc) · 77 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.elastictranscoder.model;
import java.io.Serializable;
/**
* <p>
* The <code>CreateJobOutput</code> structure.
* </p>
*/
public class CreateJobOutput implements Serializable {
/**
* The name to assign to the transcoded file. Elastic Transcoder saves
* the file in the Amazon S3 bucket specified by the
* <code>OutputBucket</code> object in the pipeline that is specified by
* the pipeline ID. If a file with the specified name already exists in
* the output bucket, the job fails.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 255<br/>
*/
private String key;
/**
* Whether you want Elastic Transcoder to create thumbnails for your
* videos and, if so, how you want Elastic Transcoder to name the files.
* <p>If you don't want Elastic Transcoder to create thumbnails, specify
* "". <p> If you do want Elastic Transcoder to create thumbnails,
* specify the information that you want to include in the file name for
* each thumbnail. You can specify the following values in any sequence:
* <ul> <li> <p> <b><code>{count}</code> (Required)</b>: If you want to
* create thumbnails, you must include <code>{count}</code> in the
* <code>ThumbnailPattern</code> object. Wherever you specify
* <code>{count}</code>, Elastic Transcoder adds a five-digit sequence
* number (beginning with <b>00001</b>) to thumbnail file names. The
* number indicates where a given thumbnail appears in the sequence of
* thumbnails for a transcoded file. <important>If you specify a literal
* value and/or <code>{resolution}</code> but you omit
* <code>{count}</code>, Elastic Transcoder returns a validation error
* and does not create the job.</important> </li> <li> <p> <b>Literal
* values (Optional)</b>: You can specify literal values anywhere in the
* <code>ThumbnailPattern</code> object. For example, you can include
* them as a file name prefix or as a delimiter between
* <code>{resolution}</code> and <code>{count}</code>. </li> <li> <p>
* <b><code>{resolution}</code> (Optional)</b>: If you want Elastic
* Transcoder to include the resolution in the file name, include
* <code>{resolution}</code> in the <code>ThumbnailPattern</code> object.
* </li> </ul> <p>When creating thumbnails, Elastic Transcoder
* automatically saves the files in the format (.jpg or .png) that
* appears in the preset that you specified in the <code>PresetID</code>
* value of <code>CreateJobOutput</code>. Elastic Transcoder also appends
* the applicable file name extension.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>(^$)|(^.*\{count\}.*$)<br/>
*/
private String thumbnailPattern;
/**
* The encryption settings, if any, that you want Elastic Transcoder to
* apply to your thumbnail.
*/
private Encryption thumbnailEncryption;
/**
* The number of degrees clockwise by which you want Elastic Transcoder
* to rotate the output relative to the input. Enter one of the following
* values: <code>auto</code>, <code>0</code>, <code>90</code>,
* <code>180</code>, <code>270</code>. The value <code>auto</code>
* generally works only if the file that you're transcoding contains
* rotation metadata.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)<br/>
*/
private String rotate;
/**
* The <code>Id</code> of the preset to use for this job. The preset
* determines the audio, video, and thumbnail settings that Elastic
* Transcoder uses for transcoding.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>^\d{13}-\w{6}$<br/>
*/
private String presetId;
/**
* <important>(Outputs in Fragmented MP4 or MPEG-TS format
* only.</important>If you specify a preset in <code>PresetId</code> for
* which the value of <code>Container</code> is <code>fmp4</code>
* (Fragmented MP4) or <code>ts</code> (MPEG-TS),
* <code>SegmentDuration</code> is the target maximum duration of each
* segment in seconds. For <code>HLSv3</code> format playlists, each
* media segment is stored in a separate <code>.ts</code> file. For
* <code>HLSv4</code> and <code>Smooth</code> playlists, all media
* segments for an output are stored in a single file. Each segment is
* approximately the length of the <code>SegmentDuration</code>, though
* individual segments might be shorter or longer. <p>The range of valid
* values is 1 to 60 seconds. If the duration of the video is not evenly
* divisible by <code>SegmentDuration</code>, the duration of the last
* segment is the remainder of total length/SegmentDuration. <p>Elastic
* Transcoder creates an output-specific playlist for each output
* <code>HLS</code> output that you specify in OutputKeys. To add an
* output to the master playlist for this job, include it in the
* <code>OutputKeys</code> of the associated playlist.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>^\d{1,5}(\.\d{0,5})?$<br/>
*/
private String segmentDuration;
/**
* Information about the watermarks that you want Elastic Transcoder to
* add to the video during transcoding. You can specify up to four
* watermarks for each output. Settings for each watermark must be
* defined in the preset for the current output.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag<JobWatermark> watermarks;
/**
* Information about the album art that you want Elastic Transcoder to
* add to the file during transcoding. You can specify up to twenty album
* artworks for each output. Settings for each artwork must be defined in
* the job for the current output.
*/
private JobAlbumArt albumArt;
/**
* You can create an output file that contains an excerpt from the input
* file. This excerpt, called a clip, can come from the beginning,
* middle, or end of the file. The Composition object contains settings
* for the clips that make up an output file. For the current release,
* you can only specify settings for a single clip per output file. The
* Composition object cannot be null.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag<Clip> composition;
/**
* You can configure Elastic Transcoder to transcode captions, or
* subtitles, from one format to another. All captions must be in UTF-8.
* Elastic Transcoder supports two types of captions: <ul>
* <li><p><b>Embedded:</b> Embedded captions are included in the same
* file as the audio and video. Elastic Transcoder supports only one
* embedded caption per language, to a maximum of 300 embedded captions
* per file. <p>Valid input values include: <code>CEA-608
* (EIA-608</code>, first non-empty channel only), <code>CEA-708
* (EIA-708</code>, first non-empty channel only), and
* <code>mov-text</code> <p>Valid outputs include: <code>mov-text</code>
* <p>Elastic Transcoder supports a maximum of one embedded format per
* output.</li> <li><p><b>Sidecar:</b> Sidecar captions are kept in a
* separate metadata file from the audio and video data. Sidecar captions
* require a player that is capable of understanding the relationship
* between the video file and the sidecar file. Elastic Transcoder
* supports only one sidecar caption per language, to a maximum of 20
* sidecar captions per file. <p>Valid input values include:
* <code>dfxp</code> (first div element only), <code>ebu-tt</code>,
* <code>scc</code>, <code>smpt</code>, <code>srt</code>,
* <code>ttml</code> (first div element only), and <code>webvtt</code>
* <p>Valid outputs include: <code>dfxp</code> (first div element only),
* <code>scc</code>, <code>srt</code>, and <code>webvtt</code>.</li>
* </ul> <p> If you want ttml or smpte-tt compatible captions, specify
* dfxp as your output format. <p>Elastic Transcoder does not support OCR
* (Optical Character Recognition), does not accept pictures as a valid
* input for captions, and is not available for audio-only transcoding.
* Elastic Transcoder does not preserve text formatting (for example,
* italics) during the transcoding process. <p>To remove captions or
* leave the captions empty, set <code>Captions</code> to null. To pass
* through existing captions unchanged, set the <code>MergePolicy</code>
* to <code>MergeRetain</code>, and pass in a null
* <code>CaptionSources</code> array. <p>For more information on embedded
* files, see the Subtitles Wikipedia page. <p>For more information on
* sidecar files, see the Extensible Metadata Platform and Sidecar file
* Wikipedia pages.
*/
private Captions captions;
/**
* You can specify encryption settings for any output files that you want
* to use for a transcoding job. This includes the output file and any
* watermarks, thumbnails, album art, or captions that you want to use.
* You must specify encryption settings for each file individually.
*/
private Encryption encryption;
/**
* The name to assign to the transcoded file. Elastic Transcoder saves
* the file in the Amazon S3 bucket specified by the
* <code>OutputBucket</code> object in the pipeline that is specified by
* the pipeline ID. If a file with the specified name already exists in
* the output bucket, the job fails.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 255<br/>
*
* @return The name to assign to the transcoded file. Elastic Transcoder saves
* the file in the Amazon S3 bucket specified by the
* <code>OutputBucket</code> object in the pipeline that is specified by
* the pipeline ID. If a file with the specified name already exists in
* the output bucket, the job fails.
*/
public String getKey() {
return key;
}
/**
* The name to assign to the transcoded file. Elastic Transcoder saves
* the file in the Amazon S3 bucket specified by the
* <code>OutputBucket</code> object in the pipeline that is specified by
* the pipeline ID. If a file with the specified name already exists in
* the output bucket, the job fails.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 255<br/>
*
* @param key The name to assign to the transcoded file. Elastic Transcoder saves
* the file in the Amazon S3 bucket specified by the
* <code>OutputBucket</code> object in the pipeline that is specified by
* the pipeline ID. If a file with the specified name already exists in
* the output bucket, the job fails.
*/
public void setKey(String key) {
this.key = key;
}
/**
* The name to assign to the transcoded file. Elastic Transcoder saves
* the file in the Amazon S3 bucket specified by the
* <code>OutputBucket</code> object in the pipeline that is specified by
* the pipeline ID. If a file with the specified name already exists in
* the output bucket, the job fails.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 255<br/>
*
* @param key The name to assign to the transcoded file. Elastic Transcoder saves
* the file in the Amazon S3 bucket specified by the
* <code>OutputBucket</code> object in the pipeline that is specified by
* the pipeline ID. If a file with the specified name already exists in
* the output bucket, the job fails.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateJobOutput withKey(String key) {
this.key = key;
return this;
}
/**
* Whether you want Elastic Transcoder to create thumbnails for your
* videos and, if so, how you want Elastic Transcoder to name the files.
* <p>If you don't want Elastic Transcoder to create thumbnails, specify
* "". <p> If you do want Elastic Transcoder to create thumbnails,
* specify the information that you want to include in the file name for
* each thumbnail. You can specify the following values in any sequence:
* <ul> <li> <p> <b><code>{count}</code> (Required)</b>: If you want to
* create thumbnails, you must include <code>{count}</code> in the
* <code>ThumbnailPattern</code> object. Wherever you specify
* <code>{count}</code>, Elastic Transcoder adds a five-digit sequence
* number (beginning with <b>00001</b>) to thumbnail file names. The
* number indicates where a given thumbnail appears in the sequence of
* thumbnails for a transcoded file. <important>If you specify a literal
* value and/or <code>{resolution}</code> but you omit
* <code>{count}</code>, Elastic Transcoder returns a validation error
* and does not create the job.</important> </li> <li> <p> <b>Literal
* values (Optional)</b>: You can specify literal values anywhere in the
* <code>ThumbnailPattern</code> object. For example, you can include
* them as a file name prefix or as a delimiter between
* <code>{resolution}</code> and <code>{count}</code>. </li> <li> <p>
* <b><code>{resolution}</code> (Optional)</b>: If you want Elastic
* Transcoder to include the resolution in the file name, include
* <code>{resolution}</code> in the <code>ThumbnailPattern</code> object.
* </li> </ul> <p>When creating thumbnails, Elastic Transcoder
* automatically saves the files in the format (.jpg or .png) that
* appears in the preset that you specified in the <code>PresetID</code>
* value of <code>CreateJobOutput</code>. Elastic Transcoder also appends
* the applicable file name extension.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>(^$)|(^.*\{count\}.*$)<br/>
*
* @return Whether you want Elastic Transcoder to create thumbnails for your
* videos and, if so, how you want Elastic Transcoder to name the files.
* <p>If you don't want Elastic Transcoder to create thumbnails, specify
* "". <p> If you do want Elastic Transcoder to create thumbnails,
* specify the information that you want to include in the file name for
* each thumbnail. You can specify the following values in any sequence:
* <ul> <li> <p> <b><code>{count}</code> (Required)</b>: If you want to
* create thumbnails, you must include <code>{count}</code> in the
* <code>ThumbnailPattern</code> object. Wherever you specify
* <code>{count}</code>, Elastic Transcoder adds a five-digit sequence
* number (beginning with <b>00001</b>) to thumbnail file names. The
* number indicates where a given thumbnail appears in the sequence of
* thumbnails for a transcoded file. <important>If you specify a literal
* value and/or <code>{resolution}</code> but you omit
* <code>{count}</code>, Elastic Transcoder returns a validation error
* and does not create the job.</important> </li> <li> <p> <b>Literal
* values (Optional)</b>: You can specify literal values anywhere in the
* <code>ThumbnailPattern</code> object. For example, you can include
* them as a file name prefix or as a delimiter between
* <code>{resolution}</code> and <code>{count}</code>. </li> <li> <p>
* <b><code>{resolution}</code> (Optional)</b>: If you want Elastic
* Transcoder to include the resolution in the file name, include
* <code>{resolution}</code> in the <code>ThumbnailPattern</code> object.
* </li> </ul> <p>When creating thumbnails, Elastic Transcoder
* automatically saves the files in the format (.jpg or .png) that
* appears in the preset that you specified in the <code>PresetID</code>
* value of <code>CreateJobOutput</code>. Elastic Transcoder also appends
* the applicable file name extension.
*/
public String getThumbnailPattern() {
return thumbnailPattern;
}
/**
* Whether you want Elastic Transcoder to create thumbnails for your
* videos and, if so, how you want Elastic Transcoder to name the files.
* <p>If you don't want Elastic Transcoder to create thumbnails, specify
* "". <p> If you do want Elastic Transcoder to create thumbnails,
* specify the information that you want to include in the file name for
* each thumbnail. You can specify the following values in any sequence:
* <ul> <li> <p> <b><code>{count}</code> (Required)</b>: If you want to
* create thumbnails, you must include <code>{count}</code> in the
* <code>ThumbnailPattern</code> object. Wherever you specify
* <code>{count}</code>, Elastic Transcoder adds a five-digit sequence
* number (beginning with <b>00001</b>) to thumbnail file names. The
* number indicates where a given thumbnail appears in the sequence of
* thumbnails for a transcoded file. <important>If you specify a literal
* value and/or <code>{resolution}</code> but you omit
* <code>{count}</code>, Elastic Transcoder returns a validation error
* and does not create the job.</important> </li> <li> <p> <b>Literal
* values (Optional)</b>: You can specify literal values anywhere in the
* <code>ThumbnailPattern</code> object. For example, you can include
* them as a file name prefix or as a delimiter between
* <code>{resolution}</code> and <code>{count}</code>. </li> <li> <p>
* <b><code>{resolution}</code> (Optional)</b>: If you want Elastic
* Transcoder to include the resolution in the file name, include
* <code>{resolution}</code> in the <code>ThumbnailPattern</code> object.
* </li> </ul> <p>When creating thumbnails, Elastic Transcoder
* automatically saves the files in the format (.jpg or .png) that
* appears in the preset that you specified in the <code>PresetID</code>
* value of <code>CreateJobOutput</code>. Elastic Transcoder also appends
* the applicable file name extension.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>(^$)|(^.*\{count\}.*$)<br/>
*
* @param thumbnailPattern Whether you want Elastic Transcoder to create thumbnails for your
* videos and, if so, how you want Elastic Transcoder to name the files.
* <p>If you don't want Elastic Transcoder to create thumbnails, specify
* "". <p> If you do want Elastic Transcoder to create thumbnails,
* specify the information that you want to include in the file name for
* each thumbnail. You can specify the following values in any sequence:
* <ul> <li> <p> <b><code>{count}</code> (Required)</b>: If you want to
* create thumbnails, you must include <code>{count}</code> in the
* <code>ThumbnailPattern</code> object. Wherever you specify
* <code>{count}</code>, Elastic Transcoder adds a five-digit sequence
* number (beginning with <b>00001</b>) to thumbnail file names. The
* number indicates where a given thumbnail appears in the sequence of
* thumbnails for a transcoded file. <important>If you specify a literal
* value and/or <code>{resolution}</code> but you omit
* <code>{count}</code>, Elastic Transcoder returns a validation error
* and does not create the job.</important> </li> <li> <p> <b>Literal
* values (Optional)</b>: You can specify literal values anywhere in the
* <code>ThumbnailPattern</code> object. For example, you can include
* them as a file name prefix or as a delimiter between
* <code>{resolution}</code> and <code>{count}</code>. </li> <li> <p>
* <b><code>{resolution}</code> (Optional)</b>: If you want Elastic
* Transcoder to include the resolution in the file name, include
* <code>{resolution}</code> in the <code>ThumbnailPattern</code> object.
* </li> </ul> <p>When creating thumbnails, Elastic Transcoder
* automatically saves the files in the format (.jpg or .png) that
* appears in the preset that you specified in the <code>PresetID</code>
* value of <code>CreateJobOutput</code>. Elastic Transcoder also appends
* the applicable file name extension.
*/
public void setThumbnailPattern(String thumbnailPattern) {
this.thumbnailPattern = thumbnailPattern;
}
/**
* Whether you want Elastic Transcoder to create thumbnails for your
* videos and, if so, how you want Elastic Transcoder to name the files.
* <p>If you don't want Elastic Transcoder to create thumbnails, specify
* "". <p> If you do want Elastic Transcoder to create thumbnails,
* specify the information that you want to include in the file name for
* each thumbnail. You can specify the following values in any sequence:
* <ul> <li> <p> <b><code>{count}</code> (Required)</b>: If you want to
* create thumbnails, you must include <code>{count}</code> in the
* <code>ThumbnailPattern</code> object. Wherever you specify
* <code>{count}</code>, Elastic Transcoder adds a five-digit sequence
* number (beginning with <b>00001</b>) to thumbnail file names. The
* number indicates where a given thumbnail appears in the sequence of
* thumbnails for a transcoded file. <important>If you specify a literal
* value and/or <code>{resolution}</code> but you omit
* <code>{count}</code>, Elastic Transcoder returns a validation error
* and does not create the job.</important> </li> <li> <p> <b>Literal
* values (Optional)</b>: You can specify literal values anywhere in the
* <code>ThumbnailPattern</code> object. For example, you can include
* them as a file name prefix or as a delimiter between
* <code>{resolution}</code> and <code>{count}</code>. </li> <li> <p>
* <b><code>{resolution}</code> (Optional)</b>: If you want Elastic
* Transcoder to include the resolution in the file name, include
* <code>{resolution}</code> in the <code>ThumbnailPattern</code> object.
* </li> </ul> <p>When creating thumbnails, Elastic Transcoder
* automatically saves the files in the format (.jpg or .png) that
* appears in the preset that you specified in the <code>PresetID</code>
* value of <code>CreateJobOutput</code>. Elastic Transcoder also appends
* the applicable file name extension.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>(^$)|(^.*\{count\}.*$)<br/>
*
* @param thumbnailPattern Whether you want Elastic Transcoder to create thumbnails for your
* videos and, if so, how you want Elastic Transcoder to name the files.
* <p>If you don't want Elastic Transcoder to create thumbnails, specify
* "". <p> If you do want Elastic Transcoder to create thumbnails,
* specify the information that you want to include in the file name for
* each thumbnail. You can specify the following values in any sequence:
* <ul> <li> <p> <b><code>{count}</code> (Required)</b>: If you want to
* create thumbnails, you must include <code>{count}</code> in the
* <code>ThumbnailPattern</code> object. Wherever you specify
* <code>{count}</code>, Elastic Transcoder adds a five-digit sequence
* number (beginning with <b>00001</b>) to thumbnail file names. The
* number indicates where a given thumbnail appears in the sequence of
* thumbnails for a transcoded file. <important>If you specify a literal
* value and/or <code>{resolution}</code> but you omit
* <code>{count}</code>, Elastic Transcoder returns a validation error
* and does not create the job.</important> </li> <li> <p> <b>Literal
* values (Optional)</b>: You can specify literal values anywhere in the
* <code>ThumbnailPattern</code> object. For example, you can include
* them as a file name prefix or as a delimiter between
* <code>{resolution}</code> and <code>{count}</code>. </li> <li> <p>
* <b><code>{resolution}</code> (Optional)</b>: If you want Elastic
* Transcoder to include the resolution in the file name, include
* <code>{resolution}</code> in the <code>ThumbnailPattern</code> object.
* </li> </ul> <p>When creating thumbnails, Elastic Transcoder
* automatically saves the files in the format (.jpg or .png) that
* appears in the preset that you specified in the <code>PresetID</code>
* value of <code>CreateJobOutput</code>. Elastic Transcoder also appends
* the applicable file name extension.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateJobOutput withThumbnailPattern(String thumbnailPattern) {
this.thumbnailPattern = thumbnailPattern;
return this;
}
/**
* The encryption settings, if any, that you want Elastic Transcoder to
* apply to your thumbnail.
*
* @return The encryption settings, if any, that you want Elastic Transcoder to
* apply to your thumbnail.
*/
public Encryption getThumbnailEncryption() {
return thumbnailEncryption;
}
/**
* The encryption settings, if any, that you want Elastic Transcoder to
* apply to your thumbnail.
*
* @param thumbnailEncryption The encryption settings, if any, that you want Elastic Transcoder to
* apply to your thumbnail.
*/
public void setThumbnailEncryption(Encryption thumbnailEncryption) {
this.thumbnailEncryption = thumbnailEncryption;
}
/**
* The encryption settings, if any, that you want Elastic Transcoder to
* apply to your thumbnail.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param thumbnailEncryption The encryption settings, if any, that you want Elastic Transcoder to
* apply to your thumbnail.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateJobOutput withThumbnailEncryption(Encryption thumbnailEncryption) {
this.thumbnailEncryption = thumbnailEncryption;
return this;
}
/**
* The number of degrees clockwise by which you want Elastic Transcoder
* to rotate the output relative to the input. Enter one of the following
* values: <code>auto</code>, <code>0</code>, <code>90</code>,
* <code>180</code>, <code>270</code>. The value <code>auto</code>
* generally works only if the file that you're transcoding contains
* rotation metadata.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)<br/>
*
* @return The number of degrees clockwise by which you want Elastic Transcoder
* to rotate the output relative to the input. Enter one of the following
* values: <code>auto</code>, <code>0</code>, <code>90</code>,
* <code>180</code>, <code>270</code>. The value <code>auto</code>
* generally works only if the file that you're transcoding contains
* rotation metadata.
*/
public String getRotate() {
return rotate;
}
/**
* The number of degrees clockwise by which you want Elastic Transcoder
* to rotate the output relative to the input. Enter one of the following
* values: <code>auto</code>, <code>0</code>, <code>90</code>,
* <code>180</code>, <code>270</code>. The value <code>auto</code>
* generally works only if the file that you're transcoding contains
* rotation metadata.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)<br/>
*
* @param rotate The number of degrees clockwise by which you want Elastic Transcoder
* to rotate the output relative to the input. Enter one of the following
* values: <code>auto</code>, <code>0</code>, <code>90</code>,
* <code>180</code>, <code>270</code>. The value <code>auto</code>
* generally works only if the file that you're transcoding contains
* rotation metadata.
*/
public void setRotate(String rotate) {
this.rotate = rotate;
}
/**
* The number of degrees clockwise by which you want Elastic Transcoder
* to rotate the output relative to the input. Enter one of the following
* values: <code>auto</code>, <code>0</code>, <code>90</code>,
* <code>180</code>, <code>270</code>. The value <code>auto</code>
* generally works only if the file that you're transcoding contains
* rotation metadata.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)<br/>
*
* @param rotate The number of degrees clockwise by which you want Elastic Transcoder
* to rotate the output relative to the input. Enter one of the following
* values: <code>auto</code>, <code>0</code>, <code>90</code>,
* <code>180</code>, <code>270</code>. The value <code>auto</code>
* generally works only if the file that you're transcoding contains
* rotation metadata.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateJobOutput withRotate(String rotate) {
this.rotate = rotate;
return this;
}
/**
* The <code>Id</code> of the preset to use for this job. The preset
* determines the audio, video, and thumbnail settings that Elastic
* Transcoder uses for transcoding.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>^\d{13}-\w{6}$<br/>
*
* @return The <code>Id</code> of the preset to use for this job. The preset
* determines the audio, video, and thumbnail settings that Elastic
* Transcoder uses for transcoding.
*/
public String getPresetId() {
return presetId;
}
/**
* The <code>Id</code> of the preset to use for this job. The preset
* determines the audio, video, and thumbnail settings that Elastic
* Transcoder uses for transcoding.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>^\d{13}-\w{6}$<br/>
*
* @param presetId The <code>Id</code> of the preset to use for this job. The preset
* determines the audio, video, and thumbnail settings that Elastic
* Transcoder uses for transcoding.
*/
public void setPresetId(String presetId) {
this.presetId = presetId;
}
/**
* The <code>Id</code> of the preset to use for this job. The preset
* determines the audio, video, and thumbnail settings that Elastic
* Transcoder uses for transcoding.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>^\d{13}-\w{6}$<br/>
*
* @param presetId The <code>Id</code> of the preset to use for this job. The preset
* determines the audio, video, and thumbnail settings that Elastic
* Transcoder uses for transcoding.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateJobOutput withPresetId(String presetId) {
this.presetId = presetId;
return this;
}
/**
* <important>(Outputs in Fragmented MP4 or MPEG-TS format
* only.</important>If you specify a preset in <code>PresetId</code> for
* which the value of <code>Container</code> is <code>fmp4</code>
* (Fragmented MP4) or <code>ts</code> (MPEG-TS),
* <code>SegmentDuration</code> is the target maximum duration of each
* segment in seconds. For <code>HLSv3</code> format playlists, each
* media segment is stored in a separate <code>.ts</code> file. For
* <code>HLSv4</code> and <code>Smooth</code> playlists, all media
* segments for an output are stored in a single file. Each segment is
* approximately the length of the <code>SegmentDuration</code>, though
* individual segments might be shorter or longer. <p>The range of valid
* values is 1 to 60 seconds. If the duration of the video is not evenly
* divisible by <code>SegmentDuration</code>, the duration of the last
* segment is the remainder of total length/SegmentDuration. <p>Elastic
* Transcoder creates an output-specific playlist for each output
* <code>HLS</code> output that you specify in OutputKeys. To add an
* output to the master playlist for this job, include it in the
* <code>OutputKeys</code> of the associated playlist.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>^\d{1,5}(\.\d{0,5})?$<br/>
*
* @return <important>(Outputs in Fragmented MP4 or MPEG-TS format
* only.</important>If you specify a preset in <code>PresetId</code> for
* which the value of <code>Container</code> is <code>fmp4</code>
* (Fragmented MP4) or <code>ts</code> (MPEG-TS),
* <code>SegmentDuration</code> is the target maximum duration of each
* segment in seconds. For <code>HLSv3</code> format playlists, each
* media segment is stored in a separate <code>.ts</code> file. For
* <code>HLSv4</code> and <code>Smooth</code> playlists, all media
* segments for an output are stored in a single file. Each segment is
* approximately the length of the <code>SegmentDuration</code>, though
* individual segments might be shorter or longer. <p>The range of valid
* values is 1 to 60 seconds. If the duration of the video is not evenly
* divisible by <code>SegmentDuration</code>, the duration of the last
* segment is the remainder of total length/SegmentDuration. <p>Elastic
* Transcoder creates an output-specific playlist for each output
* <code>HLS</code> output that you specify in OutputKeys. To add an
* output to the master playlist for this job, include it in the
* <code>OutputKeys</code> of the associated playlist.
*/
public String getSegmentDuration() {
return segmentDuration;
}
/**
* <important>(Outputs in Fragmented MP4 or MPEG-TS format
* only.</important>If you specify a preset in <code>PresetId</code> for
* which the value of <code>Container</code> is <code>fmp4</code>
* (Fragmented MP4) or <code>ts</code> (MPEG-TS),
* <code>SegmentDuration</code> is the target maximum duration of each
* segment in seconds. For <code>HLSv3</code> format playlists, each
* media segment is stored in a separate <code>.ts</code> file. For
* <code>HLSv4</code> and <code>Smooth</code> playlists, all media
* segments for an output are stored in a single file. Each segment is
* approximately the length of the <code>SegmentDuration</code>, though
* individual segments might be shorter or longer. <p>The range of valid
* values is 1 to 60 seconds. If the duration of the video is not evenly
* divisible by <code>SegmentDuration</code>, the duration of the last
* segment is the remainder of total length/SegmentDuration. <p>Elastic
* Transcoder creates an output-specific playlist for each output
* <code>HLS</code> output that you specify in OutputKeys. To add an
* output to the master playlist for this job, include it in the
* <code>OutputKeys</code> of the associated playlist.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>^\d{1,5}(\.\d{0,5})?$<br/>
*
* @param segmentDuration <important>(Outputs in Fragmented MP4 or MPEG-TS format
* only.</important>If you specify a preset in <code>PresetId</code> for
* which the value of <code>Container</code> is <code>fmp4</code>
* (Fragmented MP4) or <code>ts</code> (MPEG-TS),
* <code>SegmentDuration</code> is the target maximum duration of each
* segment in seconds. For <code>HLSv3</code> format playlists, each
* media segment is stored in a separate <code>.ts</code> file. For
* <code>HLSv4</code> and <code>Smooth</code> playlists, all media
* segments for an output are stored in a single file. Each segment is
* approximately the length of the <code>SegmentDuration</code>, though
* individual segments might be shorter or longer. <p>The range of valid
* values is 1 to 60 seconds. If the duration of the video is not evenly
* divisible by <code>SegmentDuration</code>, the duration of the last
* segment is the remainder of total length/SegmentDuration. <p>Elastic
* Transcoder creates an output-specific playlist for each output
* <code>HLS</code> output that you specify in OutputKeys. To add an
* output to the master playlist for this job, include it in the
* <code>OutputKeys</code> of the associated playlist.
*/
public void setSegmentDuration(String segmentDuration) {
this.segmentDuration = segmentDuration;
}
/**
* <important>(Outputs in Fragmented MP4 or MPEG-TS format
* only.</important>If you specify a preset in <code>PresetId</code> for
* which the value of <code>Container</code> is <code>fmp4</code>
* (Fragmented MP4) or <code>ts</code> (MPEG-TS),
* <code>SegmentDuration</code> is the target maximum duration of each
* segment in seconds. For <code>HLSv3</code> format playlists, each
* media segment is stored in a separate <code>.ts</code> file. For
* <code>HLSv4</code> and <code>Smooth</code> playlists, all media
* segments for an output are stored in a single file. Each segment is
* approximately the length of the <code>SegmentDuration</code>, though
* individual segments might be shorter or longer. <p>The range of valid
* values is 1 to 60 seconds. If the duration of the video is not evenly
* divisible by <code>SegmentDuration</code>, the duration of the last
* segment is the remainder of total length/SegmentDuration. <p>Elastic
* Transcoder creates an output-specific playlist for each output
* <code>HLS</code> output that you specify in OutputKeys. To add an
* output to the master playlist for this job, include it in the
* <code>OutputKeys</code> of the associated playlist.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Pattern: </b>^\d{1,5}(\.\d{0,5})?$<br/>
*
* @param segmentDuration <important>(Outputs in Fragmented MP4 or MPEG-TS format
* only.</important>If you specify a preset in <code>PresetId</code> for
* which the value of <code>Container</code> is <code>fmp4</code>
* (Fragmented MP4) or <code>ts</code> (MPEG-TS),
* <code>SegmentDuration</code> is the target maximum duration of each
* segment in seconds. For <code>HLSv3</code> format playlists, each
* media segment is stored in a separate <code>.ts</code> file. For
* <code>HLSv4</code> and <code>Smooth</code> playlists, all media
* segments for an output are stored in a single file. Each segment is
* approximately the length of the <code>SegmentDuration</code>, though
* individual segments might be shorter or longer. <p>The range of valid
* values is 1 to 60 seconds. If the duration of the video is not evenly
* divisible by <code>SegmentDuration</code>, the duration of the last
* segment is the remainder of total length/SegmentDuration. <p>Elastic
* Transcoder creates an output-specific playlist for each output
* <code>HLS</code> output that you specify in OutputKeys. To add an
* output to the master playlist for this job, include it in the
* <code>OutputKeys</code> of the associated playlist.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateJobOutput withSegmentDuration(String segmentDuration) {
this.segmentDuration = segmentDuration;
return this;
}
/**
* Information about the watermarks that you want Elastic Transcoder to
* add to the video during transcoding. You can specify up to four
* watermarks for each output. Settings for each watermark must be
* defined in the preset for the current output.
*
* @return Information about the watermarks that you want Elastic Transcoder to
* add to the video during transcoding. You can specify up to four
* watermarks for each output. Settings for each watermark must be
* defined in the preset for the current output.
*/
public java.util.List<JobWatermark> getWatermarks() {
if (watermarks == null) {
watermarks = new com.amazonaws.internal.ListWithAutoConstructFlag<JobWatermark>();
watermarks.setAutoConstruct(true);
}
return watermarks;
}
/**
* Information about the watermarks that you want Elastic Transcoder to
* add to the video during transcoding. You can specify up to four
* watermarks for each output. Settings for each watermark must be
* defined in the preset for the current output.
*
* @param watermarks Information about the watermarks that you want Elastic Transcoder to
* add to the video during transcoding. You can specify up to four
* watermarks for each output. Settings for each watermark must be
* defined in the preset for the current output.
*/
public void setWatermarks(java.util.Collection<JobWatermark> watermarks) {
if (watermarks == null) {
this.watermarks = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag<JobWatermark> watermarksCopy = new com.amazonaws.internal.ListWithAutoConstructFlag<JobWatermark>(watermarks.size());
watermarksCopy.addAll(watermarks);
this.watermarks = watermarksCopy;
}
/**
* Information about the watermarks that you want Elastic Transcoder to
* add to the video during transcoding. You can specify up to four
* watermarks for each output. Settings for each watermark must be
* defined in the preset for the current output.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param watermarks Information about the watermarks that you want Elastic Transcoder to
* add to the video during transcoding. You can specify up to four
* watermarks for each output. Settings for each watermark must be
* defined in the preset for the current output.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateJobOutput withWatermarks(JobWatermark... watermarks) {
if (getWatermarks() == null) setWatermarks(new java.util.ArrayList<JobWatermark>(watermarks.length));
for (JobWatermark value : watermarks) {
getWatermarks().add(value);
}
return this;
}
/**
* Information about the watermarks that you want Elastic Transcoder to
* add to the video during transcoding. You can specify up to four
* watermarks for each output. Settings for each watermark must be
* defined in the preset for the current output.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param watermarks Information about the watermarks that you want Elastic Transcoder to
* add to the video during transcoding. You can specify up to four
* watermarks for each output. Settings for each watermark must be
* defined in the preset for the current output.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateJobOutput withWatermarks(java.util.Collection<JobWatermark> watermarks) {
if (watermarks == null) {
this.watermarks = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag<JobWatermark> watermarksCopy = new com.amazonaws.internal.ListWithAutoConstructFlag<JobWatermark>(watermarks.size());
watermarksCopy.addAll(watermarks);
this.watermarks = watermarksCopy;
}
return this;
}
/**
* Information about the album art that you want Elastic Transcoder to
* add to the file during transcoding. You can specify up to twenty album
* artworks for each output. Settings for each artwork must be defined in
* the job for the current output.
*
* @return Information about the album art that you want Elastic Transcoder to
* add to the file during transcoding. You can specify up to twenty album
* artworks for each output. Settings for each artwork must be defined in
* the job for the current output.
*/
public JobAlbumArt getAlbumArt() {
return albumArt;
}
/**
* Information about the album art that you want Elastic Transcoder to
* add to the file during transcoding. You can specify up to twenty album
* artworks for each output. Settings for each artwork must be defined in
* the job for the current output.
*
* @param albumArt Information about the album art that you want Elastic Transcoder to
* add to the file during transcoding. You can specify up to twenty album
* artworks for each output. Settings for each artwork must be defined in
* the job for the current output.
*/
public void setAlbumArt(JobAlbumArt albumArt) {
this.albumArt = albumArt;
}
/**
* Information about the album art that you want Elastic Transcoder to
* add to the file during transcoding. You can specify up to twenty album
* artworks for each output. Settings for each artwork must be defined in
* the job for the current output.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param albumArt Information about the album art that you want Elastic Transcoder to
* add to the file during transcoding. You can specify up to twenty album
* artworks for each output. Settings for each artwork must be defined in
* the job for the current output.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateJobOutput withAlbumArt(JobAlbumArt albumArt) {
this.albumArt = albumArt;
return this;
}
/**
* You can create an output file that contains an excerpt from the input
* file. This excerpt, called a clip, can come from the beginning,
* middle, or end of the file. The Composition object contains settings
* for the clips that make up an output file. For the current release,
* you can only specify settings for a single clip per output file. The
* Composition object cannot be null.
*
* @return You can create an output file that contains an excerpt from the input
* file. This excerpt, called a clip, can come from the beginning,
* middle, or end of the file. The Composition object contains settings
* for the clips that make up an output file. For the current release,
* you can only specify settings for a single clip per output file. The
* Composition object cannot be null.
*/
public java.util.List<Clip> getComposition() {
if (composition == null) {
composition = new com.amazonaws.internal.ListWithAutoConstructFlag<Clip>();
composition.setAutoConstruct(true);
}
return composition;
}
/**
* You can create an output file that contains an excerpt from the input
* file. This excerpt, called a clip, can come from the beginning,
* middle, or end of the file. The Composition object contains settings
* for the clips that make up an output file. For the current release,
* you can only specify settings for a single clip per output file. The
* Composition object cannot be null.
*
* @param composition You can create an output file that contains an excerpt from the input
* file. This excerpt, called a clip, can come from the beginning,
* middle, or end of the file. The Composition object contains settings
* for the clips that make up an output file. For the current release,
* you can only specify settings for a single clip per output file. The
* Composition object cannot be null.
*/
public void setComposition(java.util.Collection<Clip> composition) {
if (composition == null) {
this.composition = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag<Clip> compositionCopy = new com.amazonaws.internal.ListWithAutoConstructFlag<Clip>(composition.size());
compositionCopy.addAll(composition);
this.composition = compositionCopy;
}
/**
* You can create an output file that contains an excerpt from the input
* file. This excerpt, called a clip, can come from the beginning,
* middle, or end of the file. The Composition object contains settings
* for the clips that make up an output file. For the current release,
* you can only specify settings for a single clip per output file. The
* Composition object cannot be null.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param composition You can create an output file that contains an excerpt from the input
* file. This excerpt, called a clip, can come from the beginning,
* middle, or end of the file. The Composition object contains settings
* for the clips that make up an output file. For the current release,
* you can only specify settings for a single clip per output file. The
* Composition object cannot be null.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateJobOutput withComposition(Clip... composition) {
if (getComposition() == null) setComposition(new java.util.ArrayList<Clip>(composition.length));
for (Clip value : composition) {
getComposition().add(value);
}
return this;
}
/**
* You can create an output file that contains an excerpt from the input
* file. This excerpt, called a clip, can come from the beginning,