« blib/lib/Paws/ElasticTranscoder/CancelJobResponse.pm
↑ Summary
blib/lib/Paws/ElasticTranscoder/CaptionSource.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElasticTranscoder::CaptionFormat; | ||
| 3 | use Moose; | ||
| 4 | has Encryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption'); | ||
| 5 | has Format => (is => 'ro', isa => 'Str'); | ||
| 6 | has Pattern => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::ElasticTranscoder::CaptionFormat | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::ElasticTranscoder::CaptionFormat object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Encryption => $value, ..., Pattern => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::CaptionFormat object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Encryption | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The file format of the output captions. If you leave this value blank, | ||
| 39 | Elastic Transcoder returns an error. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 Encryption => L<Paws::ElasticTranscoder::Encryption> | ||
| 45 | |||
| 46 | The encryption settings, if any, that you want Elastic Transcoder to | ||
| 47 | apply to your caption formats. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Format => Str | ||
| 51 | |||
| 52 | The format you specify determines whether Elastic Transcoder generates | ||
| 53 | an embedded or sidecar caption for this output. | ||
| 54 | |||
| 55 | =over | ||
| 56 | |||
| 57 | =item * | ||
| 58 | |||
| 59 | B<Valid Embedded Caption Formats:> | ||
| 60 | |||
| 61 | =over | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | B<for FLAC>: None | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | B<For MP3>: None | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | B<For MP4>: mov-text | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | B<For MPEG-TS>: None | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | B<For ogg>: None | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | B<For webm>: None | ||
| 86 | |||
| 87 | =back | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | B<Valid Sidecar Caption Formats:> Elastic Transcoder supports dfxp | ||
| 92 | (first div element only), scc, srt, and webvtt. If you want ttml or | ||
| 93 | smpte-tt compatible captions, specify dfxp as your output format. | ||
| 94 | |||
| 95 | =over | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | B<For FMP4>: dfxp | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | B<Non-FMP4 outputs>: All sidecar types | ||
| 104 | |||
| 105 | =back | ||
| 106 | |||
| 107 | C<fmp4> captions have an extension of C<.ismt> | ||
| 108 | |||
| 109 | =back | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 Pattern => Str | ||
| 114 | |||
| 115 | The prefix for caption filenames, in the form | ||
| 116 | I<description>-C<{language}>, where: | ||
| 117 | |||
| 118 | =over | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | I<description> is a description of the video. | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | C<{language}> is a literal value that Elastic Transcoder replaces with | ||
| 127 | the two- or three-letter code for the language of the caption in the | ||
| 128 | output file names. | ||
| 129 | |||
| 130 | =back | ||
| 131 | |||
| 132 | If you don't include C<{language}> in the file name pattern, Elastic | ||
| 133 | Transcoder automatically appends "C<{language}>" to the value that you | ||
| 134 | specify for the description. In addition, Elastic Transcoder | ||
| 135 | automatically appends the count to the end of the segment files. | ||
| 136 | |||
| 137 | For example, suppose you're transcoding into srt format. When you enter | ||
| 138 | "Sydney-{language}-sunrise", and the language of the captions is | ||
| 139 | English (en), the name of the first caption file is be | ||
| 140 | Sydney-en-sunrise00000.srt. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head1 SEE ALSO | ||
| 145 | |||
| 146 | This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder> | ||
| 147 | |||
| 148 | =head1 BUGS and CONTRIBUTIONS | ||
| 149 | |||
| 150 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 151 | |||
| 152 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 153 | |||
| 154 | =cut | ||
| 155 |