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