From 3f296bdcfa8a52473b1bdbafcee4f6a88a9a6ffa Mon Sep 17 00:00:00 2001 From: Kriti Dang Date: Mon, 31 May 2021 15:54:44 +0200 Subject: [PATCH] Adding additional javadocs for setSurroundFormatEnabled Bug: 187178381 Test: N/A Change-Id: Ic59c4d6c85deb57c43624e0f8a3b4cc15f5f9690 --- media/java/android/media/AudioManager.java | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/media/java/android/media/AudioManager.java b/media/java/android/media/AudioManager.java index 14d4937d5572b..b7d5c7b211755 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. + *

+ * 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