Cordova Plugin Vibration

The main task of this plugin is to vibrate the device. This plugin describes the global objects such as navigator.vibrate and aligns with the W3C vibration specification http://www.w3.org/TR/vibration/. If it is in the global scope, this plugin is not available until after the deviceready event.

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(navigator.vibrate);
}

The navigator.vibrate object is supported in various platforms such as Windows, iOS, Android.

Installation:

If you want to add this plugin in your app, you have to install it by typing the below command on command prompt:

vibrate

It is a method that consists of different functionalities based on the passed parameters.

Standard vibrate

If you want to specify the time to vibrate the device, you can easily do it through this particular functionality.

You can use any of the below syntax:

-time: It specifies the time in milliseconds to vibrate the device.

Example:

// It vibrates the device for 5 seconds
navigator.vibrate(5000);
// It vibrates the device for 5 seconds
navigator.vibrate([5000]);

iOS quirks:

time: In the iOS platform, it vibrates for the pre-set amount of time and ignores the specified time by the user.

Example:

navigator.vibrate(5000);  // the time specified by the user i.e. 5000 is being ignored.

Windows Quirks:

time: It refers to the maximum time i.e., 5s and minimum time i.e.,

Example:

navigator.vibrate(10000);  // the time specified by the user i.e. 10000 will be truncated to 5000.

Vibrate with the pattern (For Android and Windows platform only):

It is only supported by the Android and Windows platforms. If you want to specify a pattern for vibrating the device, you can use it.

Parameter:

pattern: This parameter consists of an array of the numbers. It is specified by the user that consists of the sequence of duration represented in milliseconds. This sequence of duration can be used to turn on or turn off the vibration.

Example:

// Vibrate for 7 second
// Pause for 2 second
// Vibrate for 4 seconds
// Pause for 5 second
// Vibrate for 6 seconds
navigator.vibrate([7000, 2000, 4000, 5000, 6000]);

Cancel vibration (not supported in iOS platform):

It is used to immediately cancel the vibration that is currently running on the device.

The first syntax defines that we can pass the parameter 0 to cancel any vibration.

The second syntax defines that we can pass an empty array to cancel any vibration.

The third syntax defines that we can pass an empty array with the first element value 0 to cancel any vibration.

*notification.vibrate (deprecated)

If you want to specify the time to vibrate the device, you can easily do it by using the notification.vibrate.

Parameter:

time: It specifies the time in milliseconds to vibrate the device.

Example:

// It vibrates the device for 7.5 seconds
navigator.notification.vibrate(7500);

iOS quirks:

time: In the iOS platform, it vibrates for the pre-set amount of time and ignores the specified time by the user.

Example:

navigator.notification.vibrate(); 
navigator.notification.vibrate(7500);   // the time specified by the user i.e. 7500 is being ignored.

*notification.vibrateWithPattern (deprecated)

If you want to specify a pattern for vibrating the device, you can use the notification.vibrateWithPattern.

Parameter:

pattern: This parameter consists of an array of the numbers. It is specified by the user that consists of the sequence of duration represented in milliseconds. This sequence of duration can be used to turn on or turn off the vibration.
repeat: It consists of a number that defines the optional index into the pattern array at which it starts the repeating. It will repeat until it is canceled. The value -1 is for denoting the no repetition (default).

Example:

// Immediately start vibrating the device
// Vibrate for 200ms,
// Pause for 300ms,
// Vibrate for 400ms,
// Pause for 700ms,
// Vibrate for 900ms,
// Pause for 1100ms,
// do not repeat 
navigator.notification.vibrateWithPattern([0, 200, 300, 400, 700, 900, 1100]);

*notification.cancelVibration (deprecated)

It is used to immediately cancel the vibration that is currently running on the device.

Code:

HTML:

<b>Study Tutorials from<a href="https://javatpoint.com/#feat=vibration">Javatpoint</a></b>
<br>
<button onclick="python()">python</button>
<button onclick="android()">android</button>
<button onclick="java()">java</button>

CSS:

button {
  margin: 40px 0;
}

JavaScript:

function python() {  navigator.vibrate([145,55,145,375,150,265,185,55,145,265,300,500,300,500])
}
function android() { navigator.vibrate([600,240,400,210,300,180,175,120,150,30,500,310,400,150,120,50,200])
}
function java() {
  navigator.vibrate([160,140,120,160,45,75,180,170,180,180,350])
}

Output: