Skip to main content
API Reference com.nianticspatial.nsdk.helpers

SensorHelper

↳ extends SensorEventListener
Reads compass (heading) and raw magnetometer data from Android sensors and exposes it as a [Compass] snapshot. Used internally by [DefaultSessionDataSource]. Call [resume] when the owning component becomes active and [pause] when it is paused to conserve battery.

Declaration

class SensorHelper

Functions

NameTypeSummary
compassCompass
Returns a snapshot of the latest compass reading. Check [Compass.headingAccuracy] >= 0 to confirm data has arrived.
isDeviceFlatBoolean
Returns true when the device is roughly flat (face-up or face-down).
onAccuracyChangedvoid
-
onSensorChangedvoid
-
pausevoid
Unregisters all sensor listeners. Call from [androidx.lifecycle.DefaultLifecycleObserver.onPause].
resumevoid
Registers sensor listeners. Call from [androidx.lifecycle.DefaultLifecycleObserver.onResume].