summaryrefslogtreecommitdiffstats
path: root/media
diff options
context:
space:
mode:
authorJeff Tinker <jtinker@google.com>2013-05-07 14:51:17 -0700
committerJeff Tinker <jtinker@google.com>2013-05-07 15:01:07 -0700
commitea824eddbcaf24cde1c2388ff73e7c5c5e4afb26 (patch)
tree02aa560c3758a36b0d74fbf9d90d2865191fc20b /media
parent84ce55cfd50bdfc7054de5ee9f69de7cf08b61ae (diff)
downloadframeworks_base-ea824eddbcaf24cde1c2388ff73e7c5c5e4afb26.zip
frameworks_base-ea824eddbcaf24cde1c2388ff73e7c5c5e4afb26.tar.gz
frameworks_base-ea824eddbcaf24cde1c2388ff73e7c5c5e4afb26.tar.bz2
Correct java API docs for MediaDrm offline use case
Documentation only change, no APIs are affected Change-Id: I4f3978751928de503f51afa77e0983d4c385ff7b related-to-bug: 8621588
Diffstat (limited to 'media')
-rw-r--r--media/java/android/media/MediaDrm.java15
1 files changed, 10 insertions, 5 deletions
diff --git a/media/java/android/media/MediaDrm.java b/media/java/android/media/MediaDrm.java
index be2d9bc..7677d8a1 100644
--- a/media/java/android/media/MediaDrm.java
+++ b/media/java/android/media/MediaDrm.java
@@ -363,11 +363,16 @@ public final class MediaDrm {
/**
* A key response is received from the license server by the app, then it is
- * provided to the DRM engine plugin using provideKeyResponse. The byte array
- * returned is a keySetId that can be used to later restore the keys to a new
- * session with the method {@link #restoreKeys}, enabling offline key use.
+ * provided to the DRM engine plugin using provideKeyResponse. When the
+ * 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.
*
- * @param sessionId the session ID for the DRM session
+ * @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
*
* @throws NotProvisionedException if the response indicates that
@@ -375,7 +380,7 @@ public final class MediaDrm {
* @throws DeniedByServerException if the response indicates that the
* server rejected the request
*/
- public native byte[] provideKeyResponse(byte[] sessionId, byte[] response)
+ public native byte[] provideKeyResponse(byte[] scope, byte[] response)
throws NotProvisionedException, DeniedByServerException;