Modules.CoreMotion.Accelerometer
Allows Titanium client applications to access CoreMotion's Accelerometer APIs.
Extends: Titanium.Proxy · Since: 5.2.0 · Platforms: iphone, ipad
Methods #
getAccelerometerData #
Returns the latest sample of accelerometer data.
An app that is receiving accelerometer data after calling
Modules.CoreMotion.Accelerometer.startAccelerometerUpdates with no callback, needs to periodically
check the value returned by this method and process the acceleration data.
Returns: CoreMotionAccelerometerData
isAccelerometerActive #
Returns a Boolean indicating whether accelerometer updates are currently happening.
Indicates whether Modules.CoreMotion.Accelerometer.startAccelerometerUpdates has been called since
Modules.CoreMotion.Accelerometer.stopAccelerometerUpdates.
Returns: Boolean
isAccelerometerAvailable #
Returns a Boolean indicating whether an accelerometer is available on the device.
Returns: Boolean
setAccelerometerUpdateInterval #
The interval in milliseconds, for providing accelerometer updates to the callback.
| Name | Type | Summary | Optional |
|---|---|---|---|
interval | Number | The interval in milliseconds | No |
startAccelerometerUpdates #
Starts accelerometer updates.
If a callback is passed to this method, it will be called whenever there is an update.
The frequency of these updates can be controlled using the
Modules.CoreMotion.Accelerometer.setAccelerometerUpdateInterval method.
If no callback is passed, the accelerometer data can be accessed using the
Modules.CoreMotion.Accelerometer.getAccelerometerData method. To stop the delivery of events,
call the Modules.CoreMotion.Accelerometer.stopAccelerometerUpdates method.
Note: It is recommended to set an update interval of at least 250ms before, to avoid receiving
too many callbacks at once.
| Name | Type | Summary | Optional |
|---|---|---|---|
callback | Callback<CoreMotionAccelerometerDataWithSuccess> | The method to be called when there is an update. | Yes |
stopAccelerometerUpdates #
Stops accelerometer updates.