Stay organized with collections
Save and categorize content based on your preferences.
SensorListener
interface SensorListener
Known Direct Subclasses
OrientationListener |
Helper class for receiving notifications from the SensorManager when the orientation of the device has changed.
|
|
Used for receiving notifications from the SensorManager when sensor values have changed.
Summary
Public methods |
abstract Unit |
Called when the accuracy of a sensor has changed.
|
abstract Unit |
Called when sensor values have changed.
|
Public methods
onAccuracyChanged
abstract fun onAccuracyChanged(
sensor: Int,
accuracy: Int
): Unit
Deprecated: Deprecated in Java.
Called when the accuracy of a sensor has changed. See SensorManager
for details.
Parameters |
sensor |
Int: The ID of the sensor being monitored |
accuracy |
Int: The new accuracy of this sensor. |
onSensorChanged
abstract fun onSensorChanged(
sensor: Int,
values: FloatArray!
): Unit
Deprecated: Deprecated in Java.
Called when sensor values have changed. The length and contents of the values array vary depending on which sensor is being monitored. See SensorManager
for details on possible sensor types.
Definition of the coordinate system used below.
The X axis refers to the screen's horizontal axis (the small edge in portrait mode, the long edge in landscape mode) and points to the right.
The Y axis refers to the screen's vertical axis and points towards the top of the screen (the origin is in the lower-left corner).
The Z axis points toward the sky when the device is lying on its back on a table.
IMPORTANT NOTE: The axis are swapped when the device's screen orientation changes. To access the unswapped values, use indices 3, 4 and 5 in values[].
SENSOR_ORIENTATION
, SENSOR_ORIENTATION_RAW
:
All values are angles in degrees.
values[0]: Azimuth, rotation around the Z axis (0<=azimuth<360). 0 = North, 90 = East, 180 = South, 270 = West
values[1]: Pitch, rotation around X axis (-180<=pitch<=180), with positive values when the z-axis moves toward the y-axis.
values[2]: Roll, rotation around Y axis (-90<=roll<=90), with positive values when the z-axis moves toward the x-axis.
Note that this definition of yaw, pitch and roll is different from the traditional definition used in aviation where the X axis is along the long side of the plane (tail to nose).
SENSOR_ACCELEROMETER
:
All values are in SI units (m/s^2) and measure contact forces.
values[0]: force applied by the device on the x-axis
values[1]: force applied by the device on the y-axis
values[2]: force applied by the device on the z-axis
Examples:
When the device is pushed on its left side toward the right, the x acceleration value is negative (the device applies a reaction force to the push toward the left)
When the device lies flat on a table, the acceleration value is -STANDARD_GRAVITY
, which correspond to the force the device applies on the table in reaction to gravity.
SENSOR_MAGNETIC_FIELD
:
All values are in micro-Tesla (uT) and measure the ambient magnetic field in the X, Y and -Z axis.
Note: the magnetic field's Z axis is inverted.
Parameters |
sensor |
Int: The ID of the sensor being monitored |
values |
FloatArray!: The new values for the sensor. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# SensorListener\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \nDeprecated in [API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nSensorListener\n==============\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/hardware/SensorListener \"View this page in Java\") \n\n```\ninterface SensorListener\n```\n\n|--------------------------------------|\n| [android.hardware.SensorListener](#) |\n\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Known Direct Subclasses [OrientationListener](../view/OrientationListener.html#) |----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| | [OrientationListener](../view/OrientationListener.html#) | Helper class for receiving notifications from the SensorManager when the orientation of the device has changed. | |\n\n*** ** * ** ***\n\n| **This interface was deprecated in API level 3.**\n|\n| Use [SensorEventListener](/reference/kotlin/android/hardware/SensorEventListener) instead.\n\nUsed for receiving notifications from the SensorManager when sensor values have changed.\n\nSummary\n-------\n\n| Public methods ||\n|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [onAccuracyChanged](#onAccuracyChanged(kotlin.Int,%20kotlin.Int))`(`sensor:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `accuracy:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Called when the accuracy of a sensor has changed. |\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [onSensorChanged](#onSensorChanged(kotlin.Int,%20kotlin.FloatArray))`(`sensor:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `values:` `[FloatArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float-array/index.html)!`)` Called when sensor values have changed. |\n\nPublic methods\n--------------\n\n### onAccuracyChanged\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun onAccuracyChanged(\n sensor: Int, \n accuracy: Int\n): Unit\n```\n\n**Deprecated:** *Deprecated in Java.*\n\nCalled when the accuracy of a sensor has changed. See [SensorManager](/reference/kotlin/android/hardware/SensorManager) for details.\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------|\n| `sensor` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): The ID of the sensor being monitored |\n| `accuracy` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): The new accuracy of this sensor. |\n\n### onSensorChanged\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun onSensorChanged(\n sensor: Int, \n values: FloatArray!\n): Unit\n```\n\n**Deprecated:** *Deprecated in Java.*\n\nCalled when sensor values have changed. The length and contents of the values array vary depending on which sensor is being monitored. See [SensorManager](/reference/kotlin/android/hardware/SensorManager) for details on possible sensor types.\n\nDefinition of the coordinate system used below.\n\nThe X axis refers to the screen's horizontal axis (the small edge in portrait mode, the long edge in landscape mode) and points to the right.\n\nThe Y axis refers to the screen's vertical axis and points towards the top of the screen (the origin is in the lower-left corner).\n\nThe Z axis points toward the sky when the device is lying on its back on a table.\n\n**IMPORTANT NOTE:** The axis **are swapped** when the device's screen orientation changes. To access the unswapped values, use indices 3, 4 and 5 in values\\[\\].\n\n[SENSOR_ORIENTATION](/reference/kotlin/android/hardware/SensorManager#SENSOR_ORIENTATION:kotlin.Int), [SENSOR_ORIENTATION_RAW](/reference/kotlin/android/hardware/SensorManager#SENSOR_ORIENTATION_RAW:kotlin.Int):\n\nAll values are angles in degrees.\n\nvalues\\[0\\]: Azimuth, rotation around the Z axis (0\\\u003c=azimuth\\\u003c360). 0 = North, 90 = East, 180 = South, 270 = West\n\nvalues\\[1\\]: Pitch, rotation around X axis (-180\\\u003c=pitch\\\u003c=180), with positive values when the z-axis moves toward the y-axis.\n\nvalues\\[2\\]: Roll, rotation around Y axis (-90\\\u003c=roll\\\u003c=90), with positive values when the z-axis moves toward the x-axis.\n\nNote that this definition of yaw, pitch and roll is different from the traditional definition used in aviation where the X axis is along the long side of the plane (tail to nose).\n\n[SENSOR_ACCELEROMETER](/reference/kotlin/android/hardware/SensorManager#SENSOR_ACCELEROMETER:kotlin.Int):\n\nAll values are in SI units (m/s\\^2) and measure contact forces.\n\nvalues\\[0\\]: force applied by the device on the x-axis\n\nvalues\\[1\\]: force applied by the device on the y-axis\n\nvalues\\[2\\]: force applied by the device on the z-axis\n\nExamples:\n- When the device is pushed on its left side toward the right, the x acceleration value is negative (the device applies a reaction force to the push toward the left)\n- When the device lies flat on a table, the acceleration value is [-STANDARD_GRAVITY](/reference/kotlin/android/hardware/SensorManager#STANDARD_GRAVITY:kotlin.Float), which correspond to the force the device applies on the table in reaction to gravity.\n- [SENSOR_MAGNETIC_FIELD](/reference/kotlin/android/hardware/SensorManager#SENSOR_MAGNETIC_FIELD:kotlin.Int):\n- All values are in micro-Tesla (uT) and measure the ambient magnetic field in the X, Y and -Z axis.\n- **Note:** the magnetic field's Z axis is inverted.\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------------------------|\n| `sensor` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): The ID of the sensor being monitored |\n| `values` | [FloatArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float-array/index.html)!: The new values for the sensor. |"]]