File Coverage

blib/lib/Paws/ElasticTranscoder/AudioParameters.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::AudioParameters;
2 1     1   460 use Moose;
  1         3  
  1         7  
3             has AudioPackingMode => (is => 'ro', isa => 'Str');
4             has BitRate => (is => 'ro', isa => 'Str');
5             has Channels => (is => 'ro', isa => 'Str');
6             has Codec => (is => 'ro', isa => 'Str');
7             has CodecOptions => (is => 'ro', isa => 'Paws::ElasticTranscoder::AudioCodecOptions');
8             has SampleRate => (is => 'ro', isa => 'Str');
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::ElasticTranscoder::AudioParameters
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::ElasticTranscoder::AudioParameters object:
27              
28             $service_obj->Method(Att1 => { AudioPackingMode => $value, ..., SampleRate => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::AudioParameters object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->AudioPackingMode
36              
37             =head1 DESCRIPTION
38              
39             Parameters required for transcoding audio.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 AudioPackingMode => Str
45              
46             The method of organizing audio channels and tracks. Use
47             C<Audio:Channels> to specify the number of channels in your output, and
48             C<Audio:AudioPackingMode> to specify the number of tracks and their
49             relation to the channels. If you do not specify an
50             C<Audio:AudioPackingMode>, Elastic Transcoder uses C<SingleTrack>.
51              
52             The following values are valid:
53              
54             C<SingleTrack>, C<OneChannelPerTrack>, and
55             C<OneChannelPerTrackWithMosTo8Tracks>
56              
57             When you specify C<SingleTrack>, Elastic Transcoder creates a single
58             track for your output. The track can have up to eight channels. Use
59             C<SingleTrack> for all non-C<mxf> containers.
60              
61             The outputs of C<SingleTrack> for a specific channel value and inputs
62             are as follows:
63              
64             =over
65              
66             =item *
67              
68             C<0> B< channels with any input:> Audio omitted from the output
69              
70             =item *
71              
72             C<1, 2, or auto > B<channels with no audio input:> Audio omitted from
73             the output
74              
75             =item *
76              
77             C<1 > B<channel with any input with audio:> One track with one channel,
78             downmixed if necessary
79              
80             =item *
81              
82             C<2 > B<channels with one track with one channel:> One track with two
83             identical channels
84              
85             =item *
86              
87             C<2 or auto > B<channels with two tracks with one channel each:> One
88             track with two channels
89              
90             =item *
91              
92             C<2 or auto > B<channels with one track with two channels:> One track
93             with two channels
94              
95             =item *
96              
97             C<2 > B<channels with one track with multiple channels:> One track with
98             two channels
99              
100             =item *
101              
102             C<auto > B<channels with one track with one channel:> One track with
103             one channel
104              
105             =item *
106              
107             C<auto > B<channels with one track with multiple channels:> One track
108             with multiple channels
109              
110             =back
111              
112             When you specify C<OneChannelPerTrack>, Elastic Transcoder creates a
113             new track for every channel in your output. Your output can have up to
114             eight single-channel tracks.
115              
116             The outputs of C<OneChannelPerTrack> for a specific channel value and
117             inputs are as follows:
118              
119             =over
120              
121             =item *
122              
123             C<0 > B<channels with any input:> Audio omitted from the output
124              
125             =item *
126              
127             C<1, 2, or auto > B<channels with no audio input:> Audio omitted from
128             the output
129              
130             =item *
131              
132             C<1 > B<channel with any input with audio:> One track with one channel,
133             downmixed if necessary
134              
135             =item *
136              
137             C<2 > B<channels with one track with one channel:> Two tracks with one
138             identical channel each
139              
140             =item *
141              
142             C<2 or auto > B<channels with two tracks with one channel each:> Two
143             tracks with one channel each
144              
145             =item *
146              
147             C<2 or auto > B<channels with one track with two channels:> Two tracks
148             with one channel each
149              
150             =item *
151              
152             C<2 > B<channels with one track with multiple channels:> Two tracks
153             with one channel each
154              
155             =item *
156              
157             C<auto > B<channels with one track with one channel:> One track with
158             one channel
159              
160             =item *
161              
162             C<auto > B<channels with one track with multiple channels:> Up to eight
163             tracks with one channel each
164              
165             =back
166              
167             When you specify C<OneChannelPerTrackWithMosTo8Tracks>, Elastic
168             Transcoder creates eight single-channel tracks for your output. All
169             tracks that do not contain audio data from an input channel are MOS, or
170             Mit Out Sound, tracks.
171              
172             The outputs of C<OneChannelPerTrackWithMosTo8Tracks> for a specific
173             channel value and inputs are as follows:
174              
175             =over
176              
177             =item *
178              
179             C<0 > B<channels with any input:> Audio omitted from the output
180              
181             =item *
182              
183             C<1, 2, or auto > B<channels with no audio input:> Audio omitted from
184             the output
185              
186             =item *
187              
188             C<1 > B<channel with any input with audio:> One track with one channel,
189             downmixed if necessary, plus six MOS tracks
190              
191             =item *
192              
193             C<2 > B<channels with one track with one channel:> Two tracks with one
194             identical channel each, plus six MOS tracks
195              
196             =item *
197              
198             C<2 or auto > B<channels with two tracks with one channel each:> Two
199             tracks with one channel each, plus six MOS tracks
200              
201             =item *
202              
203             C<2 or auto > B<channels with one track with two channels:> Two tracks
204             with one channel each, plus six MOS tracks
205              
206             =item *
207              
208             C<2 > B<channels with one track with multiple channels:> Two tracks
209             with one channel each, plus six MOS tracks
210              
211             =item *
212              
213             C<auto > B<channels with one track with one channel:> One track with
214             one channel, plus seven MOS tracks
215              
216             =item *
217              
218             C<auto > B<channels with one track with multiple channels:> Up to eight
219             tracks with one channel each, plus MOS tracks until there are eight
220             tracks in all
221              
222             =back
223              
224              
225              
226             =head2 BitRate => Str
227              
228             The bit rate of the audio stream in the output file, in
229             kilobits/second. Enter an integer between 64 and 320, inclusive.
230              
231              
232             =head2 Channels => Str
233              
234             The number of audio channels in the output file. The following values
235             are valid:
236              
237             C<auto>, C<0>, C<1>, C<2>
238              
239             One channel carries the information played by a single speaker. For
240             example, a stereo track with two channels sends one channel to the left
241             speaker, and the other channel to the right speaker. The output
242             channels are organized into tracks. If you want Elastic Transcoder to
243             automatically detect the number of audio channels in the input file and
244             use that value for the output file, select C<auto>.
245              
246             The output of a specific channel value and inputs are as follows:
247              
248             =over
249              
250             =item *
251              
252             C<auto> B< channel specified, with any input:> Pass through up to eight
253             input channels.
254              
255             =item *
256              
257             C<0> B< channels specified, with any input:> Audio omitted from the
258             output.
259              
260             =item *
261              
262             C<1> B< channel specified, with at least one input channel:> Mono
263             sound.
264              
265             =item *
266              
267             C<2> B< channels specified, with any input:> Two identical mono
268             channels or stereo. For more information about tracks, see
269             C<Audio:AudioPackingMode.>
270              
271             =back
272              
273             For more information about how Elastic Transcoder organizes channels
274             and tracks, see C<Audio:AudioPackingMode>.
275              
276              
277             =head2 Codec => Str
278              
279             The audio codec for the output file. Valid values include C<aac>,
280             C<flac>, C<mp2>, C<mp3>, C<pcm>, and C<vorbis>.
281              
282              
283             =head2 CodecOptions => L<Paws::ElasticTranscoder::AudioCodecOptions>
284              
285             If you specified C<AAC> for C<Audio:Codec>, this is the C<AAC>
286             compression profile to use. Valid values include:
287              
288             C<auto>, C<AAC-LC>, C<HE-AAC>, C<HE-AACv2>
289              
290             If you specify C<auto>, Elastic Transcoder chooses a profile based on
291             the bit rate of the output file.
292              
293              
294             =head2 SampleRate => Str
295              
296             The sample rate of the audio stream in the output file, in Hertz. Valid
297             values include:
298              
299             C<auto>, C<22050>, C<32000>, C<44100>, C<48000>, C<96000>
300              
301             If you specify C<auto>, Elastic Transcoder automatically detects the
302             sample rate.
303              
304              
305              
306             =head1 SEE ALSO
307              
308             This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder>
309              
310             =head1 BUGS and CONTRIBUTIONS
311              
312             The source code is located here: https://github.com/pplu/aws-sdk-perl
313              
314             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
315              
316             =cut
317