Vibrator

VIBRATION_EFFECT_SUPPORT_NO

public static final int VIBRATION_EFFECT_SUPPORT_NO

Vibration effect support: unsupported

This effect is not natively supported by the underlying hardware, although the system may still play a fallback vibration.

Constant Value: 2 (0x00000002)

VIBRATION_EFFECT_SUPPORT_UNKNOWN

public static final int VIBRATION_EFFECT_SUPPORT_UNKNOWN

Vibration effect support: unknown

The hardware doesn't report its supported effects, so we can't determine whether the effect is supported or not.

Constant Value: 0 (0x00000000)

VIBRATION_EFFECT_SUPPORT_YES

public static final int VIBRATION_EFFECT_SUPPORT_YES

Vibration effect support: supported

This effect is supported by the underlying hardware.

Constant Value: 1 (0x00000001)

areAllEffectsSupported

public final int areAllEffectsSupported (int... effectIds)

Query whether the vibrator supports all the given effects. If no argument is provided this method will always return VIBRATION_EFFECT_SUPPORT_YES.

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 guaranteed in this case.

If the result is VIBRATION_EFFECT_SUPPORT_YES, all effects in the query are supported by the hardware.

If the result is VIBRATION_EFFECT_SUPPORT_NO, at least one of the effects in the query is not supported, and using them may fall back to an un-optimized vibration or no vibration.

If the result is VIBRATION_EFFECT_SUPPORT_UNKNOWN, the system doesn't know whether all the effects are supported. It may support any or all of the queried effects, but there's no way to programmatically know whether a vibrate(VibrationEffect) call will successfully cause a vibration. It's guaranteed, however, that none of the queried effects are definitively unsupported by the hardware.

Use areEffectsSupported(int) to get individual results for each effect.

areAllPrimitivesSupported

public final boolean areAllPrimitivesSupported (int... primitiveIds)

Query whether the vibrator supports all of the given primitives. If no argument is provided this method will always return true.

If a primitive is not supported by the device, then no vibration will occur if it is played.

Use arePrimitivesSupported(int) to get individual results for each primitive.

areEffectsSupported

public int[] areEffectsSupported (int... effectIds)

Query whether the vibrator natively supports the given effects.

If an effect is not supported, the system may still automatically fall back to playing a simpler vibration instead, which is not optimised for the specific device. This includes the unknown case, which can't be determined in advance, that will dynamically attempt to fall back if the optimised effect fails to play.

The returned array will be the same length as the query array and the value at a given index will contain VIBRATION_EFFECT_SUPPORT_YES if the effect at that same index in the querying array is supported, VIBRATION_EFFECT_SUPPORT_NO if it isn't supported, or VIBRATION_EFFECT_SUPPORT_UNKNOWN if the system can't determine whether it's supported or not, as some hardware doesn't report its effect capabilities.

Use areAllEffectsSupported(int) to get a single combined result, or for convenience when querying exactly one effect.

areEnvelopeEffectsSupported

public boolean areEnvelopeEffectsSupported ()

Checks whether the vibrator supports the creation of envelope effects. Envelope effects are defined by a series of frequency-amplitude pairs with specified transition times, allowing the creation of more complex vibration patterns.

arePrimitivesSupported

public boolean[] arePrimitivesSupported (int... primitiveIds)

Query whether the vibrator supports the given primitives. The returned array will be the same length as the query array and the value at a given index will contain whether the effect at that same index in the querying array is supported or not.

If a primitive is not supported by the device, then no vibration will occur if it is played.

Use areAllPrimitivesSupported(int) to get a single combined result, or for convenience when querying exactly one primitive.

cancel

public abstract void cancel ()

Turn the vibrator off.
Requires Manifest.permission.VIBRATE

getEnvelopeEffectInfo

public VibratorEnvelopeEffectInfo getEnvelopeEffectInfo ()

Retrieves the vibrator's capabilities and limitations for envelope effects.

These parameters can be used with VibrationEffect.WaveformEnvelopeBuilder to create custom envelope effects.

