File Coverage

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