Web/API/AbsoluteOrientationSensor

The AbsoluteOrientationSensor interface of the Sensor APIs describes the device's physical orientation in relation to the Earth's reference coordinate system.

To use this sensor, the user must grant permission to the 'accelerometer', 'gyroscope', and 'magnetometer' device sensors 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

AbsoluteOrientationSensor.AbsoluteOrientationSensor(): Creates a new AbsoluteOrientationSensor object.

Properties

No specific properties; inherits methods from its ancestors OrientationSensor and Sensor.

Event handlers

No specific event handlers; inherits methods from its ancestor, Sensor.

Methods

No specific methods; inherits methods from its ancestors OrientationSensor and Sensor.

Examples

Basic Example

The following example, which is loosely based on Intel's Orientation Phone demo, instantiates an AbsoluteOrientationSensor with a frequency of 60 times a second. On each reading it uses OrientationSensor.quaternion to rotate a visual model of a phone.

const options = { frequency: 60, referenceFrame: 'device' };
const sensor = new AbsoluteOrientationSensor(options);

sensor.addEventListener('reading', () => {
  // model is a Three.js object instantiated elsewhere.
  model.quaternion.fromArray(sensor.quaternion).inverse();
});
sensor.addEventListener('error', error => {
  if (event.error.name == 'NotReadableError') {
    console.log("Sensor is not available.");
  }
});
sensor.start();

Permissions Example

Using orientation sensors requires requesting permissions for multiple device sensors. Because the Permissions uses promises, a good way to request permissions is to use Promise.all.

const sensor = new AbsoluteOrientationSensor();
Promise.all([navigator.permissions.query({ name: "accelerometer" }),
             navigator.permissions.query({ name: "magnetometer" }),
             navigator.permissions.query({ name: "gyroscope" })])
       .then(results => {
         if (results.every(result => result.state === "granted")) {
           sensor.start();
           ...
         } else {
           console.log("No permissions to use AbsoluteOrientationSensor.");
         }
   });

Specifications

Specification	Status	Comment
Generic Sensor API	Candidate Recommendation	Defines sensors in general.
Orientation SensorThe definition of 'AbsoluteOrientationSensor' in that specification.	Candidate Recommendation

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`AbsoluteOrientationSensor`	Chrome Full support 67	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 54	Safari No support No	WebView Android Full support 67	Chrome Android Full support 67	Firefox Android No support No	Opera Android Full support 48	Safari iOS No support No	Samsung Internet Android Full support 9.0
`AbsoluteOrientationSensor()` constructor	Chrome Full support 67	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 54	Safari No support No	WebView Android Full support 67	Chrome Android Full support 67	Firefox Android No support No	Opera Android Full support 48	Safari iOS No support No	Samsung Internet Android Full support 9.0

Legend

Full support: Full support
No support: No support

AbsoluteOrientationSensor by Mozilla Contributors is licensed under CC-BY-SA 2.5.