The Gyroscope interface of the Sensor APIs provides on each reading the angular velocity of the device along all three axes.
To use this sensor, the user must grant permission to the 'gyroscope' device sensor through the Permissions API.
If a feature policy blocks use of a feature it is because your code is inconsistent with the policies set on your server. This is not something that would ever be shown to a user. See Feature-Policy for implementation instructions.
Constructor
Gyroscope.Gyroscope()- Creates a new
Gyroscopeobject.
Properties
Gyroscope.xRead only- Returns a double, containing the angular velocity of the device along the device's x axis.
Gyroscope.yRead only- Returns a double, containing the angular velocity of the device along the device's y axis.
Gyroscope.zRead only- Returns a double, containing the angular velocity of the device along the device's z axis.
Example
The gyroscope is typically read in the Sensor.onreading event callback. In the example below this occurs sixty times a second.
let gyroscope = new Gyroscope({frequency: 60});
gyroscope.addEventListener('reading', e => {
console.log("Angular velocity along the X-axis " + gyroscope.x);
console.log("Angular velocity along the Y-axis " + gyroscope.y);
console.log("Angular velocity along the Z-axis " + gyroscope.z);
});
gyroscope.start();
Specifications
| Specification | Status | Comment |
|---|---|---|
| Generic Sensor API | Candidate Recommendation | Defines sensors in general. |
| Gyroscope The definition of 'Gyroscope' in that specification. |
Candidate Recommendation | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gyroscope | Chrome Full support 69 | Edge Full support ≤79 | Firefox ? | IE ? | Opera Full support 56 | Safari ? | WebView Android Full support 69 | Chrome Android Full support 69 | Firefox Android ? | Opera Android Full support 48 | Safari iOS ? | Samsung Internet Android Full support 10.0 |
Gyroscope() constructor | Chrome Full support 69 | Edge Full support ≤79 | Firefox ? | IE ? | Opera Full support 56 | Safari ? | WebView Android Full support 69 | Chrome Android Full support 69 | Firefox Android ? | Opera Android Full support 48 | Safari iOS ? | Samsung Internet Android Full support 10.0 |
x | Chrome Full support 69 | Edge Full support ≤79 | Firefox ? | IE ? | Opera Full support 56 | Safari ? | WebView Android Full support 69 | Chrome Android Full support 69 | Firefox Android ? | Opera Android Full support 48 | Safari iOS ? | Samsung Internet Android Full support 10.0 |
y | Chrome Full support 69 | Edge Full support ≤79 | Firefox ? | IE ? | Opera Full support 56 | Safari ? | WebView Android Full support 69 | Chrome Android Full support 69 | Firefox Android ? | Opera Android Full support 48 | Safari iOS ? | Samsung Internet Android Full support 10.0 |
z | Chrome Full support 69 | Edge Full support ≤79 | Firefox ? | IE ? | Opera Full support 56 | Safari ? | WebView Android Full support 69 | Chrome Android Full support 69 | Firefox Android ? | Opera Android Full support 48 | Safari iOS ? | Samsung Internet Android Full support 10.0 |
Legend
- Full support
- Full support
- Compatibility unknown
- Compatibility unknown
