« blib/lib/Paws/ElasticTranscoder/PipelineOutputConfig.pm
↑ Summary
blib/lib/Paws/ElasticTranscoder/Playlist.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElasticTranscoder::PlayReadyDrm; | ||
| 3 | use Moose; | ||
| 4 | has Format => (is => 'ro', isa => 'Str'); | ||
| 5 | has InitializationVector => (is => 'ro', isa => 'Str'); | ||
| 6 | has Key => (is => 'ro', isa => 'Str'); | ||
| 7 | has KeyId => (is => 'ro', isa => 'Str'); | ||
| 8 | has KeyMd5 => (is => 'ro', isa => 'Str'); | ||
| 9 | has LicenseAcquisitionUrl => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::ElasticTranscoder::PlayReadyDrm | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::ElasticTranscoder::PlayReadyDrm object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Format => $value, ..., LicenseAcquisitionUrl => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::PlayReadyDrm object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Format | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | The PlayReady DRM settings, if any, that you want Elastic Transcoder to | ||
| 42 | apply to the output files associated with this playlist. | ||
| 43 | |||
| 44 | PlayReady DRM encrypts your media files using C<aes-ctr> encryption. | ||
| 45 | |||
| 46 | If you use DRM for an C<HLSv3> playlist, your outputs must have a | ||
| 47 | master playlist. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Format => Str | ||
| 53 | |||
| 54 | The type of DRM, if any, that you want Elastic Transcoder to apply to | ||
| 55 | the output files associated with this playlist. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 InitializationVector => Str | ||
| 59 | |||
| 60 | The series of random bits created by a random bit generator, unique for | ||
| 61 | every encryption operation, that you want Elastic Transcoder to use to | ||
| 62 | encrypt your files. The initialization vector must be base64-encoded, | ||
| 63 | and it must be exactly 8 bytes long before being base64-encoded. If no | ||
| 64 | initialization vector is provided, Elastic Transcoder generates one for | ||
| 65 | you. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Key => Str | ||
| 69 | |||
| 70 | The DRM key for your file, provided by your DRM license provider. The | ||
| 71 | key must be base64-encoded, and it must be one of the following bit | ||
| 72 | lengths before being base64-encoded: | ||
| 73 | |||
| 74 | C<128>, C<192>, or C<256>. | ||
| 75 | |||
| 76 | The key must also be encrypted by using AWS KMS. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 KeyId => Str | ||
| 80 | |||
| 81 | The ID for your DRM key, so that your DRM license provider knows which | ||
| 82 | key to provide. | ||
| 83 | |||
| 84 | The key ID must be provided in big endian, and Elastic Transcoder | ||
| 85 | converts it to little endian before inserting it into the PlayReady DRM | ||
| 86 | headers. If you are unsure whether your license server provides your | ||
| 87 | key ID in big or little endian, check with your DRM provider. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 KeyMd5 => Str | ||
| 91 | |||
| 92 | The MD5 digest of the key used for DRM on your file, and that you want | ||
| 93 | Elastic Transcoder to use as a checksum to make sure your key was not | ||
| 94 | corrupted in transit. The key MD5 must be base64-encoded, and it must | ||
| 95 | be exactly 16 bytes before being base64-encoded. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 LicenseAcquisitionUrl => Str | ||
| 99 | |||
| 100 | The location of the license key required to play DRM content. The URL | ||
| 101 | must be an absolute path, and is referenced by the PlayReady header. | ||
| 102 | The PlayReady header is referenced in the protection header of the | ||
| 103 | client manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM | ||
| 104 | and EXT-XDXDRMINFO metadata tags for HLS playlist outputs. An example | ||
| 105 | URL looks like this: C<https://www.example.com/exampleKey/> | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |