Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 7033e87d authored by Harpreet \"Eli\" Sangha's avatar Harpreet \"Eli\" Sangha
Browse files

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



Bug: 148617686
Test: N/A: Documentation change.
Change-Id: I471d394e0c0258fbdaaea27a50ed21c4c10123a7
Signed-off-by: default avatarHarpreet \"Eli\" Sangha <eliptus@google.com>
parent 1eb640d4

vibrator/aidl/android/hardware/vibrator/IVibrator.aidl

+12 −0
Original line number Diff line number Diff line
@@ -202,6 +202,12 @@ interface IVibrator { 
     * once enabled and assigned an effect to play. This may not be supported

     * 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 effect The type 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

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

     */

    void alwaysOnDisable(in int id);