com.google.android.exoplayer2.drm

Class OfflineLicenseHelper<T extends ExoMediaCrypto>

java.lang.Object

com.google.android.exoplayer2.drm.OfflineLicenseHelper<T>

public final class OfflineLicenseHelper<T extends ExoMediaCrypto>
extends java.lang.Object

Helper class to download, renew and release offline licenses.

Constructor Summary

Constructors

Constructor and Description
OfflineLicenseHelper(java.util.UUID uuid, ExoMediaDrm<T> mediaDrm, MediaDrmCallback callback, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
byte[]	downloadLicense(DrmInitData drmInitData) Downloads an offline license.
android.util.Pair<java.lang.Long,java.lang.Long>	getLicenseDurationRemainingSec(byte[] offlineLicenseKeySetId) Returns the remaining license and playback durations in seconds, for an offline license.
byte[]	getPropertyByteArray(java.lang.String key)
java.lang.String	getPropertyString(java.lang.String key)
static OfflineLicenseHelper<FrameworkMediaCrypto>	newWidevineInstance(java.lang.String defaultLicenseUrl, boolean forceDefaultLicenseUrl, HttpDataSource.Factory httpDataSourceFactory) Instantiates a new instance which uses Widevine CDM.
static OfflineLicenseHelper<FrameworkMediaCrypto>	newWidevineInstance(java.lang.String defaultLicenseUrl, boolean forceDefaultLicenseUrl, HttpDataSource.Factory httpDataSourceFactory, java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters) Instantiates a new instance which uses Widevine CDM.
static OfflineLicenseHelper<FrameworkMediaCrypto>	newWidevineInstance(java.lang.String defaultLicenseUrl, HttpDataSource.Factory httpDataSourceFactory) Instantiates a new instance which uses Widevine CDM.
void	release() Releases the helper.
void	releaseLicense(byte[] offlineLicenseKeySetId) Releases an offline license.
byte[]	renewLicense(byte[] offlineLicenseKeySetId) Renews an offline license.
void	setPropertyByteArray(java.lang.String key, byte[] value)
void	setPropertyString(java.lang.String key, java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OfflineLicenseHelper

public OfflineLicenseHelper(java.util.UUID uuid,
                            ExoMediaDrm<T> mediaDrm,
                            MediaDrmCallback callback,
                            java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters)

Constructs an instance. Call release() when the instance is no longer required.

Parameters:

uuid - The UUID of the drm scheme.

mediaDrm - An underlying ExoMediaDrm for use by the manager.

callback - Performs key and provisioning requests.

optionalKeyRequestParameters - An optional map of parameters to pass as the last argument to MediaDrm.getKeyRequest(byte[], byte[], String, int, HashMap). May be null.

See Also:

DefaultDrmSessionManager.DefaultDrmSessionManager(java.util.UUID, ExoMediaDrm, MediaDrmCallback, HashMap, Handler, DefaultDrmSessionEventListener)

Method Detail

newWidevineInstance

public static OfflineLicenseHelper<FrameworkMediaCrypto> newWidevineInstance(java.lang.String defaultLicenseUrl,
                                                                             HttpDataSource.Factory httpDataSourceFactory)
                                                                      throws UnsupportedDrmException

Instantiates a new instance which uses Widevine CDM. Call release() when the instance is no longer required.

Parameters:

defaultLicenseUrl - The default license URL. Used for key requests that do not specify their own license URL.

httpDataSourceFactory - A factory from which to obtain HttpDataSource instances.

Returns:

A new instance which uses Widevine CDM.

Throws:

UnsupportedDrmException - If the Widevine DRM scheme is unsupported or cannot be instantiated.

newWidevineInstance

public static OfflineLicenseHelper<FrameworkMediaCrypto> newWidevineInstance(java.lang.String defaultLicenseUrl,
                                                                             boolean forceDefaultLicenseUrl,
                                                                             HttpDataSource.Factory httpDataSourceFactory)
                                                                      throws UnsupportedDrmException

Instantiates a new instance which uses Widevine CDM. Call release() when the instance is no longer required.

Parameters:

defaultLicenseUrl - The default license URL. Used for key requests that do not specify their own license URL.

forceDefaultLicenseUrl - Whether to use defaultLicenseUrl for key requests that include their own license URL.

httpDataSourceFactory - A factory from which to obtain HttpDataSource instances.

Returns:

A new instance which uses Widevine CDM.

Throws:

UnsupportedDrmException - If the Widevine DRM scheme is unsupported or cannot be instantiated.

newWidevineInstance

public static OfflineLicenseHelper<FrameworkMediaCrypto> newWidevineInstance(java.lang.String defaultLicenseUrl,
                                                                             boolean forceDefaultLicenseUrl,
                                                                             HttpDataSource.Factory httpDataSourceFactory,
                                                                             java.util.HashMap<java.lang.String,java.lang.String> optionalKeyRequestParameters)
                                                                      throws UnsupportedDrmException

Instantiates a new instance which uses Widevine CDM. Call release() when the instance is no longer required.

Parameters:

defaultLicenseUrl - The default license URL. Used for key requests that do not specify their own license URL.

forceDefaultLicenseUrl - Whether to use defaultLicenseUrl for key requests that include their own license URL.

optionalKeyRequestParameters - An optional map of parameters to pass as the last argument to MediaDrm.getKeyRequest(byte[], byte[], String, int, HashMap). May be null.

Returns:

A new instance which uses Widevine CDM.

Throws:

UnsupportedDrmException - If the Widevine DRM scheme is unsupported or cannot be instantiated.

See Also:

DefaultDrmSessionManager.DefaultDrmSessionManager(java.util.UUID, ExoMediaDrm, MediaDrmCallback, HashMap, Handler, DefaultDrmSessionEventListener)

getPropertyByteArray

public byte[] getPropertyByteArray(java.lang.String key)

See Also:

DefaultDrmSessionManager.getPropertyByteArray(java.lang.String)

setPropertyByteArray

public void setPropertyByteArray(java.lang.String key,
                                 byte[] value)

See Also:

DefaultDrmSessionManager.setPropertyByteArray(java.lang.String, byte[])

getPropertyString

public java.lang.String getPropertyString(java.lang.String key)

See Also:

DefaultDrmSessionManager.getPropertyString(java.lang.String)

setPropertyString

public void setPropertyString(java.lang.String key,
                              java.lang.String value)

See Also:

DefaultDrmSessionManager.setPropertyString(java.lang.String, java.lang.String)

downloadLicense

public byte[] downloadLicense(DrmInitData drmInitData)
                       throws DrmSession.DrmSessionException

Downloads an offline license.

Parameters:

drmInitData - The DrmInitData for the content whose license is to be downloaded.

Returns:

The key set id for the downloaded license.

Throws:

DrmSession.DrmSessionException - Thrown when a DRM session error occurs.

renewLicense

public byte[] renewLicense(byte[] offlineLicenseKeySetId)
                    throws DrmSession.DrmSessionException

Renews an offline license.

Parameters:

offlineLicenseKeySetId - The key set id of the license to be renewed.

Returns:

The renewed offline license key set id.

Throws:

DrmSession.DrmSessionException - Thrown when a DRM session error occurs.

releaseLicense

public void releaseLicense(byte[] offlineLicenseKeySetId)
                    throws DrmSession.DrmSessionException

Releases an offline license.

Parameters:

offlineLicenseKeySetId - The key set id of the license to be released.

Throws:

DrmSession.DrmSessionException - Thrown when a DRM session error occurs.

getLicenseDurationRemainingSec

public android.util.Pair<java.lang.Long,java.lang.Long> getLicenseDurationRemainingSec(byte[] offlineLicenseKeySetId)
                                                                                throws DrmSession.DrmSessionException

Returns the remaining license and playback durations in seconds, for an offline license.

Parameters:

offlineLicenseKeySetId - The key set id of the license.

Returns:

The remaining license and playback durations, in seconds.

Throws:

DrmSession.DrmSessionException - Thrown when a DRM session error occurs.

release

public void release()

Releases the helper. Should be called when the helper is no longer required.