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

Commit 64104095 authored by Ahmad Khalil's avatar Ahmad Khalil
Browse files

Updating comments for PWLE v2 APIs 

Updating some of the comments for the PWLE v2 APIs to clarify what PWLE effects are.

Bug: 347034419
Flag: EXEMPT HAL interface change
Test: N/A
Change-Id: Iac13d27da3f4c2cd5a5ed37ca9e2303f9c4c9802
parent 62053116

vibrator/aidl/android/hardware/vibrator/CompositePwleV2.aidl

+5 −1
Original line number Diff line number Diff line
@@ -21,7 +21,11 @@ import android.hardware.vibrator.PwleV2Primitive; 
@VintfStability

parcelable CompositePwleV2 {

    /**

     * An array of primitives that represents the PWLE effect

     * Represents a PWLE (Piecewise-Linear Envelope) effect as an array of primitives.

     *

     * A PWLE effect defines a vibration waveform using amplitude and frequency points.

     * The envelope linearly interpolates both amplitude and frequency between consecutive points,

     * creating smooth transitions in the vibration pattern.

     */

    PwleV2Primitive[] pwlePrimitives;

}

vibrator/aidl/android/hardware/vibrator/FrequencyAccelerationMapEntry.aidl

+1 −1
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ parcelable FrequencyAccelerationMapEntry { 
     *

     * This value represents the maximum safe output acceleration (in Gs) achievable at the

     * specified frequency, typically determined during calibration. The actual output acceleration

     * is assumed to scale linearly with the input amplitude within the range of [0, 1].

     * should scale linearly based on the 'amplitude' input value.

     */

    float maxOutputAccelerationGs;

}

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

+5 −1
Original line number Diff line number Diff line
@@ -472,7 +472,11 @@ interface IVibrator { 
    int getPwleV2PrimitiveDurationMinMillis();



    /**

     * Play composed sequence of chirps with optional callback upon completion.

     * Play composed sequence of PWLEs with optional callback upon completion.

     *

     * A PWLE (Piecewise-Linear Envelope) effect defines a vibration waveform using amplitude and

     * frequency points. The envelope linearly interpolates both amplitude and frequency between

     * consecutive points, creating smooth transitions in the vibration pattern.

     *

     * This may not be supported and this support is reflected in

     * getCapabilities (CAP_COMPOSE_PWLE_EFFECTS_V2).