Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2bc391f5 authored by Jeff Tinker's avatar Jeff Tinker
Browse files

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
parent 7458ea38

media/java/android/media/MediaDrm.java

+5 −1
Original line number Diff line number Diff line
@@ -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