public 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 with will stop.

Summary

Public Methods
void cancel()
Turn the vibrator off.
boolean hasVibrator()
Check whether the hardware has a vibrator.
void vibrate(long[] pattern, int repeat)
Vibrate with a given pattern.
void vibrate(long milliseconds)
Turn the vibrator on.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public void cancel ()

Since: API Level 1

Turn the vibrator off.

public boolean hasVibrator ()

Since: API Level 11

Check whether the hardware has a vibrator. Returns true if a vibrator exists, else false.

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

Since: 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.

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 void vibrate (long milliseconds)

Since: API Level 1

Turn the vibrator on.

Parameters
milliseconds The number of milliseconds to vibrate.