Modules.CoreMotion.DeviceMotion
> Modules.CoreMotion.DeviceMotion

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

  • 5.2.0
  • 5.2.0
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button returns Ti.UI.Button.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Indicates if the proxy will bubble an event to its parent. ...

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

  • 3.0.0
  • 3.0.0
  • 3.0.0

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

  • 3.6.0
Defined By

Methods

Adds the specified callback as an event listener for the named event. ...

Adds the specified callback as an event listener for the named event.

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Modules.CoreMotion.DeviceMotion
( ) : Number
Returns a bitmask specifying the available attitude reference frames on the device. ...

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

  • Number
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • name : String

    Name of the event.

  • event : Dictionary

    A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Modules.CoreMotion.DeviceMotion
( ) : Number
Returns either the reference frame currently being used or the default attitude reference frame. ...

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 Modules.CoreMotion.ATTITUDE_REFERENCE_FRAME_X_ARBITRARY_Z_VERTICAL, Modules.CoreMotion.ATTITUDE_REFERENCE_FRAME_X_ARBITRARY_CORRECTED_Z_VERTICAL, Modules.CoreMotion.ATTITUDE_REFERENCE_FRAME_X_MAGNETIC_NORTH_Z_VERTICAL, and Modules.CoreMotion.ATTITUDE_REFERENCE_FRAME_X_TRUE_NORTH_Z_VERTICAL.

Returns

  • Number
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Modules.CoreMotion.DeviceMotion
( ) : CoreMotionDeviceMotionData
Returns the latest sample of device-motion data. ...

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

Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Modules.CoreMotion.DeviceMotion
( ) : Boolean
Returns a Boolean value that determines whether the app is receiving updates from the device-motion service. ...

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

Indicates whether startDeviceMotionUpdates or startDeviceMotionUpdatesUsingReferenceFrame has been called since stopDeviceMotionUpdates.

Returns

  • Boolean
Modules.CoreMotion.DeviceMotion
( ) : Boolean
Returns a Boolean indicating whether device-motion is available on the device. ...

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

Returns

  • Boolean
Removes the specified callback as an event listener for the named event. ...

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Modules.CoreMotion.DeviceMotion
( interval )
The interval in milliseconds, for providing device-motion updates to the callback. ...

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

  • interval : Number

    The interval in milliseconds

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Modules.CoreMotion.DeviceMotion
( show )
Controls whether the device-movement display is shown. ...

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 Modules.CoreMotion.ERROR_DEVICE_REQUIRES_MOVEMENT error once. By default, this is set to false.

Parameters

  • show : Boolean

    Boolean indicating if the display should be shown

Returns

  • void
Modules.CoreMotion.DeviceMotion
( [callback] )
Starts device-motion updates. ...

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

Returns

  • void
Modules.CoreMotion.DeviceMotion
( args, [callback] )
Starts device-motion updates using a reference frame. ...

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

Returns

  • void
Modules.CoreMotion.DeviceMotion
( )
Stops device-motion updates. ...

Stops device-motion updates.

Returns

  • void