You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticTranscoder::Types::PlayReadyDrm

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb

Overview

Note:

When making an API call, you may pass PlayReadyDrm data as a hash:

{
  format: "PlayReadyDrmFormatString",
  key: "NonEmptyBase64EncodedString",
  key_md_5: "NonEmptyBase64EncodedString",
  key_id: "KeyIdGuid",
  initialization_vector: "ZeroTo255String",
  license_acquisition_url: "OneTo512String",
}

The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

PlayReady DRM encrypts your media files using AES-CTR encryption.

If you use DRM for an HLSv3 playlist, your outputs must have a master playlist.

Instance Attribute Summary collapse

Instance Attribute Details

#formatString

The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

Returns:

  • (String)


3555
3556
3557
3558
3559
3560
3561
3562
3563
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3555

class PlayReadyDrm < Struct.new(
  :format,
  :key,
  :key_md_5,
  :key_id,
  :initialization_vector,
  :license_acquisition_url)
  include Aws::Structure
end

#initialization_vectorString

The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your files. The initialization vector must be base64-encoded, and it must be exactly 8 bytes long before being base64-encoded. If no initialization vector is provided, Elastic Transcoder generates one for you.

Returns:

  • (String)


3555
3556
3557
3558
3559
3560
3561
3562
3563
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3555

class PlayReadyDrm < Struct.new(
  :format,
  :key,
  :key_md_5,
  :key_id,
  :initialization_vector,
  :license_acquisition_url)
  include Aws::Structure
end

#keyString

The DRM key for your file, provided by your DRM license provider. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:

128, 192, or 256.

The key must also be encrypted by using AWS KMS.

Returns:

  • (String)


3555
3556
3557
3558
3559
3560
3561
3562
3563
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3555

class PlayReadyDrm < Struct.new(
  :format,
  :key,
  :key_md_5,
  :key_id,
  :initialization_vector,
  :license_acquisition_url)
  include Aws::Structure
end

#key_idString

The ID for your DRM key, so that your DRM license provider knows which key to provide.

The key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in big or little endian, check with your DRM provider.

Returns:

  • (String)


3555
3556
3557
3558
3559
3560
3561
3562
3563
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3555

class PlayReadyDrm < Struct.new(
  :format,
  :key,
  :key_md_5,
  :key_id,
  :initialization_vector,
  :license_acquisition_url)
  include Aws::Structure
end

#key_md_5String

The MD5 digest of the key used for DRM on your file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.

Returns:

  • (String)


3555
3556
3557
3558
3559
3560
3561
3562
3563
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3555

class PlayReadyDrm < Struct.new(
  :format,
  :key,
  :key_md_5,
  :key_id,
  :initialization_vector,
  :license_acquisition_url)
  include Aws::Structure
end

#license_acquisition_urlString

The location of the license key required to play DRM content. The URL must be an absolute path, and is referenced by the PlayReady header. The PlayReady header is referenced in the protection header of the client manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata tags for HLS playlist outputs. An example URL looks like this: https://www.example.com/exampleKey/

Returns:

  • (String)


3555
3556
3557
3558
3559
3560
3561
3562
3563
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 3555

class PlayReadyDrm < Struct.new(
  :format,
  :key,
  :key_md_5,
  :key_id,
  :initialization_vector,
  :license_acquisition_url)
  include Aws::Structure
end