File Coverage

blib/lib/Paws/ElasticTranscoder/CaptionSource.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::ElasticTranscoder::CaptionSource;
2 1     1   857 use Moose;
  1         6  
  1         11  
3             has Encryption => (is => 'ro', isa => 'Paws::ElasticTranscoder::Encryption');
4             has Key => (is => 'ro', isa => 'Str');
5             has Label => (is => 'ro', isa => 'Str');
6             has Language => (is => 'ro', isa => 'Str');
7             has TimeOffset => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::ElasticTranscoder::CaptionSource
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::CaptionSource object:
26              
27             $service_obj->Method(Att1 => { Encryption => $value, ..., TimeOffset => $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::CaptionSource object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->Encryption
35              
36             =head1 DESCRIPTION
37              
38             A source file for the input sidecar captions used during the
39             transcoding process.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 Encryption => L<Paws::ElasticTranscoder::Encryption>
45              
46             The encryption settings, if any, that Elastic Transcoder needs to
47             decyrpt your caption sources, or that you want Elastic Transcoder to
48             apply to your caption sources.
49              
50              
51             =head2 Key => Str
52              
53             The name of the sidecar caption file that you want Elastic Transcoder
54             to include in the output file.
55              
56              
57             =head2 Label => Str
58              
59             The label of the caption shown in the player when choosing a language.
60             We recommend that you put the caption language name here, in the
61             language of the captions.
62              
63              
64             =head2 Language => Str
65              
66             A string that specifies the language of the caption. If you specified
67             multiple inputs with captions, the caption language must match in order
68             to be included in the output. Specify this as one of:
69              
70             =over
71              
72             =item *
73              
74             2-character ISO 639-1 code
75              
76             =item *
77              
78             3-character ISO 639-2 code
79              
80             =back
81              
82             For more information on ISO language codes and language names, see the
83             List of ISO 639-1 codes.
84              
85              
86             =head2 TimeOffset => Str
87              
88             For clip generation or captions that do not start at the same time as
89             the associated video file, the C<TimeOffset> tells Elastic Transcoder
90             how much of the video to encode before including captions.
91              
92             Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
93              
94              
95              
96             =head1 SEE ALSO
97              
98             This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder>
99              
100             =head1 BUGS and CONTRIBUTIONS
101              
102             The source code is located here: https://github.com/pplu/aws-sdk-perl
103              
104             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
105              
106             =cut
107