getFrequencyProfile

public VibratorFrequencyProfile getFrequencyProfile ()

Gets the profile that describes the vibrator output across the supported frequency range.

The profile describes the output acceleration that the device can reach when it vibrates at different frequencies.

getId

public int getId ()

Return the ID of this vibrator.

getPrimitiveDurations

public int[] getPrimitiveDurations (int... primitiveIds)

Query the estimated durations of the given primitives.

The returned array will be the same length as the query array and the value at a given index will contain the duration in milliseconds of the effect at the same index in the querying array.

The duration will be positive for primitives that are supported and zero for the unsupported ones, in correspondence with arePrimitivesSupported(int).

getQFactor

public float getQFactor ()

Gets the Q factor of the vibrator.

getResonantFrequency

public float getResonantFrequency ()

Gets the resonant frequency of the vibrator, if applicable.

hasAmplitudeControl

public abstract boolean hasAmplitudeControl ()

Check whether the vibrator has amplitude control.

hasVibrator

public abstract boolean hasVibrator ()

Check whether the hardware has a vibrator.

vibrate

public void vibrate (long milliseconds)

This method was deprecated in API level 26.
Use vibrate(android.os.VibrationEffect) instead.

Vibrate constantly for the specified period of time.

The app should be in the foreground for the vibration to happen.

vibrate

public void vibrate (VibrationEffect vibe, 
                VibrationAttributes attributes)

Vibrate with a given effect.

The app should be in the foreground for the vibration to happen. Background apps should specify a ringtone, notification or alarm usage in order to vibrate.

vibrate

public void vibrate (long[] pattern, 
                int repeat)

This method was deprecated in API level 26.
Use vibrate(android.os.VibrationEffect) instead.

Vibrate with a given pattern.

Pass in an array of ints that are the durations for which to turn on or off the vibrator in milliseconds. The first value indicates the number of milliseconds to wait before turning the vibrator on. The next value indicates the number of milliseconds for which to keep the vibrator on before turning it off. Subsequent values alternate between durations in milliseconds to turn the vibrator off or to turn the vibrator on.

To cause the pattern to repeat, pass the index into the pattern array at which to start the repeat, or -1 to disable repeating.

The app should be in the foreground for the vibration to happen.

vibrate

public void vibrate (VibrationEffect vibe, 
                AudioAttributes attributes)

This method was deprecated in API level 33.
Use vibrate(android.os.VibrationEffect, android.os.VibrationAttributes) instead.

Vibrate with a given effect.

The app should be in the foreground for the vibration to happen. Background apps should specify a ringtone, notification or alarm usage in order to vibrate.

vibrate

public void vibrate (long milliseconds, 
                AudioAttributes attributes)

This method was deprecated in API level 26.
Use vibrate(android.os.VibrationEffect, android.os.VibrationAttributes) instead.

Vibrate constantly for the specified period of time.

The app should be in the foreground for the vibration to happen. Background apps should specify a ringtone, notification or alarm usage in order to vibrate.

vibrate

public void vibrate (VibrationEffect vibe)

Vibrate with a given effect.

The app should be in the foreground for the vibration to happen.

vibrate

public void vibrate (long[] pattern, 
                int repeat, 
                AudioAttributes attributes)

This method was deprecated in API level 26.
Use vibrate(android.os.VibrationEffect, android.os.VibrationAttributes) instead.

Vibrate with a given pattern.

Pass in an array of ints that are the durations for which to turn on or off the vibrator in milliseconds. The first value indicates the number of milliseconds to wait before turning the vibrator on. The next value indicates the number of milliseconds for which to keep the vibrator on before turning it off. Subsequent values alternate between durations in milliseconds to turn the vibrator off or to turn the vibrator on.

To cause the pattern to repeat, pass the index into the pattern array at which to start the repeat, or -1 to disable repeating.

The app should be in the foreground for the vibration to happen. Background apps should specify a ringtone, notification or alarm usage in order to vibrate.