to top
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(String) 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.
abstract void vibrate(long[] pattern, int repeat)
Vibrate with a given pattern.
abstract void vibrate(long milliseconds)
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
  • True if the hardware has a vibrator, else false.

public abstract 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 an array of longs of times for which to turn the vibrator on or off.
repeat the index into pattern at which to repeat, or -1 if you don't want to repeat.

public abstract 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 The number of milliseconds to vibrate.