expo-sensors
Version:
Provides access to a hardware device's accelerometer, gyroscope, magnetometer, and pedometer.
34 lines • 1.84 kB
JavaScript
import DeviceSensor from './DeviceSensor';
import ExponentGyroscope from './ExponentGyroscope';
export class GyroscopeSensor extends DeviceSensor {
/**
* > **info** You should always check the sensor availability before attempting to use it.
*
* Returns whether the gyroscope is enabled on the device.
*
* On mobile web, you must first invoke `Gyroscope.requestPermissionsAsync()` in a user interaction (i.e. touch event) before you can use this module.
* If the `status` is not equal to `granted` then you should inform the end user that they may have to open settings.
*
* On **web** this starts a timer and waits to see if an event is fired. This should predict if the iOS device has the **device orientation** API disabled in
* **Settings > Safari > Motion & Orientation Access**. Some devices will also not fire if the site isn't hosted with **HTTPS** as `DeviceMotion` is now considered a secure API.
* There is no formal API for detecting the status of `DeviceMotion` so this API can sometimes be unreliable on web.
*
* @return A promise that resolves to a `boolean` denoting the availability of the gyroscope.
*/
async isAvailableAsync() {
return super.isAvailableAsync();
}
/**
* Subscribe for updates to the gyroscope.
*
* @param listener A callback that is invoked when a gyroscope update is available. When invoked,
* the listener is provided a single argument that is an `GyroscopeMeasurement` object.
*
* @return A subscription that you can call `remove()` on when you would like to unsubscribe the listener.
*/
addListener(listener) {
return super.addListener(listener);
}
}
export default new GyroscopeSensor(ExponentGyroscope, 'gyroscopeDidUpdate');
//# sourceMappingURL=Gyroscope.js.map