File Coverage

blib/lib/Paws/ElasticTranscoder/JobInput.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::JobInput;
2 1     1   579 use Moose;
  1         3  
  1         9  
3             has AspectRatio => (is => 'ro', isa => 'Str');
4             has Container => (is => 'ro', isa => 'Str');
5             has DetectedProperties => (is => 'ro', isa => 'Paws::ElasticTranscoder::DetectedProperties');
6             has Encryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption');
7             has FrameRate => (is => 'ro', isa => 'Str');
8             has InputCaptions => (is => 'ro', isa => 'Paws::ElasticTranscoder::InputCaptions');
9             has Interlaced => (is => 'ro', isa => 'Str');
10             has Key => (is => 'ro', isa => 'Str');
11             has Resolution => (is => 'ro', isa => 'Str');
12             has TimeSpan => (is => 'ro', isa => 'Paws::ElasticTranscoder::TimeSpan');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::ElasticTranscoder::JobInput
20              
21             =head1 USAGE
22              
23             This class represents one of two things:
24              
25             =head3 Arguments in a call to a service
26              
27             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
28             Each attribute should be used as a named argument in the calls that expect this type of object.
29              
30             As an example, if Att1 is expected to be a Paws::ElasticTranscoder::JobInput object:
31              
32             $service_obj->Method(Att1 => { AspectRatio => $value, ..., TimeSpan => $value });
33              
34             =head3 Results returned from an API call
35              
36             Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::JobInput object:
37              
38             $result = $service_obj->Method(...);
39             $result->Att1->AspectRatio
40              
41             =head1 DESCRIPTION
42              
43             Information about the file that you're transcoding.
44              
45             =head1 ATTRIBUTES
46              
47              
48             =head2 AspectRatio => Str
49              
50             The aspect ratio of the input file. If you want Elastic Transcoder to
51             automatically detect the aspect ratio of the input file, specify
52             C<auto>. If you want to specify the aspect ratio for the output file,
53             enter one of the following values:
54              
55             C<1:1>, C<4:3>, C<3:2>, C<16:9>
56              
57             If you specify a value other than C<auto>, Elastic Transcoder disables
58             automatic detection of the aspect ratio.
59              
60              
61             =head2 Container => Str
62              
63             The container type for the input file. If you want Elastic Transcoder
64             to automatically detect the container type of the input file, specify
65             C<auto>. If you want to specify the container type for the input file,
66             enter one of the following values:
67              
68             C<3gp>, C<aac>, C<asf>, C<avi>, C<divx>, C<flv>, C<m4a>, C<mkv>,
69             C<mov>, C<mp3>, C<mp4>, C<mpeg>, C<mpeg-ps>, C<mpeg-ts>, C<mxf>,
70             C<ogg>, C<vob>, C<wav>, C<webm>
71              
72              
73             =head2 DetectedProperties => L<Paws::ElasticTranscoder::DetectedProperties>
74              
75             The detected properties of the input file.
76              
77              
78             =head2 Encryption => L<Paws::ElasticTranscoder::Encryption>
79              
80             The encryption settings, if any, that are used for decrypting your
81             input files. If your input file is encrypted, you must specify the mode
82             that Elastic Transcoder uses to decrypt your file.
83              
84              
85             =head2 FrameRate => Str
86              
87             The frame rate of the input file. If you want Elastic Transcoder to
88             automatically detect the frame rate of the input file, specify C<auto>.
89             If you want to specify the frame rate for the input file, enter one of
90             the following values:
91              
92             C<10>, C<15>, C<23.97>, C<24>, C<25>, C<29.97>, C<30>, C<60>
93              
94             If you specify a value other than C<auto>, Elastic Transcoder disables
95             automatic detection of the frame rate.
96              
97              
98             =head2 InputCaptions => L<Paws::ElasticTranscoder::InputCaptions>
99              
100             You can configure Elastic Transcoder to transcode captions, or
101             subtitles, from one format to another. All captions must be in UTF-8.
102             Elastic Transcoder supports two types of captions:
103              
104             =over
105              
106             =item *
107              
108             B<Embedded:> Embedded captions are included in the same file as the
109             audio and video. Elastic Transcoder supports only one embedded caption
110             per language, to a maximum of 300 embedded captions per file.
111              
112             Valid input values include: C<CEA-608 (EIA-608>, first non-empty
113             channel only), C<CEA-708 (EIA-708>, first non-empty channel only), and
114             C<mov-text>
115              
116             Valid outputs include: C<mov-text>
117              
118             Elastic Transcoder supports a maximum of one embedded format per
119             output.
120              
121             =item *
122              
123             B<Sidecar:> Sidecar captions are kept in a separate metadata file from
124             the audio and video data. Sidecar captions require a player that is
125             capable of understanding the relationship between the video file and
126             the sidecar file. Elastic Transcoder supports only one sidecar caption
127             per language, to a maximum of 20 sidecar captions per file.
128              
129             Valid input values include: C<dfxp> (first div element only),
130             C<ebu-tt>, C<scc>, C<smpt>, C<srt>, C<ttml> (first div element only),
131             and C<webvtt>
132              
133             Valid outputs include: C<dfxp> (first div element only), C<scc>,
134             C<srt>, and C<webvtt>.
135              
136             =back
137              
138             If you want ttml or smpte-tt compatible captions, specify dfxp as your
139             output format.
140              
141             Elastic Transcoder does not support OCR (Optical Character
142             Recognition), does not accept pictures as a valid input for captions,
143             and is not available for audio-only transcoding. Elastic Transcoder
144             does not preserve text formatting (for example, italics) during the
145             transcoding process.
146              
147             To remove captions or leave the captions empty, set C<Captions> to
148             null. To pass through existing captions unchanged, set the
149             C<MergePolicy> to C<MergeRetain>, and pass in a null C<CaptionSources>
150             array.
151              
152             For more information on embedded files, see the Subtitles Wikipedia
153             page.
154              
155             For more information on sidecar files, see the Extensible Metadata
156             Platform and Sidecar file Wikipedia pages.
157              
158              
159             =head2 Interlaced => Str
160              
161             Whether the input file is interlaced. If you want Elastic Transcoder to
162             automatically detect whether the input file is interlaced, specify
163             C<auto>. If you want to specify whether the input file is interlaced,
164             enter one of the following values:
165              
166             C<true>, C<false>
167              
168             If you specify a value other than C<auto>, Elastic Transcoder disables
169             automatic detection of interlacing.
170              
171              
172             =head2 Key => Str
173              
174             The name of the file to transcode. Elsewhere in the body of the JSON
175             block is the the ID of the pipeline to use for processing the job. The
176             C<InputBucket> object in that pipeline tells Elastic Transcoder which
177             Amazon S3 bucket to get the file from.
178              
179             If the file name includes a prefix, such as C<cooking/lasagna.mpg>,
180             include the prefix in the key. If the file isn't in the specified
181             bucket, Elastic Transcoder returns an error.
182              
183              
184             =head2 Resolution => Str
185              
186             This value must be C<auto>, which causes Elastic Transcoder to
187             automatically detect the resolution of the input file.
188              
189              
190             =head2 TimeSpan => L<Paws::ElasticTranscoder::TimeSpan>
191              
192             Settings for clipping an input. Each input can have different clip
193             settings.
194              
195              
196              
197             =head1 SEE ALSO
198              
199             This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder>
200              
201             =head1 BUGS and CONTRIBUTIONS
202              
203             The source code is located here: https://github.com/pplu/aws-sdk-perl
204              
205             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
206              
207             =cut
208