Merge "Adding additional javadocs for setSurroundFormatEnabled" into sc-dev

1 files changed, 8 insertions, 1 deletions

diff --git a/media/java/android/media/AudioManager.java b/media/java/android/media/AudioManager.java
index 14d4937d5572..b7d5c7b21175 100644
--- a/media/java/android/media/AudioManager.java
+++ b/media/java/android/media/AudioManager.java
@@ -7067,7 +7067,14 @@ public class AudioManager {
     }
 
     /**
-     * Set a certain surround format as enabled or not.
+     * Sets and persists a certain surround format as enabled or not.
+     * <p>
+     * This API is called by TvSettings surround sound menu when user enables or disables a
+     * surround sound format. This setting is persisted as global user setting.
+     * Applications should revert their changes to surround sound settings unless they intend to
+     * modify the global user settings across all apps. The framework does not auto-revert an
+     * application's settings after a lifecycle event. Audio focus is not required to apply these
+     * settings.
      *
      * @param enabled the required surround format state, true for enabled, false for disabled
      * @return true if successful, otherwise false