« blib/lib/Paws/ElasticTranscoder/CreateJob.pm
↑ Summary
blib/lib/Paws/ElasticTranscoder/CreateJobPlaylist.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElasticTranscoder::CreateJobOutput; | ||
| 3 | use Moose; | ||
| 4 | has AlbumArt => (is => 'ro', isa => 'Paws::ElasticTranscoder::JobAlbumArt'); | ||
| 5 | has Captions => (is => 'ro', isa => 'Paws::ElasticTranscoder::Captions'); | ||
| 6 | has Composition => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::Clip]'); | ||
| 7 | has Encryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption'); | ||
| 8 | has Key => (is => 'ro', isa => 'Str'); | ||
| 9 | has PresetId => (is => 'ro', isa => 'Str'); | ||
| 10 | has Rotate => (is => 'ro', isa => 'Str'); | ||
| 11 | has SegmentDuration => (is => 'ro', isa => 'Str'); | ||
| 12 | has ThumbnailEncryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption'); | ||
| 13 | has ThumbnailPattern => (is => 'ro', isa => 'Str'); | ||
| 14 | has Watermarks => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::JobWatermark]'); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ElasticTranscoder::CreateJobOutput | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::ElasticTranscoder::CreateJobOutput object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { AlbumArt => $value, ..., Watermarks => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::CreateJobOutput object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->AlbumArt | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | The C<CreateJobOutput> structure. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AlbumArt => L<Paws::ElasticTranscoder::JobAlbumArt> | ||
| 52 | |||
| 53 | Information about the album art that you want Elastic Transcoder to add | ||
| 54 | to the file during transcoding. You can specify up to twenty album | ||
| 55 | artworks for each output. Settings for each artwork must be defined in | ||
| 56 | the job for the current output. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Captions => L<Paws::ElasticTranscoder::Captions> | ||
| 60 | |||
| 61 | You can configure Elastic Transcoder to transcode captions, or | ||
| 62 | subtitles, from one format to another. All captions must be in UTF-8. | ||
| 63 | Elastic Transcoder supports two types of captions: | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | B<Embedded:> Embedded captions are included in the same file as the | ||
| 70 | audio and video. Elastic Transcoder supports only one embedded caption | ||
| 71 | per language, to a maximum of 300 embedded captions per file. | ||
| 72 | |||
| 73 | Valid input values include: C<CEA-608 (EIA-608>, first non-empty | ||
| 74 | channel only), C<CEA-708 (EIA-708>, first non-empty channel only), and | ||
| 75 | C<mov-text> | ||
| 76 | |||
| 77 | Valid outputs include: C<mov-text> | ||
| 78 | |||
| 79 | Elastic Transcoder supports a maximum of one embedded format per | ||
| 80 | output. | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | B<Sidecar:> Sidecar captions are kept in a separate metadata file from | ||
| 85 | the audio and video data. Sidecar captions require a player that is | ||
| 86 | capable of understanding the relationship between the video file and | ||
| 87 | the sidecar file. Elastic Transcoder supports only one sidecar caption | ||
| 88 | per language, to a maximum of 20 sidecar captions per file. | ||
| 89 | |||
| 90 | Valid input values include: C<dfxp> (first div element only), | ||
| 91 | C<ebu-tt>, C<scc>, C<smpt>, C<srt>, C<ttml> (first div element only), | ||
| 92 | and C<webvtt> | ||
| 93 | |||
| 94 | Valid outputs include: C<dfxp> (first div element only), C<scc>, | ||
| 95 | C<srt>, and C<webvtt>. | ||
| 96 | |||
| 97 | =back | ||
| 98 | |||
| 99 | If you want ttml or smpte-tt compatible captions, specify dfxp as your | ||
| 100 | output format. | ||
| 101 | |||
| 102 | Elastic Transcoder does not support OCR (Optical Character | ||
| 103 | Recognition), does not accept pictures as a valid input for captions, | ||
| 104 | and is not available for audio-only transcoding. Elastic Transcoder | ||
| 105 | does not preserve text formatting (for example, italics) during the | ||
| 106 | transcoding process. | ||
| 107 | |||
| 108 | To remove captions or leave the captions empty, set C<Captions> to | ||
| 109 | null. To pass through existing captions unchanged, set the | ||
| 110 | C<MergePolicy> to C<MergeRetain>, and pass in a null C<CaptionSources> | ||
| 111 | array. | ||
| 112 | |||
| 113 | For more information on embedded files, see the Subtitles Wikipedia | ||
| 114 | page. | ||
| 115 | |||
| 116 | For more information on sidecar files, see the Extensible Metadata | ||
| 117 | Platform and Sidecar file Wikipedia pages. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 Composition => ArrayRef[L<Paws::ElasticTranscoder::Clip>] | ||
| 121 | |||
| 122 | You can create an output file that contains an excerpt from the input | ||
| 123 | file. This excerpt, called a clip, can come from the beginning, middle, | ||
| 124 | or end of the file. The Composition object contains settings for the | ||
| 125 | clips that make up an output file. For the current release, you can | ||
| 126 | only specify settings for a single clip per output file. The | ||
| 127 | Composition object cannot be null. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 Encryption => L<Paws::ElasticTranscoder::Encryption> | ||
| 131 | |||
| 132 | You can specify encryption settings for any output files that you want | ||
| 133 | to use for a transcoding job. This includes the output file and any | ||
| 134 | watermarks, thumbnails, album art, or captions that you want to use. | ||
| 135 | You must specify encryption settings for each file individually. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 Key => Str | ||
| 139 | |||
| 140 | The name to assign to the transcoded file. Elastic Transcoder saves the | ||
| 141 | file in the Amazon S3 bucket specified by the C<OutputBucket> object in | ||
| 142 | the pipeline that is specified by the pipeline ID. If a file with the | ||
| 143 | specified name already exists in the output bucket, the job fails. | ||
| 144 | |||
| 145 | |||
| 146 | =head2 PresetId => Str | ||
| 147 | |||
| 148 | The C<Id> of the preset to use for this job. The preset determines the | ||
| 149 | audio, video, and thumbnail settings that Elastic Transcoder uses for | ||
| 150 | transcoding. | ||
| 151 | |||
| 152 | |||
| 153 | =head2 Rotate => Str | ||
| 154 | |||
| 155 | The number of degrees clockwise by which you want Elastic Transcoder to | ||
| 156 | rotate the output relative to the input. Enter one of the following | ||
| 157 | values: C<auto>, C<0>, C<90>, C<180>, C<270>. The value C<auto> | ||
| 158 | generally works only if the file that you're transcoding contains | ||
| 159 | rotation metadata. | ||
| 160 | |||
| 161 | |||
| 162 | =head2 SegmentDuration => Str | ||
| 163 | |||
| 164 | (Outputs in Fragmented MP4 or MPEG-TS format only. | ||
| 165 | |||
| 166 | If you specify a preset in C<PresetId> for which the value of | ||
| 167 | C<Container> is C<fmp4> (Fragmented MP4) or C<ts> (MPEG-TS), | ||
| 168 | C<SegmentDuration> is the target maximum duration of each segment in | ||
| 169 | seconds. For C<HLSv3> format playlists, each media segment is stored in | ||
| 170 | a separate C<.ts> file. For C<HLSv4> and C<Smooth> playlists, all media | ||
| 171 | segments for an output are stored in a single file. Each segment is | ||
| 172 | approximately the length of the C<SegmentDuration>, though individual | ||
| 173 | segments might be shorter or longer. | ||
| 174 | |||
| 175 | The range of valid values is 1 to 60 seconds. If the duration of the | ||
| 176 | video is not evenly divisible by C<SegmentDuration>, the duration of | ||
| 177 | the last segment is the remainder of total length/SegmentDuration. | ||
| 178 | |||
| 179 | Elastic Transcoder creates an output-specific playlist for each output | ||
| 180 | C<HLS> output that you specify in OutputKeys. To add an output to the | ||
| 181 | master playlist for this job, include it in the C<OutputKeys> of the | ||
| 182 | associated playlist. | ||
| 183 | |||
| 184 | |||
| 185 | =head2 ThumbnailEncryption => L<Paws::ElasticTranscoder::Encryption> | ||
| 186 | |||
| 187 | The encryption settings, if any, that you want Elastic Transcoder to | ||
| 188 | apply to your thumbnail. | ||
| 189 | |||
| 190 | |||
| 191 | =head2 ThumbnailPattern => Str | ||
| 192 | |||
| 193 | Whether you want Elastic Transcoder to create thumbnails for your | ||
| 194 | videos and, if so, how you want Elastic Transcoder to name the files. | ||
| 195 | |||
| 196 | If you don't want Elastic Transcoder to create thumbnails, specify "". | ||
| 197 | |||
| 198 | If you do want Elastic Transcoder to create thumbnails, specify the | ||
| 199 | information that you want to include in the file name for each | ||
| 200 | thumbnail. You can specify the following values in any sequence: | ||
| 201 | |||
| 202 | =over | ||
| 203 | |||
| 204 | =item * | ||
| 205 | |||
| 206 | B<C<{count}> (Required)>: If you want to create thumbnails, you must | ||
| 207 | include C<{count}> in the C<ThumbnailPattern> object. Wherever you | ||
| 208 | specify C<{count}>, Elastic Transcoder adds a five-digit sequence | ||
| 209 | number (beginning with B<00001>) to thumbnail file names. The number | ||
| 210 | indicates where a given thumbnail appears in the sequence of thumbnails | ||
| 211 | for a transcoded file. | ||
| 212 | |||
| 213 | If you specify a literal value and/or C<{resolution}> but you omit | ||
| 214 | C<{count}>, Elastic Transcoder returns a validation error and does not | ||
| 215 | create the job. | ||
| 216 | |||
| 217 | =item * | ||
| 218 | |||
| 219 | B<Literal values (Optional)>: You can specify literal values anywhere | ||
| 220 | in the C<ThumbnailPattern> object. For example, you can include them as | ||
| 221 | a file name prefix or as a delimiter between C<{resolution}> and | ||
| 222 | C<{count}>. | ||
| 223 | |||
| 224 | =item * | ||
| 225 | |||
| 226 | B<C<{resolution}> (Optional)>: If you want Elastic Transcoder to | ||
| 227 | include the resolution in the file name, include C<{resolution}> in the | ||
| 228 | C<ThumbnailPattern> object. | ||
| 229 | |||
| 230 | =back | ||
| 231 | |||
| 232 | When creating thumbnails, Elastic Transcoder automatically saves the | ||
| 233 | files in the format (.jpg or .png) that appears in the preset that you | ||
| 234 | specified in the C<PresetID> value of C<CreateJobOutput>. Elastic | ||
| 235 | Transcoder also appends the applicable file name extension. | ||
| 236 | |||
| 237 | |||
| 238 | =head2 Watermarks => ArrayRef[L<Paws::ElasticTranscoder::JobWatermark>] | ||
| 239 | |||
| 240 | Information about the watermarks that you want Elastic Transcoder to | ||
| 241 | add to the video during transcoding. You can specify up to four | ||
| 242 | watermarks for each output. Settings for each watermark must be defined | ||
| 243 | in the preset for the current output. | ||
| 244 | |||
| 245 | |||
| 246 | |||
| 247 | =head1 SEE ALSO | ||
| 248 | |||
| 249 | This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder> | ||
| 250 | |||
| 251 | =head1 BUGS and CONTRIBUTIONS | ||
| 252 | |||
| 253 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 254 | |||
| 255 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 256 | |||
| 257 | =cut | ||
| 258 |