From 60cf4a5b02875d6b5adb3901bf158f8372efbfaa Mon Sep 17 00:00:00 2001
From: jiabin <jiabin@google.com>
Date: Wed, 29 Jun 2022 17:54:39 +0000
Subject: Update doc for audio-coupled-haptic related stuff.

When using audio-coupled-haptic playback, the haptic channels will be
muted if the app doesn't have the vibrate permission. Update the doc to
state that apps should hold vibrate permission to make
audio-coupled-haptic works as expected.

Bug: 236586224
Test: make
Change-Id: I69c1332d39f997a61f3a969d652144d829de9659
---
 media/java/android/media/AudioAttributes.java         | 2 ++
 media/java/android/media/audiofx/HapticGenerator.java | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/media/java/android/media/AudioAttributes.java b/media/java/android/media/AudioAttributes.java
index b27a00c67d06..c49553580f2e 100644
--- a/media/java/android/media/AudioAttributes.java
+++ b/media/java/android/media/AudioAttributes.java
@@ -1200,6 +1200,8 @@ public final class AudioAttributes implements Parcelable {
         /**
          * Specifying if haptic should be muted or not when playing audio-haptic coupled data.
          * By default, haptic channels are disabled.
+         * <p>This will be ignored if the caller doesn't have the
+         * {@link android.Manifest.permission#VIBRATE} permission.
          * @param muted true to force muting haptic channels.
          * @return the same Builder instance.
          */
diff --git a/media/java/android/media/audiofx/HapticGenerator.java b/media/java/android/media/audiofx/HapticGenerator.java
index fe7f29e1fc00..d2523ef43b9e 100644
--- a/media/java/android/media/audiofx/HapticGenerator.java
+++ b/media/java/android/media/audiofx/HapticGenerator.java
@@ -91,7 +91,8 @@ public class HapticGenerator extends AudioEffect implements AutoCloseable {
     }
 
     /**
-     * Enable or disable the effect.
+     * Enable or disable the effect. The effect can only be enabled if the caller has the
+     * {@link android.Manifest.permission#VIBRATE} permission.
      *
      * @param enabled the requested enable state
      * @return {@link #SUCCESS} in case of success, {@link #ERROR_INVALID_OPERATION}
-- 
cgit v1.2.3-59-g8ed1b