From c02bc05977b7aca7e8be6046cdb18611fe187286 Mon Sep 17 00:00:00 2001 From: Steven Moreland Date: Fri, 8 Nov 2019 11:45:32 -0800 Subject: [PATCH] vibrator: clarify behavior for repeated commands Bug: 141828236 Test: VtsHalVibratorTargetTest Change-Id: I4077ca34cb037198df16149f944beba3c5633175 --- vibrator/aidl/android/hardware/vibrator/IVibrator.aidl | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/vibrator/aidl/android/hardware/vibrator/IVibrator.aidl b/vibrator/aidl/android/hardware/vibrator/IVibrator.aidl index ceaa0a0ff1..8c4fd055c3 100644 --- a/vibrator/aidl/android/hardware/vibrator/IVibrator.aidl +++ b/vibrator/aidl/android/hardware/vibrator/IVibrator.aidl @@ -51,7 +51,8 @@ interface IVibrator { /** * Turn off vibrator * - * Cancel a previously-started vibration, if any. + * Cancel a previously-started vibration, if any. If a previously-started vibration is + * associated with a callback, then onComplete should still be called on that callback. */ void off(); @@ -62,6 +63,9 @@ interface IVibrator { * was canceled (through off()). A callback is only expected to be supported when * getCapabilities CAP_ON_CALLBACK is specified. * + * Doing this operation while the vibrator is already on is undefined behavior. Clients should + * explicitly call off. + * * @param timeoutMs number of milliseconds to vibrate. * @param callback A callback used to inform Frameworks of state change, if supported. */ @@ -73,6 +77,9 @@ interface IVibrator { * A callback is only expected to be supported when getCapabilities CAP_PERFORM_CALLBACK * is specified. * + * Doing this operation while the vibrator is already on is undefined behavior. Clients should + * explicitly call off. + * * @param effect The type of haptic event to trigger. * @param strength The intensity of haptic event to trigger. * @param callback A callback used to inform Frameworks of state change, if supported.