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