From 8f658f1b37cbb0e7973367e7f4248f836beba5c2 Mon Sep 17 00:00:00 2001 From: Santiago Seifert Date: Fri, 31 Mar 2023 17:39:23 +0000 Subject: [PATCH] Document the expected value of volume control id parameter Bug: 260061722 Test: N/A. Javadoc only change. Change-Id: Iad2bad1b583141ca46c27619b1460944520ab5d0 --- media/java/android/media/session/MediaController.java | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/media/java/android/media/session/MediaController.java b/media/java/android/media/session/MediaController.java index 37050df160e3c..62c4a51673165 100644 --- a/media/java/android/media/session/MediaController.java +++ b/media/java/android/media/session/MediaController.java @@ -29,6 +29,7 @@ import android.media.AudioAttributes; import android.media.AudioManager; import android.media.MediaMetadata; import android.media.Rating; +import android.media.RoutingSessionInfo; import android.media.VolumeProvider; import android.media.VolumeProvider.ControlType; import android.media.session.MediaSession.QueueItem; @@ -1001,8 +1002,11 @@ public final class MediaController { * @param maxVolume The max volume. Should be equal or greater than zero. * @param currentVolume The current volume. Should be in the interval [0, maxVolume]. * @param audioAttrs The audio attributes for this playback. Should not be null. - * @param volumeControlId The volume control ID. This is used for matching - * {@link RoutingSessionInfo} and {@link MediaSession}. + * @param volumeControlId The {@link RoutingSessionInfo#getId() routing session id} of the + * {@link RoutingSessionInfo} associated with this controller, or null if not + * applicable. This id allows mapping this controller to a routing session which, when + * applicable, provides information about the remote device, and support for volume + * adjustment. * @hide */ @SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)