Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Update Vibrator documentation for support check methods." am: 669bfab549

Browse Source 
Original change: https://android-review.googlesource.com/c/platform/frameworks/base/+/2256077

Change-Id: Iaa8c45c265848faab5b1e12ad3b951746b06af0b
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
This commit is contained in:
Lais Andrade
2022-10-17 14:37:44 +00:00
committed by Automerger Merge Worker
parent 77567b04d8 669bfab549
commit aef7473d30
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
core/java/android/os/Vibrator.java
View File

@@ -527,7 +527,8 @@ public abstract class Vibrator {
}
/**
* Query whether the vibrator supports all the given effects.
* Query whether the vibrator supports all the given effects. If no argument is provided this
* method will always return {@link #VIBRATION_EFFECT_SUPPORT_YES}.
*
* <p>If an effect is not supported, the system may still automatically fall back to a simpler
* vibration instead, which is not optimised for the specific device, however vibration isn't
@@ -549,7 +550,8 @@ public abstract class Vibrator {
* <p>Use {@link #areEffectsSupported(int...)} to get individual results for each effect.
*
* @param effectIds Which effects to query for.
* @return Whether all the effects are natively supported by the device.
* @return Whether all specified effects are natively supported by the device. Empty query
* defaults to {@link #VIBRATION_EFFECT_SUPPORT_YES}.
*/
@VibrationEffectSupport
public final int areAllEffectsSupported(
@@ -598,7 +600,8 @@ public abstract class Vibrator {
}
/**
* Query whether the vibrator supports all of the given primitives.
* Query whether the vibrator supports all of the given primitives. If no argument is provided
* this method will always return {@code true}.
*
* <p>If a primitive is not supported by the device, then <em>no vibration</em> will occur if
* it is played.
@@ -606,7 +609,7 @@ public abstract class Vibrator {
* <p>Use {@link #arePrimitivesSupported(int...)} to get individual results for each primitive.
*
* @param primitiveIds Which primitives to query for.
* @return Whether all specified primitives are supported.
* @return Whether all specified primitives are supported. Empty query defaults to {@code true}.
*/
public final boolean areAllPrimitivesSupported(
@NonNull @VibrationEffect.Composition.PrimitiveType int... primitiveIds) {