« blib/lib/Paws/ElasticTranscoder/CaptionFormat.pm
↑ Summary
blib/lib/Paws/ElasticTranscoder/Captions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElasticTranscoder::CaptionSource; | ||
| 3 | use Moose; | ||
| 4 | has Encryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption'); | ||
| 5 | has Key => (is => 'ro', isa => 'Str'); | ||
| 6 | has Label => (is => 'ro', isa => 'Str'); | ||
| 7 | has Language => (is => 'ro', isa => 'Str'); | ||
| 8 | has TimeOffset => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::ElasticTranscoder::CaptionSource | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::ElasticTranscoder::CaptionSource object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Encryption => $value, ..., TimeOffset => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::CaptionSource object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Encryption | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | A source file for the input sidecar captions used during the | ||
| 41 | transcoding process. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Encryption => L<Paws::ElasticTranscoder::Encryption> | ||
| 47 | |||
| 48 | The encryption settings, if any, that Elastic Transcoder needs to | ||
| 49 | decyrpt your caption sources, or that you want Elastic Transcoder to | ||
| 50 | apply to your caption sources. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Key => Str | ||
| 54 | |||
| 55 | The name of the sidecar caption file that you want Elastic Transcoder | ||
| 56 | to include in the output file. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Label => Str | ||
| 60 | |||
| 61 | The label of the caption shown in the player when choosing a language. | ||
| 62 | We recommend that you put the caption language name here, in the | ||
| 63 | language of the captions. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Language => Str | ||
| 67 | |||
| 68 | A string that specifies the language of the caption. If you specified | ||
| 69 | multiple inputs with captions, the caption language must match in order | ||
| 70 | to be included in the output. Specify this as one of: | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | 2-character ISO 639-1 code | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | 3-character ISO 639-2 code | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | For more information on ISO language codes and language names, see the | ||
| 85 | List of ISO 639-1 codes. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 TimeOffset => Str | ||
| 89 | |||
| 90 | For clip generation or captions that do not start at the same time as | ||
| 91 | the associated video file, the C<TimeOffset> tells Elastic Transcoder | ||
| 92 | how much of the video to encode before including captions. | ||
| 93 | |||
| 94 | Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |