File Coverage

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