Vibration API

Abstract

This specification defines an API that provides access to the vibration mechanism of the hosting device. Vibration is a form of tactile feedback.

Status of This Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.

The changes made since the 08 May 2012 W3C Candidate Recommendation (diff):

IDL: change the vibrate() method's return type from void to boolean, use sequence type for the pattern attribute, make the interface partial
processing vibration patterns algorithm: do not throw exceptions, minor clarifications to the algorithm

This document represents the consensus of the group on the scope and features of the Vibration API. It should be noted that the group is aware of more advanced use cases that cannot be realized using this simpler first version. The intent is to address them in a future revision.

This document was published by the Device APIs Working Group as a Last Call Working Draft. This document is intended to become a W3C Recommendation. If you wish to make comments regarding this document, please send them to public-device-apis@w3.org (subscribe, archives). The Last Call period ends 13 June 2013. All comments are welcome.

Publication as a Last Call Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This is a Last Call Working Draft and thus the Working Group has determined that this document has satisfied the relevant technical requirements and is sufficiently stable to advance through the Technical Recommendation process.

This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

2. Conformance

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this specification are to be interpreted as described in [RFC2119].

This specification defines conformance criteria that apply to a single product: the user agent that implements the interfaces that it contains.

Implementations that use ECMAScript to implement the APIs defined in this specification must implement them in a manner consistent with the ECMAScript Bindings defined in the Web IDL specification [WEBIDL], as this specification uses that specification and terminology.

4. Vibration Interface

partial interface Navigator {
    boolean vibrate ((unsigned long or sequence<unsigned long>) pattern);
};

The vibrate() method, when invoked, MUST run the algorithm for processing vibration patterns.

The rules for processing vibration patterns are as given in the following algorithm:

Let pattern be the value of the first argument.
If pattern is a list, proceed to the next step. Otherwise run the following substeps:
1. Let list be an initially empty list, and add pattern to list.
2. Set pattern to list.
If any entry of pattern exceeds an implementation-dependent limit, then return false and terminate these steps.
If the length of pattern is even and is not zero, then remove the last entry in pattern.
If the length of pattern exceeds an implementation-dependent limit, then return false and terminate these steps.
If the hidden attribute [PAGE-VISIBILITY] is set to true, then return false and terminate these steps.
Note
A trusted (also known as privileged) application that integrates closely with the operating system's functionality may vibrate the device even if such an application is not visible at all, and thus may ignore the previous step.
An implementation MAY return false and terminate these steps.
Note
For example, an implementation might abort the algorithm because the user has set a preference indicating that pages at a given origin should never be able to vibrate the device, or an implementation might cap the total amount of time a page may cause the device to vibrate and reject requests in excess of this limit.
Cancel the pre-existing instance of the processing vibration patterns algorithm, if any.
If pattern is an empty list, or if the device does not provide a vibration mechanism (or it is disabled), then return true and terminate these steps.
Return true, and then continue running these steps asynchronously.
For each time in pattern, run the following substeps:
1. If the index of time is even (the first entry has index 0), vibrate the device for time milliseconds.
2. Otherwise wait for time milliseconds.

When the visibilitychange event [PAGE-VISIBILITY] is dispatched at the Document in a browsing context, the user agent MUST cancel the pre-existing instance of the processing vibration patterns algorithm, if any.

5. Examples

This section is non-normative.

In the following example the device will vibrate for 1000 milliseconds (ms):

Example 1

// vibrate for 1000 ms
navigator.vibrate(1000);

// or alternatively
navigator.vibrate([1000]);

In the following example the pattern will cause the device to vibrate for 50 ms, be still for 100 ms, and then vibrate for 150 ms:

Example 2

navigator.vibrate([50, 100, 150]);

The following example cancels any existing vibrations:

Example 3

// cancel any existing vibrations
navigator.vibrate(0);

// or alternatively
navigator.vibrate([]);

Vibration API

W3C Last Call Working Draft 23 May 2013

Abstract

Status of This Document

Table of Contents

1. Introduction

2. Conformance

3. Terminology

4. Vibration Interface

5. Examples

A. Acknowledgements

B. References

B.1 Normative references