DASH Media Packaging SDK
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator
Static Public Member Functions | List of all members
shaka::media::FixedKeySource Class Reference

A key source that uses fixed keys for encryption. More...

#include <fixed_key_source.h>

Inheritance diagram for shaka::media::FixedKeySource:
shaka::media::KeySource

Public Member Functions

KeySource implementation overrides.
Status FetchKeys (const std::vector< uint8_t > &pssh_box) override
 
Status FetchKeys (const std::vector< std::vector< uint8_t >> &key_ids) override
 
Status FetchKeys (uint32_t asset_id) override
 
Status GetKey (TrackType track_type, EncryptionKey *key) override
 
Status GetKey (const std::vector< uint8_t > &key_id, EncryptionKey *key) override
 
Status GetCryptoPeriodKey (uint32_t crypto_period_index, TrackType track_type, EncryptionKey *key) override
 

Static Public Member Functions

static scoped_ptr< FixedKeySourceCreateFromHexStrings (const std::string &key_id_hex, const std::string &key_hex, const std::string &pssh_boxes_hex, const std::string &iv_hex)
 
- Static Public Member Functions inherited from shaka::media::KeySource
static TrackType GetTrackTypeFromString (const std::string &track_type_string)
 Convert string representation of track type to enum representation.
 
static std::string TrackTypeToString (TrackType track_type)
 Convert TrackType to string.
 

Additional Inherited Members

- Public Types inherited from shaka::media::KeySource
enum  TrackType {
  TRACK_TYPE_UNKNOWN = 0, TRACK_TYPE_SD = 1, TRACK_TYPE_HD = 2, TRACK_TYPE_AUDIO = 3,
  TRACK_TYPE_UNSPECIFIED = 4, NUM_VALID_TRACK_TYPES = 4
}
 

Detailed Description

A key source that uses fixed keys for encryption.

Definition at line 27 of file fixed_key_source.h.

Member Function Documentation

scoped_ptr< FixedKeySource > shaka::media::FixedKeySource::CreateFromHexStrings ( const std::string &  key_id_hex,
const std::string &  key_hex,
const std::string &  pssh_boxes_hex,
const std::string &  iv_hex 
)
static

Creates a new FixedKeySource from the given hex strings. Returns null if the strings are invalid.

Parameters
key_id_hexis the key id in hex string.
key_hexis the key in hex string.
pssh_boxes_hexis the pssh_boxes in hex string.
iv_hexis the IV in hex string. If not specified, a randomly generated IV with the default length will be used. Note: GetKey on the created key source will always return the same key for all track types.

Definition at line 84 of file fixed_key_source.cc.

Status shaka::media::FixedKeySource::FetchKeys ( const std::vector< uint8_t > &  pssh_box)
overridevirtual

Fetch keys for CENC from the key server.

Parameters
pssh_boxThe entire PSSH box for the content to be decrypted
Returns
OK on success, an error status otherwise.

Implements shaka::media::KeySource.

Definition at line 17 of file fixed_key_source.cc.

Status shaka::media::FixedKeySource::FetchKeys ( const std::vector< std::vector< uint8_t >> &  key_ids)
overridevirtual

Fetch keys for CENC from the key server.

Parameters
key_idsthe key IDs for the keys to fetch from the server.
Returns
OK on success, an error status otherwise.

Implements shaka::media::KeySource.

Definition at line 22 of file fixed_key_source.cc.

Status shaka::media::FixedKeySource::FetchKeys ( uint32_t  asset_id)
overridevirtual

Fetch keys for WVM decryption from the key server.

Parameters
asset_idis the Widevine Classic asset ID for the content to be decrypted.
Returns
OK on success, an error status otherwise.

Implements shaka::media::KeySource.

Definition at line 28 of file fixed_key_source.cc.

Status shaka::media::FixedKeySource::GetCryptoPeriodKey ( uint32_t  crypto_period_index,
TrackType  track_type,
EncryptionKey key 
)
overridevirtual

Get encryption key of the specified track type at the specified index.

Parameters
crypto_period_indexis the sequence number of the key rotation period for which the key is being retrieved.
track_typeis the type of track for which retrieving the key.
keyis a pointer to the EncryptionKey which will hold the retrieved key. Owner retains ownership, and may not be NULL.
Returns
OK on success, an error status otherwise.

Implements shaka::media::KeySource.

Definition at line 54 of file fixed_key_source.cc.

Status shaka::media::FixedKeySource::GetKey ( TrackType  track_type,
EncryptionKey key 
)
overridevirtual

Get encryption key of the specified track type.

Parameters
track_typeis the type of track for which retrieving the key.
keyis a pointer to the EncryptionKey which will hold the retrieved key. Owner retains ownership, and may not be NULL.
Returns
OK on success, an error status otherwise.

Implements shaka::media::KeySource.

Definition at line 33 of file fixed_key_source.cc.

Status shaka::media::FixedKeySource::GetKey ( const std::vector< uint8_t > &  key_id,
EncryptionKey key 
)
overridevirtual

Get the encryption key specified by the CENC key ID.

Parameters
key_idis the unique identifier for the key being retreived.
keyis a pointer to the EncryptionKey which will hold the retrieved key. Owner retains ownership, and may not be NULL.
Returns
OK on success, or an error status otherwise.

Implements shaka::media::KeySource.

Definition at line 40 of file fixed_key_source.cc.


The documentation for this class was generated from the following files: