File Coverage

blib/lib/Paws/ElasticTranscoder/CreateJobPlaylist.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::CreateJobPlaylist;
2 1     1   858 use Moose;
  1         5  
  1         11  
3             has Format => (is => 'ro', isa => 'Str');
4             has HlsContentProtection => (is => 'ro', isa => 'Paws::ElasticTranscoder::HlsContentProtection');
5             has Name => (is => 'ro', isa => 'Str');
6             has OutputKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has PlayReadyDrm => (is => 'ro', isa => 'Paws::ElasticTranscoder::PlayReadyDrm');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::ElasticTranscoder::CreateJobPlaylist
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::CreateJobPlaylist object:
26              
27             $service_obj->Method(Att1 => { Format => $value, ..., PlayReadyDrm => $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::CreateJobPlaylist object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->Format
35              
36             =head1 DESCRIPTION
37              
38             Information about the master playlist.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 Format => Str
44              
45             The format of the output playlist. Valid formats include C<HLSv3>,
46             C<HLSv4>, and C<Smooth>.
47              
48              
49             =head2 HlsContentProtection => L<Paws::ElasticTranscoder::HlsContentProtection>
50              
51             The HLS content protection settings, if any, that you want Elastic
52             Transcoder to apply to the output files associated with this playlist.
53              
54              
55             =head2 Name => Str
56              
57             The name that you want Elastic Transcoder to assign to the master
58             playlist, for example, nyc-vacation.m3u8. If the name includes a C</>
59             character, the section of the name before the last C</> must be
60             identical for all C<Name> objects. If you create more than one master
61             playlist, the values of all C<Name> objects must be unique.
62              
63             Elastic Transcoder automatically appends the relevant file extension to
64             the file name (C<.m3u8> for C<HLSv3> and C<HLSv4> playlists, and
65             C<.ism> and C<.ismc> for C<Smooth> playlists). If you include a file
66             extension in C<Name>, the file name will have two extensions.
67              
68              
69             =head2 OutputKeys => ArrayRef[Str|Undef]
70              
71             For each output in this job that you want to include in a master
72             playlist, the value of the C<Outputs:Key> object.
73              
74             =over
75              
76             =item *
77              
78             If your output is not C<HLS> or does not have a segment duration set,
79             the name of the output file is a concatenation of C<OutputKeyPrefix>
80             and C<Outputs:Key>:
81              
82             OutputKeyPrefixC<Outputs:Key>
83              
84             =item *
85              
86             If your output is C<HLSv3> and has a segment duration set, or is not
87             included in a playlist, Elastic Transcoder creates an output playlist
88             file with a file extension of C<.m3u8>, and a series of C<.ts> files
89             that include a five-digit sequential counter beginning with 00000:
90              
91             OutputKeyPrefixC<Outputs:Key>.m3u8
92              
93             OutputKeyPrefixC<Outputs:Key>00000.ts
94              
95             =item *
96              
97             If your output is C<HLSv4>, has a segment duration set, and is included
98             in an C<HLSv4> playlist, Elastic Transcoder creates an output playlist
99             file with a file extension of C<_v4.m3u8>. If the output is video,
100             Elastic Transcoder also creates an output file with an extension of
101             C<_iframe.m3u8>:
102              
103             OutputKeyPrefixC<Outputs:Key>_v4.m3u8
104              
105             OutputKeyPrefixC<Outputs:Key>_iframe.m3u8
106              
107             OutputKeyPrefixC<Outputs:Key>.ts
108              
109             =back
110              
111             Elastic Transcoder automatically appends the relevant file extension to
112             the file name. If you include a file extension in Output Key, the file
113             name will have two extensions.
114              
115             If you include more than one output in a playlist, any segment duration
116             settings, clip settings, or caption settings must be the same for all
117             outputs in the playlist. For C<Smooth> playlists, the C<Audio:Profile>,
118             C<Video:Profile>, and C<Video:FrameRate> to C<Video:KeyframesMaxDist>
119             ratio must be the same for all outputs.
120              
121              
122             =head2 PlayReadyDrm => L<Paws::ElasticTranscoder::PlayReadyDrm>
123              
124             The DRM settings, if any, that you want Elastic Transcoder to apply to
125             the output files associated with this playlist.
126              
127              
128              
129             =head1 SEE ALSO
130              
131             This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder>
132              
133             =head1 BUGS and CONTRIBUTIONS
134              
135             The source code is located here: https://github.com/pplu/aws-sdk-perl
136              
137             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
138              
139             =cut
140