Android APIs
public abstract class

Vibrator

extends Object
java.lang.Object
   ↳ android.os.Vibrator

Class Overview

Class that operates the vibrator on the device.

If your process exits, any vibration you started will stop.

To obtain an instance of the system vibrator, call getSystemService(Class) with VIBRATOR_SERVICE as the argument.

Summary

Public Methods
abstract void cancel()
Turn the vibrator off.
abstract boolean hasVibrator()
Check whether the hardware has a vibrator.
void vibrate(long[] pattern, int repeat, AudioAttributes attributes)
Vibrate with a given pattern.
void vibrate(long[] pattern, int repeat)
Vibrate with a given pattern.
void vibrate(long milliseconds)
Vibrate constantly for the specified period of time.
void vibrate(long milliseconds, AudioAttributes attributes)
Vibrate constantly for the specified period of time.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public abstract void cancel ()

Added in API level 1

Turn the vibrator off.

This method requires the caller to hold the permission VIBRATE.

public abstract boolean hasVibrator ()

Added in API level 11

Check whether the hardware has a vibrator.

Returns
boolean True if the hardware has a vibrator, else false.

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

Added in API level 21

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.

This method requires the caller to hold the 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 USAGE_ALARM for alarm vibrations or USAGE_NOTIFICATION_RINGTONE for vibrations associated with incoming calls.

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

Added in API level 1

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.

This method requires the caller to hold the 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.

public void vibrate (long milliseconds)

Added in API level 1

Vibrate constantly for the specified period of time.

This method requires the caller to hold the permission VIBRATE.

Parameters
milliseconds long: The number of milliseconds to vibrate.

public void vibrate (long milliseconds, AudioAttributes attributes)

Added in API level 21

Vibrate constantly for the specified period of time.

This method requires the caller to hold the permission VIBRATE.

Parameters
milliseconds long: The number of milliseconds to vibrate.
attributes AudioAttributes: AudioAttributes corresponding to the vibration. For example, specify USAGE_ALARM for alarm vibrations or USAGE_NOTIFICATION_RINGTONE for vibrations associated with incoming calls.