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

#include <widevine_key_source.h>

Inheritance diagram for shaka::media::WidevineKeySource:
shaka::media::KeySource

Public Member Functions

 WidevineKeySource (const std::string &server_url, bool add_common_pssh)
 
Status FetchKeys (const std::vector< uint8_t > &content_id, const std::string &policy)
 
void set_signer (std::unique_ptr< RequestSigner > signer)
 
void set_key_fetcher (std::unique_ptr< KeyFetcher > key_fetcher)
 
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
 

Protected Attributes

ClosureThread key_production_thread_
 

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_UHD1 = 3,
  TRACK_TYPE_UHD2 = 4, TRACK_TYPE_AUDIO = 5, TRACK_TYPE_UNSPECIFIED = 6, NUM_VALID_TRACK_TYPES = 6
}
 
- 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.
 

Detailed Description

WidevineKeySource talks to the Widevine encryption service to acquire the encryption keys.

Definition at line 30 of file widevine_key_source.h.

Constructor & Destructor Documentation

shaka::media::WidevineKeySource::WidevineKeySource ( const std::string &  server_url,
bool  add_common_pssh 
)
Parameters
server_urlis the Widevine common encryption server url.

Definition at line 134 of file widevine_key_source.cc.

Member Function Documentation

Status shaka::media::WidevineKeySource::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 172 of file widevine_key_source.cc.

Status shaka::media::WidevineKeySource::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 199 of file widevine_key_source.cc.

Status shaka::media::WidevineKeySource::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 220 of file widevine_key_source.cc.

Status shaka::media::WidevineKeySource::FetchKeys ( const std::vector< uint8_t > &  content_id,
const std::string &  policy 
)

Fetch keys for CENC from the key server.

Parameters
content_idthe unique id identify the content.
policyspecifies the DRM content rights.
Returns
OK on success, an error status otherwise.

Definition at line 161 of file widevine_key_source.cc.

Status shaka::media::WidevineKeySource::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 252 of file widevine_key_source.cc.

Status shaka::media::WidevineKeySource::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 229 of file widevine_key_source.cc.

Status shaka::media::WidevineKeySource::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 239 of file widevine_key_source.cc.

void shaka::media::WidevineKeySource::set_key_fetcher ( std::unique_ptr< KeyFetcher key_fetcher)

Inject an KeyFetcher object, mainly used for testing.

Parameters
key_fetcherpoints to the KeyFetcher object to be injected.

Definition at line 278 of file widevine_key_source.cc.

void shaka::media::WidevineKeySource::set_signer ( std::unique_ptr< RequestSigner signer)

Set signer for the key source.

Parameters
signersigns the request message.

Definition at line 274 of file widevine_key_source.cc.


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