Vibration API

Table of Contents

• 1. Introduction
• 2. Conformance
• 3. Vibration Interface Terminology
• 3.1 4. Methods Vibration Interface
• 4. 5. Examples
• A. Acknowledgements
• B. References
  • B.1 Normative references
  B.2 Informative references

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 , must not MUST NOT , required REQUIRED , should SHOULD , should not SHOULD NOT , recommended RECOMMENDED , may MAY , and optional 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.

3. Vibration Interface Terminology

The concepts browsing context ; and All instances of spin the Navigator event loop type are defined to also implement the Vibration in [ HTML5 interface. { }; ].

3.1 4. Methods vibrate Parameter Type Nullable Optional Description time unsigned long ✘ ✘ Vibration time in milliseconds. Return type: void vibrate Parameter Type Nullable Optional Description pattern unsigned long [] ✘ ✘ A vibration pattern represented by a list of time entries. Odd entries represent vibration time in milliseconds, even entries still periods in milliseconds between the vibrations. Return type: void Interface

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

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

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

1. If the hidden attribute [ PAGE-VISIBILITY ] is set to true, abort these steps. Let pattern be the value of the first argument.
2. If pattern is 0, or an empty list, cancel the pre-existing instance of the processing vibration patterns algorithm, if any, and abort these steps. 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. Let Set pattern be to list .
3. If any entry of pattern exceeds an implementation-dependent limit, then the user agent may throw a NotSupportedError exception [ DOM4 ] return false and abort terminate these steps.
4. If the length of pattern is even, even and is not zero, then remove the last entry in pattern .
5. If the length of pattern exceeds an implementation dependent implementation-dependent limit, then return false and terminate these steps.
6. If the user agent may throw a NotSupportedError hidden exception attribute [ DOM4 PAGE-VISIBILITY ] is set to true, then return false and abort terminate these steps. Cancel
   Note

   A trusted (also known as privileged) application that integrates closely with the pre-existing instance of operating system's functionality may vibrate the processing vibration patterns algorithm, device even if any. such an application is not visible at all, and thus may ignore the previous step.
7. An implementation may MAY abort the algorithm at this point. 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.
8. Cancel the pre-existing instance of the processing vibration patterns algorithm, if any.
9. 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.
10. Return true, and then continue running these steps asynchronously.
11. For each time in pattern , run the following substeps:
    1. If the index of time is even (the earliest even first entry has index 0), vibrate the device for time milliseconds.
    2. Otherwise pause [ HTML5 ] wait for time milliseconds.

When the visibilitychange event [ PAGE-VISIBILITY ] is dispatched at the Document , the user agent must run the following steps: If the hidden attribute [ PAGE-VISIBILITY ] is set to true, the user agent must suppress the vibration produced by running the pre-existing instance of the processing vibration patterns algorithm, if any. If the hidden attribute [ PAGE-VISIBILITY ] is set to false, in a browsing context , the user agent must MUST restore the vibration produced by running cancel the pre-existing instance of the processing vibration patterns algorithm, if any. If the device does not provide a vibration mechanism, or it is disabled, the user agent must silently ignore any invocations of the vibrate() method.