MapboxNavigationOptions (libandroid-navigation API)

java.lang.Object
- com.mapbox.services.android.navigation.v5.MapboxNavigationOptions

public class MapboxNavigationOptions
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

MapboxNavigationOptions()
Creates a new MapboxNavigationOptions object.

Constructors
Constructor and Description
`MapboxNavigationOptions()` Creates a new MapboxNavigationOptions object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getDeadReckoningTimeInterval()` Get the current time interval being used to calculate dead reckoning values.
`java.lang.String`	`getDirectionsProfile()` Get the directions profile which will be used when requesting the route.
`int`	`getHighAlertInterval()` Get the current number of seconds required for a `NavigationConstants.HIGH_ALERT_LEVEL` alert to occurs.
`double`	`getManeuverZoneRadius()` Get the current radius, in meters, the user must enter to count as completing a step.
`double`	`getMaximumDistanceOffRoute()` Get the current required maximum distance in meters a user can travel away from the step geometry before the `OffRouteListener`'s called.
`double`	`getMaxManipulatedCourseAngle()` Get the maximum angle the user puck will be rotated when snapping the user's course to the route line.
`double`	`getMaxTurnCompletionOffset()` Get the current set threshold user must be within to count as completing a `LegStep`.
`int`	`getMediumAlertInterval()` Get the current number of seconds required for a `NavigationConstants.MEDIUM_ALERT_LEVEL` alert to occur.
`double`	`getMinimumHighAlertDistanceCycling()` Get the current required distance in meters representing the minimum length of a step for a `NavigationConstants.HIGH_ALERT_LEVEL` to occur.
`double`	`getMinimumHighAlertDistanceDriving()` Get the current required distance in meters representing the minimum length of a step for a `NavigationConstants.HIGH_ALERT_LEVEL` to occur.
`double`	`getMinimumHighAlertDistanceWalking()` Get the current required distance in meters representing the minimum length of a step for a `NavigationConstants.HIGH_ALERT_LEVEL` to occur.
`double`	`getMinimumMediumAlertDistanceCycling()` Get the current required distance in meters representing the minimum length of a step for a `NavigationConstants.MEDIUM_ALERT_LEVEL` to occur while cycling.
`double`	`getMinimumMediumAlertDistanceDriving()` Get the current required distance in meters representing the minimum length of a step for a `NavigationConstants.MEDIUM_ALERT_LEVEL` to occur while driving.
`double`	`getMinimumMediumAlertDistanceWalking()` Get the current required distance in meters representing the minimum length of a step for a `NavigationConstants.MEDIUM_ALERT_LEVEL` to occur while walking.
`int`	`getSecondsBeforeReroute()` The seconds before off-route happens, initially when the user goes off-route, a timer is started and waits till it reaches this value and then notifies the off-route listener.
`double`	`getUserLocationSnapDistance()` Determines the distance the user must stay within for snapping to route to occur.
`MapboxNavigationOptions`	`setDeadReckoningTimeInterval(double deadReckoningTimeInterval)` When calculating whether or not the user is on the route, we look where the user will be given their speed and this `deadReckoningTimeInterval` variable.
`void`	`setDirectionsProfile(java.lang.String profile)` Set the directions profile which will be used when requesting the route.
`MapboxNavigationOptions`	`setHighAlertInterval(int highAlertInterval)` Number of seconds left on step when a `NavigationConstants.HIGH_ALERT_LEVEL` alert occurs.
`MapboxNavigationOptions`	`setManeuverZoneRadius(double maneuverZoneRadius)` Radius, in meters, the user must enter to count as completing a step.
`MapboxNavigationOptions`	`setMaximumDistanceOffRoute(double maximumDistanceOffRoute)` Maximum distance in meters a user can travel away from the step geometry before the `OffRouteListener`'s called.
`MapboxNavigationOptions`	`setMaxManipulatedCourseAngle(double maxManipulatedCourseAngle)` Maximum angle the user puck will be rotated when snapping the user's course to the route line.
`MapboxNavigationOptions`	`setMaxTurnCompletionOffset(double maxTurnCompletionOffset)` Set the threshold user must be within to count as completing a `LegStep`.
`MapboxNavigationOptions`	`setMediumAlertInterval(int mediumAlertInterval)` Number of seconds left on step when a `NavigationConstants.MEDIUM_ALERT_LEVEL` alert occurs.
`MapboxNavigationOptions`	`setMinimumHighAlertDistanceCycling(double minimumHighAlertDistanceCycling)` Distance in meters representing the minimum length of a step for a `NavigationConstants.HIGH_ALERT_LEVEL` to occur while cycling.
`MapboxNavigationOptions`	`setMinimumHighAlertDistanceDriving(double minimumHighAlertDistanceDriving)` Distance in meters representing the minimum length of a step for a `NavigationConstants.HIGH_ALERT_LEVEL` to occur while driving.
`MapboxNavigationOptions`	`setMinimumHighAlertDistanceWalking(double minimumHighAlertDistanceWalking)` Distance in meters representing the minimum length of a step for a `NavigationConstants.HIGH_ALERT_LEVEL` to occur while walking.
`MapboxNavigationOptions`	`setMinimumMediumAlertDistanceCycling(double minimumMediumAlertDistanceCycling)` Distance in meters representing the minimum length of a step for a `NavigationConstants.MEDIUM_ALERT_LEVEL` to occur while cycling.
`MapboxNavigationOptions`	`setMinimumMediumAlertDistanceDriving(double minimumMediumAlertDistanceDriving)` Distance in meters representing the minimum length of a step for a `NavigationConstants.MEDIUM_ALERT_LEVEL` to occur while driving.
`MapboxNavigationOptions`	`setMinimumMediumAlertDistanceWalking(double minimumMediumAlertDistanceWalking)` Distance in meters representing the minimum length of a step for a `NavigationConstants.MEDIUM_ALERT_LEVEL` to occur while walking.
`void`	`setSecondsBeforeReroute(int secondsBeforeReroute)` The seconds before off-route happens, initially when the user goes off-route, a timer is started and waits till it reaches this value and then notifies the off-route listener.
`void`	`setUserLocationSnapDistance(double userLocationSnapDistance)` set the distance the user must stay within for snapping to route to occur.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapboxNavigationOptions
```
public MapboxNavigationOptions()
```
    Creates a new MapboxNavigationOptions object.
    
    Since:
    
    0.2.0
- Method Detail
  - setMaxTurnCompletionOffset
```
public MapboxNavigationOptions setMaxTurnCompletionOffset(double maxTurnCompletionOffset)
```
    Set the threshold user must be within to count as completing a LegStep. When checking if the users completed the step, the users Location.getBearing() and the StepManeuver.bearingAfter are compared. If this number is within the setMaxTurnCompletionOffset the user has completed the step. This is one of the two heuristics used to know when a user completes a step, the other being NavigationConstants.MANEUVER_ZONE_RADIUS.
    
    Parameters:
    
    maxTurnCompletionOffset - degree double value between 0 and 359 representing the threshold used to consider if the user has completed the step maneuver.
    
    Returns:
    
    This.
    
    Since:
    
    0.2.0
  - setManeuverZoneRadius
```
public MapboxNavigationOptions setManeuverZoneRadius(double maneuverZoneRadius)
```
    Radius, in meters, the user must enter to count as completing a step. This is one of the two heuristics used to know when a user completes a step, the other being NavigationConstants.MAXIMUM_ALLOWED_DEGREE_OFFSET_FOR_TURN_COMPLETION
    
    Parameters:
    
    maneuverZoneRadius - double radius value with unit meters representing the area the user must enter to count as completing a step.
    
    Returns:
    
    This.
    
    Since:
    
    0.2.0
  - setMediumAlertInterval
```
public MapboxNavigationOptions setMediumAlertInterval(int mediumAlertInterval)
```
    Number of seconds left on step when a NavigationConstants.MEDIUM_ALERT_LEVEL alert occurs.
    
    Parameters:
    
    mediumAlertInterval - integer value in unit seconds representing the seconds left till a medium alert level occurs.
    
    Returns:
    
    this;
    
    Since:
    
    0.2.0
  - setHighAlertInterval
```
public MapboxNavigationOptions setHighAlertInterval(int highAlertInterval)
```
    Number of seconds left on step when a NavigationConstants.HIGH_ALERT_LEVEL alert occurs.
    
    Parameters:
    
    highAlertInterval - integer value in unit seconds representing the seconds left till a high alert level occurs.
    
    Returns:
    
    this.
    
    Since:
    
    0.2.0
  - setMinimumMediumAlertDistanceDriving
```
public MapboxNavigationOptions setMinimumMediumAlertDistanceDriving(double minimumMediumAlertDistanceDriving)
```
    Distance in meters representing the minimum length of a step for a NavigationConstants.MEDIUM_ALERT_LEVEL to occur while driving.
    
    Parameters:
    
    minimumMediumAlertDistanceDriving - double value in unit meters representing the minimum step length for a medium alert to occur.
    
    Returns:
    
    this.
    
    Since:
    
    0.2.0
  - setMinimumMediumAlertDistanceCycling
```
public MapboxNavigationOptions setMinimumMediumAlertDistanceCycling(double minimumMediumAlertDistanceCycling)
```
    Distance in meters representing the minimum length of a step for a NavigationConstants.MEDIUM_ALERT_LEVEL to occur while cycling.
    
    Parameters:
    
    minimumMediumAlertDistanceCycling - double value in unit meters representing the minimum step length for a medium alert to occur.
    
    Returns:
    
    this.
    
    Since:
    
    0.3.0
  - setMinimumMediumAlertDistanceWalking
```
public MapboxNavigationOptions setMinimumMediumAlertDistanceWalking(double minimumMediumAlertDistanceWalking)
```
    Distance in meters representing the minimum length of a step for a NavigationConstants.MEDIUM_ALERT_LEVEL to occur while walking.
    
    Parameters:
    
    minimumMediumAlertDistanceWalking - double value in unit meters representing the minimum step length for a medium alert to occur.
    
    Returns:
    
    this.
    
    Since:
    
    0.3.0
  - setMinimumHighAlertDistanceDriving
```
public MapboxNavigationOptions setMinimumHighAlertDistanceDriving(double minimumHighAlertDistanceDriving)
```
    Distance in meters representing the minimum length of a step for a NavigationConstants.HIGH_ALERT_LEVEL to occur while driving.
    
    Parameters:
    
    minimumHighAlertDistanceDriving - double value in unit meters representing the minimum step length for a high alert to occur.
    
    Returns:
    
    this.
    
    Since:
    
    0.3.0
  - setMinimumHighAlertDistanceCycling
```
public MapboxNavigationOptions setMinimumHighAlertDistanceCycling(double minimumHighAlertDistanceCycling)
```
    Distance in meters representing the minimum length of a step for a NavigationConstants.HIGH_ALERT_LEVEL to occur while cycling.
    
    Parameters:
    
    minimumHighAlertDistanceCycling - double value in unit meters representing the minimum step length for a high alert to occur.
    
    Returns:
    
    this.
    
    Since:
    
    0.3.0
  - setMinimumHighAlertDistanceWalking
```
public MapboxNavigationOptions setMinimumHighAlertDistanceWalking(double minimumHighAlertDistanceWalking)
```
    Distance in meters representing the minimum length of a step for a NavigationConstants.HIGH_ALERT_LEVEL to occur while walking.
    
    Parameters:
    
    minimumHighAlertDistanceWalking - double value in unit meters representing the minimum step length for a high alert to occur.
    
    Returns:
    
    this.
    
    Since:
    
    0.3.0
  - setMaximumDistanceOffRoute
```
public MapboxNavigationOptions setMaximumDistanceOffRoute(double maximumDistanceOffRoute)
```
    Maximum distance in meters a user can travel away from the step geometry before the OffRouteListener's called.
    
    Parameters:
    
    maximumDistanceOffRoute - double value in unit meters representing the maximum distance a user can travel before the OffRouteListener gets called.
    
    Returns:
    
    this.
    
    Since:
    
    0.2.0
  - setDeadReckoningTimeInterval
```
public MapboxNavigationOptions setDeadReckoningTimeInterval(double deadReckoningTimeInterval)
```
    When calculating whether or not the user is on the route, we look where the user will be given their speed and this deadReckoningTimeInterval variable.
    
    Parameters:
    
    deadReckoningTimeInterval - time interval in unit seconds we use for dead reckoning purposes.
    
    Returns:
    
    this.
    
    Since:
    
    0.2.0
  - setMaxManipulatedCourseAngle
```
public MapboxNavigationOptions setMaxManipulatedCourseAngle(double maxManipulatedCourseAngle)
```
    Maximum angle the user puck will be rotated when snapping the user's course to the route line.
    
    Parameters:
    
    maxManipulatedCourseAngle - degree int value between 0 and 359 representing the maximum angle the user puck will be rotated
    
    Returns:
    
    this.
    
    Since:
    
    0.2.0
  - getMaxTurnCompletionOffset
```
public double getMaxTurnCompletionOffset()
```
    Get the current set threshold user must be within to count as completing a LegStep. When checking if the user completed the step, the users StepManeuver.bearingAfter are compared. If this number is within the setMaxTurnCompletionOffset the user has completed the step. This is one of the two heuristics used to know when a user completes a step, the other being NavigationConstants.MANEUVER_ZONE_RADIUS.
    
    Returns:
    
    degree double value between 0 and 359 representing the threshold being used to consider if the user has completed the step maneuver.
    
    Since:
    
    0.2.0
  - getManeuverZoneRadius
```
public double getManeuverZoneRadius()
```
    Get the current radius, in meters, the user must enter to count as completing a step. This is one of the two heuristics used to know when a user completes a step, the other being NavigationConstants.MAXIMUM_ALLOWED_DEGREE_OFFSET_FOR_TURN_COMPLETION
    
    Returns:
    
    double radius value with unit meters representing the area the user must enter to count as completing a step.
    
    Since:
    
    0.2.0
  - getMediumAlertInterval
```
public int getMediumAlertInterval()
```
    Get the current number of seconds required for a NavigationConstants.MEDIUM_ALERT_LEVEL alert to occur.
    
    Returns:
    
    integer value in unit seconds representing the seconds left till a medium alert level occurs.
    
    Since:
    
    0.2.0
  - getHighAlertInterval
```
public int getHighAlertInterval()
```
    Get the current number of seconds required for a NavigationConstants.HIGH_ALERT_LEVEL alert to occurs.
    
    Returns:
    
    integer value in unit seconds representing the seconds left till a high alert level occurs.
    
    Since:
    
    0.2.0
  - getMinimumMediumAlertDistanceDriving
```
public double getMinimumMediumAlertDistanceDriving()
```
    Get the current required distance in meters representing the minimum length of a step for a NavigationConstants.MEDIUM_ALERT_LEVEL to occur while driving.
    
    Returns:
    
    double value in unit meters representing the minimum step length for a medium alert to occur.
    
    Since:
    
    0.2.0
  - getMinimumMediumAlertDistanceCycling
```
public double getMinimumMediumAlertDistanceCycling()
```
    Get the current required distance in meters representing the minimum length of a step for a NavigationConstants.MEDIUM_ALERT_LEVEL to occur while cycling.
    
    Returns:
    
    double value in unit meters representing the minimum step length for a medium alert to occur.
    
    Since:
    
    0.2.0
  - getMinimumMediumAlertDistanceWalking
```
public double getMinimumMediumAlertDistanceWalking()
```
    Get the current required distance in meters representing the minimum length of a step for a NavigationConstants.MEDIUM_ALERT_LEVEL to occur while walking.
    
    Returns:
    
    double value in unit meters representing the minimum step length for a medium alert to occur.
    
    Since:
    
    0.2.0
  - getMinimumHighAlertDistanceDriving
```
public double getMinimumHighAlertDistanceDriving()
```
    Get the current required distance in meters representing the minimum length of a step for a NavigationConstants.HIGH_ALERT_LEVEL to occur.
    
    Returns:
    
    double value in unit meters representing the minimum step length for a high alert to occur.
    
    Since:
    
    0.3.0
  - getMinimumHighAlertDistanceCycling
```
public double getMinimumHighAlertDistanceCycling()
```
    Get the current required distance in meters representing the minimum length of a step for a NavigationConstants.HIGH_ALERT_LEVEL to occur.
    
    Returns:
    
    double value in unit meters representing the minimum step length for a high alert to occur.
    
    Since:
    
    0.3.0
  - getMinimumHighAlertDistanceWalking
```
public double getMinimumHighAlertDistanceWalking()
```
    Get the current required distance in meters representing the minimum length of a step for a NavigationConstants.HIGH_ALERT_LEVEL to occur.
    
    Returns:
    
    double value in unit meters representing the minimum step length for a high alert to occur.
    
    Since:
    
    0.3.0
  - getMaximumDistanceOffRoute
```
public double getMaximumDistanceOffRoute()
```
    Get the current required maximum distance in meters a user can travel away from the step geometry before the OffRouteListener's called.
    
    Returns:
    
    double value in unit meters representing the maximum distance a user can travel before the OffRouteListener gets called.
    
    Since:
    
    0.2.0
  - getDeadReckoningTimeInterval
```
public double getDeadReckoningTimeInterval()
```
    Get the current time interval being used to calculate dead reckoning values.
    
    Returns:
    
    time interval in unit seconds being used for dead reckoning purposes.
    
    Since:
    
    0.2.0
  - getMaxManipulatedCourseAngle
```
public double getMaxManipulatedCourseAngle()
```
    Get the maximum angle the user puck will be rotated when snapping the user's course to the route line.
    
    Returns:
    
    degree int value between 0 and 359 representing the maximum angle the user puck will be rotated.
    
    Since:
    
    0.2.0
  - getUserLocationSnapDistance
```
public double getUserLocationSnapDistance()
```
    Determines the distance the user must stay within for snapping to route to occur.
    
    Returns:
    
    the distance in unit meters.
    
    Since:
    
    0.3.0
  - setUserLocationSnapDistance
```
public void setUserLocationSnapDistance(double userLocationSnapDistance)
```
    set the distance the user must stay within for snapping to route to occur.
    
    Parameters:
    
    userLocationSnapDistance - distance value in unit meters
    
    Since:
    
    0.3.0
  - getSecondsBeforeReroute
```
public int getSecondsBeforeReroute()
```
    The seconds before off-route happens, initially when the user goes off-route, a timer is started and waits till it reaches this value and then notifies the off-route listener.
    
    Returns:
    
    seconds value before rerouting
    
    Since:
    
    0.3.0
  - setSecondsBeforeReroute
```
public void setSecondsBeforeReroute(int secondsBeforeReroute)
```
    The seconds before off-route happens, initially when the user goes off-route, a timer is started and waits till it reaches this value and then notifies the off-route listener.
    
    Parameters:
    
    secondsBeforeReroute - seconds value before rerouting
    
    Since:
    
    0.3.0
  - setDirectionsProfile
```
public void setDirectionsProfile(java.lang.String profile)
```
    Set the directions profile which will be used when requesting the route. It will also determine variables used to determine alert levels.
    
    Parameters:
    
    profile - one of the profiles defined in NavigationProfiles
  - getDirectionsProfile
```
public java.lang.String getDirectionsProfile()
```
    Get the directions profile which will be used when requesting the route. It will also determine variables used to determine alert levels.
    
    Returns:
    
    one of the profiles defined in NavigationProfiles
    
    Since:
    
    0.3.0

Class MapboxNavigationOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapboxNavigationOptions

Method Detail

setMaxTurnCompletionOffset

setManeuverZoneRadius

setMediumAlertInterval

setHighAlertInterval

setMinimumMediumAlertDistanceDriving

setMinimumMediumAlertDistanceCycling

setMinimumMediumAlertDistanceWalking

setMinimumHighAlertDistanceDriving

setMinimumHighAlertDistanceCycling

setMinimumHighAlertDistanceWalking

setMaximumDistanceOffRoute

setDeadReckoningTimeInterval

setMaxManipulatedCourseAngle

getMaxTurnCompletionOffset

getManeuverZoneRadius

getMediumAlertInterval

getHighAlertInterval

getMinimumMediumAlertDistanceDriving

getMinimumMediumAlertDistanceCycling

getMinimumMediumAlertDistanceWalking

getMinimumHighAlertDistanceDriving

getMinimumHighAlertDistanceCycling

getMinimumHighAlertDistanceWalking

getMaximumDistanceOffRoute

getDeadReckoningTimeInterval

getMaxManipulatedCourseAngle

getUserLocationSnapDistance

setUserLocationSnapDistance

getSecondsBeforeReroute

setSecondsBeforeReroute

setDirectionsProfile

getDirectionsProfile