summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Jeff Tinker <jtinker@google.com> 2017-04-05 07:40:29 -0700
committer Jeff Tinker <jtinker@google.com> 2017-04-05 07:40:29 -0700
commit2bc391f5677033ede895dc2ca74c45f0bb647b19 (patch)
tree0fb96096a3d5f07b756dc24742af8a03c48b0a08
parent7458ea38278da47e6ecc0cd251566cdd10063215 (diff)
Update MediaDrm documentation for provideKeyResponse
The documentation for MediaDrm#getKeyResponse says null is returned from provideKeyResponse for requests of type streaming or release. This corrects the documentation to indicate that an empty byte array is returned. bug: 36093612 Change-Id: I2e4fc658d68d827b8a42fb7fa3ef30e35ee51dcf
-rw-r--r--media/java/android/media/MediaDrm.java6
1 files changed, 5 insertions, 1 deletions
diff --git a/media/java/android/media/MediaDrm.java b/media/java/android/media/MediaDrm.java
index 2723826cc92e..76fe6dd786d1 100644
--- a/media/java/android/media/MediaDrm.java
+++ b/media/java/android/media/MediaDrm.java
@@ -779,13 +779,17 @@ public final class MediaDrm {
* response is for an offline key request, a keySetId is returned that can be
* used to later restore the keys to a new session with the method
* {@link #restoreKeys}.
- * When the response is for a streaming or release request, null is returned.
+ * When the response is for a streaming or release request, an empty byte array
+ * is returned.
*
* @param scope may be a sessionId or keySetId depending on the type of the
* response. Scope should be set to the sessionId when the response is for either
* streaming or offline key requests. Scope should be set to the keySetId when
* the response is for a release request.
* @param response the byte array response from the server
+ * @return If the response is for an offline request, the keySetId for the offline
+ * keys will be returned. If the response is for a streaming or release request
+ * an empty byte array will be returned.
*
* @throws NotProvisionedException if the response indicates that
* reprovisioning is required