Commit a1fd7488 authored by Chris Scott's avatar Chris Scott

docs

parent 2b7a3bd2
......@@ -97,18 +97,31 @@ With aggressive location-monitoring enabled, if the user stops for exactly 15 mi
Use the following config-parameters with the #configure method:
`@param {Integer} [0, 10, 100, 1000] [desiredAccuracy](https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/CLLocationManager/CLLocationManager.html#//apple_ref/occ/instp/CLLocationManager/desiredAccuracy) in meters`
*`@param {Integer} [0, 10, 100, 1000] desiredAccuracy in meters`*
The lower the number, the more power devoted to GeoLocation resulting in higher accuracy readings. 1000 results in lowest power drain and least accurate readings.
The lower the number, the more power devoted to GeoLocation resulting in higher accuracy readings. 1000 results in lowest power drain and least accurate readings. @see [Apple docs](https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/CLLocationManager/CLLocationManager.html#//apple_ref/occ/instp/CLLocationManager/desiredAccuracy)
`@param {Integer} [distanceFilter](https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/CLLocationManager/CLLocationManager.html#//apple_ref/occ/instp/CLLocationManager/distanceFilter)`
`@param {Integer} distanceFilter`
The minimum distance (measured in meters) a device must move horizontally before an update event is generated.
The minimum distance (measured in meters) a device must move horizontally before an update event is generated. @see [Apple docs](https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/CLLocationManager/CLLocationManager.html#//apple_ref/occ/instp/CLLocationManager/distanceFilter)
`@param {Integer} stationaryRadius (meters)
`@param {Integer} stationaryRadius (meters)`
When stopped, the minimum distance the device must move beyond the stationary location for aggressive background-tracking to engage. Note, since the plugin uses iOS significant-changes API, the plugin cannot detect the exact moment the device moves out of the stationary-radius. In normal conditions, it can take as much as 3 city-blocks to 1/2 km before staionary-region exit is detected.
`@param {Boolean} debug`
When enabled, the plugin will emit sounds for life-cycle events of background-geolocation. NOTE: In addition, you must manually enable the *Audio and Airplay* background mode in *Background Capabilities* to hear these debugging sounds.
- Exit stationary region: Calendar event notification sound
- GeoLocation recorded: SMS sent sound
- Aggressive geolocation engaged: SIRI listening sound
- Passive geolocation engaged: SIRI stop listening sound
- Acquiring stationary location sound: "tick" sound
- Stationary location acquired sound: "bloom" sound
![Alt text](/enable-background-audio.png "Optional title")
## Android
** TODO Brian ##
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment