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