Merge "vibrator: Document the source of always-on source IDs."

This commit is contained in:
Treehugger Robot 2020-03-04 23:45:19 +00:00 committed by Gerrit Code Review
commit 714163e46d

View file

@ -202,6 +202,12 @@ interface IVibrator {
* once enabled and assigned an effect to play. This may not be supported * once enabled and assigned an effect to play. This may not be supported
* and this support is reflected in getCapabilities (CAP_ALWAYS_ON_CONTROL). * and this support is reflected in getCapabilities (CAP_ALWAYS_ON_CONTROL).
* *
* The always-on source ID is conveyed directly to clients through
* device/board configuration files ensuring that no ID is assigned to
* multiple clients. No client should use this API unless explicitly
* assigned an always-on source ID. Clients must develop their own way to
* get IDs from vendor in a stable way.
*
* @param id The device-specific always-on source ID to enable. * @param id The device-specific always-on source ID to enable.
* @param effect The type of haptic event to trigger. * @param effect The type of haptic event to trigger.
* @param strength The intensity of haptic event to trigger. * @param strength The intensity of haptic event to trigger.
@ -212,6 +218,12 @@ interface IVibrator {
* Disable an always-on haptic source. This may not be supported and this * Disable an always-on haptic source. This may not be supported and this
* support is reflected in getCapabilities (CAP_ALWAYS_ON_CONTROL). * support is reflected in getCapabilities (CAP_ALWAYS_ON_CONTROL).
* *
* The always-on source ID is conveyed directly to clients through
* device/board configuration files ensuring that no ID is assigned to
* multiple clients. No client should use this API unless explicitly
* assigned an always-on source ID. Clients must develop their own way to
* get IDs from vendor in a stable way.
*
* @param id The device-specific always-on source ID to disable. * @param id The device-specific always-on source ID to disable.
*/ */
void alwaysOnDisable(in int id); void alwaysOnDisable(in int id);