# Modules.CoreMotion.Accelerometer

Allows Titanium client applications to access CoreMotion's Accelerometer APIs.

Availability
5.2.0

# Methods

# getAccelerometerData

Availability
5.2.0
getAccelerometerData() CoreMotionAccelerometerData

Returns the latest sample of accelerometer data.

An app that is receiving accelerometer data after calling startAccelerometerUpdates with no callback, needs to periodically check the value returned by this method and process the acceleration data.

Returns


# isAccelerometerActive

Availability
5.2.0
isAccelerometerActive() Boolean

Returns a Boolean indicating whether accelerometer updates are currently happening.

Indicates whether startAccelerometerUpdates has been called since stopAccelerometerUpdates.

Returns

Type
Boolean

# isAccelerometerAvailable

Availability
5.2.0
isAccelerometerAvailable() Boolean

Returns a Boolean indicating whether an accelerometer is available on the device.

Returns

Type
Boolean

# setAccelerometerUpdateInterval

Availability
5.2.0
setAccelerometerUpdateInterval(interval) void

The interval in milliseconds, for providing accelerometer updates to the callback.

Parameters

Name Type Description
interval Number

The interval in milliseconds

Returns

Type
void

# startAccelerometerUpdates

Availability
5.2.0
startAccelerometerUpdates([callback]) void

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 setAccelerometerUpdateInterval method. If no callback is passed, the accelerometer data can be accessed using the getAccelerometerData method. To stop the delivery of events, call the stopAccelerometerUpdates method. Note: It is recommended to set an update interval of at least 250ms before, to avoid receiving too many callbacks at once.

Parameters

Name Type Description
callback Callback<CoreMotionAccelerometerDataWithSuccess>

The method to be called when there is an update.

Returns

Type
void

# stopAccelerometerUpdates

Availability
5.2.0
stopAccelerometerUpdates() void

Stops accelerometer updates.

Returns

Type
void