Field Detail

• EVENT_KEY_REQUIRED

  static final int EVENT_KEY_REQUIRED

  Deprecated.
  Event indicating that keys need to be requested from the license server.

  See Also:

  Constant Field Values

• EVENT_KEY_EXPIRED

  static final int EVENT_KEY_EXPIRED

  Deprecated.
  Event indicating that keys have expired, and are no longer usable.

  See Also:

  Constant Field Values

• EVENT_PROVISION_REQUIRED

  static final int EVENT_PROVISION_REQUIRED

  Deprecated.
  Event indicating that a certificate needs to be requested from the provisioning server.

  See Also:

  Constant Field Values

• KEY_TYPE_STREAMING

  static final int KEY_TYPE_STREAMING

  Deprecated.
  Key request type for keys that will be used for online use. Streaming keys will not be saved to the device for subsequent use when the device is not connected to a network.

  See Also:

  Constant Field Values

• KEY_TYPE_OFFLINE

  static final int KEY_TYPE_OFFLINE

  Deprecated.
  Key request type for keys that will be used for offline use. They will be saved to the device for subsequent use when the device is not connected to a network.

  See Also:

  Constant Field Values

• KEY_TYPE_RELEASE

  static final int KEY_TYPE_RELEASE

  Deprecated.
  Key request type indicating that saved offline keys should be released.

  See Also:

  Constant Field Values

Method Detail

• setOnEventListener

  void setOnEventListener​(@Nullable
                          ExoMediaDrm.OnEventListener listener)

  Deprecated.
  Sets the listener for DRM events.

  This is an optional method, and some implementations may only support it on certain Android API levels.

  Parameters:

  listener - The listener to receive events, or null to stop receiving events.

  Throws:

  UnsupportedOperationException - if the implementation doesn't support this method.

  See Also:

  MediaDrm.setOnEventListener(MediaDrm.OnEventListener)

• setOnKeyStatusChangeListener

  void setOnKeyStatusChangeListener​(@Nullable
                                    ExoMediaDrm.OnKeyStatusChangeListener listener)

  Deprecated.
  Sets the listener for key status change events.

  This is an optional method, and some implementations may only support it on certain Android API levels.

  Parameters:

  listener - The listener to receive events, or null to stop receiving events.

  Throws:

  UnsupportedOperationException - if the implementation doesn't support this method.

  See Also:

  MediaDrm.setOnKeyStatusChangeListener(MediaDrm.OnKeyStatusChangeListener, Handler)

• setOnExpirationUpdateListener

  void setOnExpirationUpdateListener​(@Nullable
                                     ExoMediaDrm.OnExpirationUpdateListener listener)

  Deprecated.
  Sets the listener for session expiration events.

  This is an optional method, and some implementations may only support it on certain Android API levels.

  Parameters:

  listener - The listener to receive events, or null to stop receiving events.

  Throws:

  UnsupportedOperationException - if the implementation doesn't support this method.

  See Also:

  MediaDrm.setOnExpirationUpdateListener(MediaDrm.OnExpirationUpdateListener, Handler)

• openSession

  byte[] openSession()
              throws MediaDrmException

  Deprecated.
  Opens a new DRM session. A session ID is returned.

  Returns:

  The session ID.

  Throws:

  NotProvisionedException - If provisioning is needed.

  ResourceBusyException - If required resources are in use.

  MediaDrmException - If the session could not be opened.

• closeSession

  void closeSession​(byte[] sessionId)

  Deprecated.
  Closes a DRM session.

  Parameters:

  sessionId - The ID of the session to close.

• setPlayerIdForSession

  default void setPlayerIdForSession​(byte[] sessionId,
                                     PlayerId playerId)

  Deprecated.
  Sets the PlayerId of the player using a session.

  Parameters:

  sessionId - The ID of the session.

  playerId - The PlayerId of the player using the session.

• getKeyRequest

  ExoMediaDrm.KeyRequest getKeyRequest​(byte[] scope,
                                       @Nullable
                                       List<DrmInitData.SchemeData> schemeDatas,
                                       int keyType,
                                       @Nullable
                                       HashMap<String,​String> optionalParameters)
                                throws NotProvisionedException

  Deprecated.
  Generates a key request.

  Parameters:

  scope - If keyType is KEY_TYPE_STREAMING or KEY_TYPE_OFFLINE, the ID of the session that the keys will be provided to. If keyType is KEY_TYPE_RELEASE, the keySetId of the keys to release.

  schemeDatas - If key type is KEY_TYPE_STREAMING or KEY_TYPE_OFFLINE, a list of DrmInitData.SchemeData instances extracted from the media. Null otherwise.

  keyType - The type of the request. Either KEY_TYPE_STREAMING to acquire keys for streaming, KEY_TYPE_OFFLINE to acquire keys for offline usage, or KEY_TYPE_RELEASE to release acquired keys. Releasing keys invalidates them for all sessions.

  optionalParameters - Are included in the key request message to allow a client application to provide additional message parameters to the server. This may be null if no additional parameters are to be sent.

  Returns:

  The generated key request.

  Throws:

  NotProvisionedException

  See Also:

  MediaDrm.getKeyRequest(byte[], byte[], String, int, HashMap)

