# Modules.CoreMotion.DeviceMotion

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

Availability
5.2.0

# Methods

# availableAttitudeReferenceFrames

Availability
5.2.0
availableAttitudeReferenceFrames() Number

Returns a bitmask specifying the available attitude reference frames on the device.

A bitmask that you can bitwise-AND with the ATTITUDE_REFERENCE constants.

For example to determine if ATTITUDE_REFERENCE_FRAME_X_MAGNETIC_NORTH_Z_VERTICAL is available on device.

var frames = CoreMotion.DeviceMotion.availableAttitudeReferenceFrames();
if (frames & CoreMotion.ATTITUDE_REFERENCE_FRAME_X_MAGNETIC_NORTH_Z_VERTICAL) {
    // do something here
}

Returns

Type
Number

# getAttitudeReferenceFrame

Availability
5.2.0
getAttitudeReferenceFrame() Number

Returns either the reference frame currently being used or the default attitude reference frame.

If device motion is active, this property returns the reference frame currently in use. If device motion is not active but has been active since the app was last launched, this property returns the last frame used. If device motion has not been active since the app was last launched, this property returns the default attitude reference frame for the device. Possible reference frames include ATTITUDE_REFERENCE_FRAME_X_ARBITRARY_Z_VERTICAL, ATTITUDE_REFERENCE_FRAME_X_ARBITRARY_CORRECTED_Z_VERTICAL, ATTITUDE_REFERENCE_FRAME_X_MAGNETIC_NORTH_Z_VERTICAL, and ATTITUDE_REFERENCE_FRAME_X_TRUE_NORTH_Z_VERTICAL.

Returns

Type
Number

# getDeviceMotion

Availability
5.2.0
getDeviceMotion() CoreMotionDeviceMotionData

Returns the latest sample of device-motion data.

An app that is receiving device-motion data after calling startDeviceMotionUpdatesUsingReferenceFrame or startDeviceMotionUpdates with no callback, need to periodically check the value returned by this method and process the device-motion data.

Returns


# isDeviceMotionActive

Availability
5.2.0
isDeviceMotionActive() Boolean

Returns a Boolean value that determines whether the app is receiving updates from the device-motion service.

Returns

Type
Boolean

# isDeviceMotionAvailable

Availability
5.2.0
isDeviceMotionAvailable() Boolean

Returns a Boolean indicating whether device-motion is available on the device.

Returns

Type
Boolean

# setDeviceMotionUpdateInterval

Availability
5.2.0
setDeviceMotionUpdateInterval(interval) void

The interval in milliseconds, for providing device-motion updates to the callback.

The system supplies device-motion updates to the callback passed to startDeviceMotionUpdatesUsingReferenceFrame or startDeviceMotionUpdates at regular intervals determined by the value passed to this method. The interval units are in milliseconds. The value of this property is capped to minimum and maximum values; the maximum value is determined by the maximum frequency supported by the hardware. If your app is sensitive to the intervals of device-motion data, it should always check the timestamps of the delivered device-motion event to determine the true update interval.

Parameters

Name Type Description
interval Number

The interval in milliseconds

Returns

Type
void

# setShowsDeviceMovementDisplay

Availability
5.2.0
setShowsDeviceMovementDisplay(show) void

Controls whether the device-movement display is shown.

When a device requires movement (for example, to calibrate the compass), the value of this property indicates if the system's device-movement display should be shown. When a device requires movement, the callback for setDeviceMotionUpdateInterval or startDeviceMotionUpdatesUsingReferenceFrame reports the ERROR_DEVICE_REQUIRES_MOVEMENT error once. By default, this is set to false.

Parameters

Name Type Description
show Boolean

Boolean indicating if the display should be shown

Returns

Type
void

# startDeviceMotionUpdates

Availability
5.2.0
startDeviceMotionUpdates([callback]) void

Starts device-motion 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 setDeviceMotionUpdateInterval method. If no callback is passed, the device-motion data can be accessed using the getDeviceMotion method. To stop the delivery of events, call the stopDeviceMotionUpdates method.

Parameters

Name Type Description
callback Callback<CoreMotionDeviceMotionDataWithSuccess>

The method to be called when there is an update.

Returns

Type
void

# startDeviceMotionUpdatesUsingReferenceFrame

Availability
5.2.0
startDeviceMotionUpdatesUsingReferenceFrame(args[, callback]) void

Starts device-motion updates using a reference frame.

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 setDeviceMotionUpdateInterval method. If no callback is passed, the device-motion data can be accessed using the getDeviceMotion method. To stop the delivery of events, call the stopDeviceMotionUpdates method.

Parameters

Name Type Description
args CoreMotionReferenceFrameArgs

The arguments passed to this method

callback Callback<CoreMotionDeviceMotionDataWithSuccess>

The method to be called when there is an update.

Returns

Type
void

# stopDeviceMotionUpdates

Availability
5.2.0
stopDeviceMotionUpdates() void

Stops device-motion updates.

Returns

Type
void