Titanium SDK # Modules.CoreMotion.Gyroscope
Allows Titanium client applications to access CoreMotion's Gyroscope APIs.
5.2.0# Properties
# apiName READONLY
5.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# bubbleParent
5.2.0Indicates 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
# Methods
# addEventListener
5.2.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
5.2.0Applies 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.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# fireEvent
5.2.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
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
- Type
- void
# getGyroData
5.2.0Returns the latest sample of gyroscope data.
An app that is receiving gyroscope data after calling startGyroUpdates with no callback, needs to periodically check the value returned by this method and process the gyroscope data.
Returns
- Type
- CoreMotionGyroData
# isGyroActive
5.2.0Returns a Boolean indicating whether gyroscope updates are currently happening.
Indicates whether startGyroUpdates has been called since stopGyroUpdates.
Returns
- Type
- Boolean
# isGyroAvailable
5.2.0Returns a Boolean indicating whether a gyroscope is available on the device.
Returns
- Type
- Boolean
# removeEventListener
5.2.0Removes 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 | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void
# setGyroUpdateInterval
5.2.0The interval in milliseconds, for providing gyroscope updates to the callback.
Parameters
| Name | Type | Description |
|---|---|---|
interval | Number | The interval in milliseconds |
Returns
- Type
- void
# startGyroUpdates
5.2.0Starts gyroscope 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.setGyroUpdateInterval> method. If no callback is passed, the gyroscope data can be accessed using the getGyroData method. To stop the delivery of events, call the stopGyroUpdates 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<CoreMotionGyroDataWithSuccess> | The method to be called when there is an update. |
Returns
- Type
- void