Merge "vibrator: clarify behavior for repeated commands"

This commit is contained in:
Steven Moreland
2019-11-11 06:58:07 +00:00
committed by Gerrit Code Review

View File

@@ -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.