W3cubDocs

/Web APIs

Gyroscope

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. In addition, this feature may be blocked by a Permissions Policy set on your server.

EventTarget Sensor Gyroscope

Constructor

Gyroscope()

Creates a new Gyroscope object.

Instance properties

Gyroscope.x Read only

Returns a double, containing the angular velocity of the device along the device's x axis.

Gyroscope.y Read only

Returns a double, containing the angular velocity of the device along the device's y axis.

Gyroscope.z Read only

Returns a double, containing the angular velocity of the device along the device's z axis.

Instance methods

Gyroscope doesn't have own methods. However, it inherits methods from its parent interfaces, Sensor and EventTarget.

Events

Gyroscope doesn't have own events. However, it inherits events from its parent interface, Sensor.

Example

The gyroscope is typically read in the reading event callback. In the example below this occurs sixty times a second.

js

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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
Gyroscope 67 79 No No 54 No 67 67 No 48 No 9.0
Gyroscope 67 79 No No 54 No 67 67 No 48 No 9.0
x 67 79 No No 54 No 67 67 No 48 No 9.0
y 67 79 No No 54 No 67 67 No 48 No 9.0
z 67 79 No No 54 No 67 67 No 48 No 9.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Gyroscope