diff options
author | Jean-Michel Trivi <jmtrivi@google.com> | 2015-02-03 10:15:08 -0800 |
---|---|---|
committer | Jean-Michel Trivi <jmtrivi@google.com> | 2015-02-03 10:15:08 -0800 |
commit | 3d22bf04e399123e07ae9c2075784b63c8678d04 (patch) | |
tree | ed432addc84c193c6165523d2672c8b7ba3f467f | |
parent | ea54c0f97ca73a2bbe05cc3e49099a04236eeac6 (diff) | |
download | frameworks_base-3d22bf04e399123e07ae9c2075784b63c8678d04.zip frameworks_base-3d22bf04e399123e07ae9c2075784b63c8678d04.tar.gz frameworks_base-3d22bf04e399123e07ae9c2075784b63c8678d04.tar.bz2 |
AudioAttributes javadoc update for conversion to stream types
Change-Id: I2b687d8a002897fff90a8c99d180aa0a3511a571
-rw-r--r-- | media/java/android/media/AudioAttributes.java | 8 |
1 files changed, 7 insertions, 1 deletions
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) { |