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

Commit d5daf351 authored by Kyunglyul Hyun's avatar Kyunglyul Hyun
Browse files

Document more about volume provider ID. 

Document more about what getVolumeControlId returns.

This CL is to address API Review issue.

Bug: 148403124
Test: N/A
Change-Id: I382cbe3efe2fd5732f50493bc6d243ae54c5a257
parent 3c51ff6b

media/java/android/media/VolumeProvider.java

+3 −3
Original line number Diff line number Diff line
@@ -89,7 +89,7 @@ public abstract class VolumeProvider { 
     *            this provider.

     * @param maxVolume The maximum allowed volume.

     * @param currentVolume The current volume on the output.

     * @param volumeControlId The volume control id of this provider.

     * @param volumeControlId The volume control ID of this provider.

     */

    public VolumeProvider(@ControlType int volumeControl, int maxVolume, int currentVolume,

            @Nullable String volumeControlId) {
@@ -142,10 +142,10 @@ public abstract class VolumeProvider { 
    }



    /**

     * Gets the volume control id. It can be used to identify which volume provider is

     * Gets the volume control ID. It can be used to identify which volume provider is

     * used by the session.

     *

     * @return the volume control id or {@code null} if it isn't set.

     * @return the volume control ID or {@code null} if it isn't set.

     */

    @Nullable

    public final String getVolumeControlId() {

media/java/android/media/session/MediaController.java

+8 −1
Original line number Diff line number Diff line
@@ -1056,8 +1056,15 @@ public final class MediaController { 
        /**

         * Gets the volume control ID for this session. It can be used to identify which

         * volume provider is used by the session.

         * <p>

         * When the session starts to use {@link #PLAYBACK_TYPE_REMOTE remote volume handling},

         * a volume provider should be set and it may set the volume control ID of the provider

         * if the session wants to inform which volume provider is used.

         * It can be {@code null} if the session didn't set the volume control ID or it uses

         * {@link #PLAYBACK_TYPE_LOCAL local playback}.

         * </p>

         *

         * @return the volume control ID for this session or {@code null} if it's local playback

         * @return the volume control ID for this session or {@code null} if it uses local playback

         * or not set.

         * @see VolumeProvider#getVolumeControlId()

         */