From 3d22bf04e399123e07ae9c2075784b63c8678d04 Mon Sep 17 00:00:00 2001 From: Jean-Michel Trivi Date: Tue, 3 Feb 2015 10:15:08 -0800 Subject: AudioAttributes javadoc update for conversion to stream types Change-Id: I2b687d8a002897fff90a8c99d180aa0a3511a571 --- media/java/android/media/AudioAttributes.java | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'media') diff --git a/media/java/android/media/AudioAttributes.java b/media/java/android/media/AudioAttributes.java index 489f552..ca242e4 100644 --- a/media/java/android/media/AudioAttributes.java +++ b/media/java/android/media/AudioAttributes.java @@ -709,7 +709,13 @@ public final class AudioAttributes implements Parcelable { } } - /** @hide */ + /** + * @hide + * Only use to get which stream type should be used for volume control, NOT for audio playback + * (all audio playback APIs are supposed to take AudioAttributes as input parameters) + * @param aa non-null AudioAttributes. + * @return a valid stream type for volume control that matches the attributes. + */ public static int toLegacyStreamType(AudioAttributes aa) { // flags to stream type mapping if ((aa.getFlags() & FLAG_AUDIBILITY_ENFORCED) == FLAG_AUDIBILITY_ENFORCED) { -- cgit v1.1