• provideKeyResponse

  @Nullable
  byte[] provideKeyResponse​(byte[] scope,
                            byte[] response)
                     throws NotProvisionedException,
                            DeniedByServerException

  Deprecated.
  Provides a key response for the last request to be generated using getKeyRequest(byte[], java.util.List<com.google.android.exoplayer2.drm.DrmInitData.SchemeData>, int, java.util.HashMap<java.lang.String, java.lang.String>).

  Parameters:

  scope - If the request had type KEY_TYPE_STREAMING or KEY_TYPE_OFFLINE, the ID of the session to provide the keys to. If keyType is KEY_TYPE_RELEASE, the keySetId of the keys being released.

  response - The response data from the server.

  Returns:

  If the request had type KEY_TYPE_OFFLINE, the keySetId for the offline keys. An empty byte array or null may be returned for other cases.

  Throws:

  NotProvisionedException - If the response indicates that provisioning is needed.

  DeniedByServerException - If the response indicates that the server rejected the request.

• getProvisionRequest

  ExoMediaDrm.ProvisionRequest getProvisionRequest()

  Deprecated.
  Generates a provisioning request.

  Returns:

  The generated provisioning request.

• provideProvisionResponse

  void provideProvisionResponse​(byte[] response)
                         throws DeniedByServerException

  Deprecated.
  Provides a provisioning response for the last request to be generated using getProvisionRequest().

  Parameters:

  response - The response data from the server.

  Throws:

  DeniedByServerException - If the response indicates that the server rejected the request.

• queryKeyStatus

  Map<String,​String> queryKeyStatus​(byte[] sessionId)

  Deprecated.
  Returns the key status for a given session, as {name, value} pairs. Since DRM license policies vary by vendor, the returned entries depend on the DRM plugin being used. Refer to your DRM provider's documentation for more information.

  Parameters:

  sessionId - The ID of the session being queried.

  Returns:

  The key status for the session.

• requiresSecureDecoder

  boolean requiresSecureDecoder​(byte[] sessionId,
                                String mimeType)

  Deprecated.
  Returns whether the given session requires use of a secure decoder for the given MIME type. Assumes a license policy that requires the highest level of security supported by the session.

  Parameters:

  sessionId - The ID of the session.

  mimeType - The content MIME type to query.

• acquire

  void acquire()

  Deprecated.
  Increments the reference count. When the caller no longer needs to use the instance, it must call release() to decrement the reference count.

  A new instance will have an initial reference count of 1, and therefore it is not normally necessary for application code to call this method.

• release

  void release()

  Deprecated.
  Decrements the reference count. If the reference count drops to 0 underlying resources are released, and the instance cannot be re-used.

• restoreKeys

  void restoreKeys​(byte[] sessionId,
                   byte[] keySetId)

  Deprecated.
  Restores persisted offline keys into a session.

  Parameters:

  sessionId - The ID of the session into which the keys will be restored.

  keySetId - The keySetId of the keys to restore, as provided by the call to provideKeyResponse(byte[], byte[]) that persisted them.

• getMetrics

  @Nullable
  PersistableBundle getMetrics()

  Deprecated.
  Returns metrics data for this ExoMediaDrm instance, or null if metrics are unavailable.

• getPropertyString

  String getPropertyString​(String propertyName)

  Deprecated.
  Returns the value of a string property. For standard property names, see MediaDrm.getPropertyString(java.lang.String).

  Parameters:

  propertyName - The property name.

  Returns:

  The property value.

  Throws:

  IllegalArgumentException - If the underlying DRM plugin does not support the property.

• getPropertyByteArray

  byte[] getPropertyByteArray​(String propertyName)

  Deprecated.
  Returns the value of a byte array property. For standard property names, see MediaDrm.getPropertyByteArray(java.lang.String).

  Parameters:

  propertyName - The property name.

  Returns:

  The property value.

  Throws:

  IllegalArgumentException - If the underlying DRM plugin does not support the property.

• setPropertyString

  void setPropertyString​(String propertyName,
                         String value)

  Deprecated.
  Sets the value of a string property.

  Parameters:

  propertyName - The property name.

  value - The value.

  Throws:

  IllegalArgumentException - If the underlying DRM plugin does not support the property.

• setPropertyByteArray

  void setPropertyByteArray​(String propertyName,
                            byte[] value)

  Deprecated.
  Sets the value of a byte array property.

  Parameters:

  propertyName - The property name.

  value - The value.

  Throws:

  IllegalArgumentException - If the underlying DRM plugin does not support the property.

• createCryptoConfig

  CryptoConfig createCryptoConfig​(byte[] sessionId)
                           throws MediaCryptoException

  Deprecated.
  Creates a CryptoConfig that can be passed to a compatible decoder to allow decryption of protected content using the specified session.

  Parameters:

  sessionId - The ID of the session.

  Returns:

  A CryptoConfig for the given session.

  Throws:

  MediaCryptoException - If a CryptoConfig could not be created.

• getCryptoType

  @com.google.android.exoplayer2.C.CryptoType int getCryptoType()

  Deprecated.
  Returns the type of CryptoConfig instances returned by createCryptoConfig(byte[]).