Vibrator
public
abstract
class
Vibrator
extends Object
| java.lang.Object | |
| ↳ | android.os.Vibrator |
Class that operates the vibrator on the device.
If your process exits, any vibration you started will stop.
Summary
Public methods | |
|---|---|
abstract
void
|
cancel()
Turn the vibrator off. |
abstract
boolean
|
hasAmplitudeControl()
Check whether the vibrator has amplitude control. |
abstract
boolean
|
hasVibrator()
Check whether the hardware has a vibrator. |
void
|
vibrate(long milliseconds)
This method was deprecated
in API level 26.
Use |
void
|
vibrate(VibrationEffect vibe)
Requires |
void
|
vibrate(long[] pattern, int repeat)
This method was deprecated
in API level 26.
Use |
void
|
vibrate(long[] pattern, int repeat, AudioAttributes attributes)
This method was deprecated
in API level 26.
Use |
void
|
vibrate(VibrationEffect vibe, AudioAttributes attributes)
Requires |
void
|
vibrate(long milliseconds, AudioAttributes attributes)
This method was deprecated
in API level 26.
Use |
Inherited methods | |
|---|---|
Public methods
cancel
public abstract void cancel ()
Turn the vibrator off.
Requires Manifest.permission.VIBRATE
hasAmplitudeControl
public abstract boolean hasAmplitudeControl ()
Check whether the vibrator has amplitude control.
| Returns | |
|---|---|
boolean |
True if the hardware can control the amplitude of the vibrations, otherwise false. |
hasVibrator
public abstract boolean hasVibrator ()
Check whether the hardware has a vibrator.
| Returns | |
|---|---|
boolean |
True if the hardware has a vibrator, else false. |
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.
Requires Manifest.permission.VIBRATE
| Parameters | |
|---|---|
milliseconds |
long: The number of milliseconds to vibrate. |
vibrate
public void vibrate (VibrationEffect vibe)
Requires Manifest.permission.VIBRATE
| Parameters | |
|---|---|
vibe |
VibrationEffect |
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.
Requires
Manifest.permission.VIBRATE
| Parameters | |
|---|---|
pattern |
long: an array of longs of times for which to turn the vibrator on or off. |
repeat |
int: the index into pattern at which to repeat, or -1 if
you don't want to repeat. |
vibrate
public void vibrate (long[] pattern,
int repeat,
AudioAttributes attributes)
This method was deprecated
in API level 26.
Use vibrate(android.os.VibrationEffect, android.media.AudioAttributes) 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.
Requires
Manifest.permission.VIBRATE
| Parameters | |
|---|---|
pattern |
long: an array of longs of times for which to turn the vibrator on or off. |
repeat |
int: the index into pattern at which to repeat, or -1 if
you don't want to repeat. |
attributes |
AudioAttributes: AudioAttributes corresponding to the vibration. For example,
specify AudioAttributes#USAGE_ALARM for alarm vibrations or
AudioAttributes#USAGE_NOTIFICATION_RINGTONE for
vibrations associated with incoming calls. |
vibrate
public void vibrate (VibrationEffect vibe, AudioAttributes attributes)
Requires Manifest.permission.VIBRATE
| Parameters | |
|---|---|
vibe |
VibrationEffect |
attributes |
AudioAttributes |
vibrate
public void vibrate (long milliseconds,
AudioAttributes attributes)
This method was deprecated
in API level 26.
Use vibrate(android.os.VibrationEffect, android.media.AudioAttributes) instead.
Vibrate constantly for the specified period of time.
Requires Manifest.permission.VIBRATE
| Parameters | |
|---|---|
milliseconds |
long: The number of milliseconds to vibrate. |
attributes |
AudioAttributes: AudioAttributes corresponding to the vibration. For example,
specify AudioAttributes#USAGE_ALARM for alarm vibrations or
AudioAttributes#USAGE_NOTIFICATION_RINGTONE for
vibrations associated with incoming calls. |