- getAlertUserLevel() - Method in class com.mapbox.services.android.navigation.v5.RouteProgress
-
Get the most recently provided alert level, this can and will only be one of the alert constants.
- getClosestStep(Position, RouteLeg) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Get the closest routeLeg step to the given position.
- getCurrentLeg() - Method in class com.mapbox.services.android.navigation.v5.RouteProgress
-
Provides the current RouteLeg the user is on.
- getCurrentLegProgress() - Method in class com.mapbox.services.android.navigation.v5.RouteProgress
-
Gives a
RouteLegProgress object with information about the particular leg the user is currently on.
- getCurrentStep() - Method in class com.mapbox.services.android.navigation.v5.models.RouteLegProgress
-
Returns the current step the user is traversing along.
- getCurrentStepProgress() - Method in class com.mapbox.services.android.navigation.v5.models.RouteLegProgress
-
Gives a
RouteStepProgress object with information about the particular step the user is currently on.
- getDeadReckoningTimeInterval() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Get the current time interval being used to calculate dead reckoning values.
- getDestination() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Get the current destination Position that will be used for the end of the route.
- getDirectionsProfile() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Get the directions profile which will be used when requesting the route.
- getDistanceRemaining() - Method in class com.mapbox.services.android.navigation.v5.models.RouteLegProgress
-
Provides the duration remaining in seconds till the user reaches the end of the route.
- getDistanceRemaining() - Method in class com.mapbox.services.android.navigation.v5.models.RouteStepProgress
-
Total distance in meters from user to end of step.
- getDistanceRemaining() - Method in class com.mapbox.services.android.navigation.v5.RouteProgress
-
Provides the duration remaining in seconds till the user reaches the end of the route.
- getDistanceToEndOfRoute(Position, DirectionsRoute, String) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Measures from the provided position (typically the user location), to the end of a DirectionsRoute.
- getDistanceToEndOfRoute(Position, DirectionsRoute, int, String) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Measures from the provided position (typically the user location), to the end of a DirectionsRoute.
- getDistanceToNextLeg(Position, RouteLeg, String, int) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Measures the distance from a position to the end of the given RouteLeg.
- getDistanceToNextStep(Position, RouteLeg, int) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Measures the distance from a position to the end of the route step.
- getDistanceToNextStep(Position, RouteLeg, int, String) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Measures the distance from a position to the end of the route step.
- getDistanceToNextStep(Position, RouteLeg, int, String, int) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Measures the distance from a position to the end of the route step.
- getDistanceToStep(Position, RouteLeg, int) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Computes the distance between the position and the closest point in routeLeg step.
- getDistanceTraveled() - Method in class com.mapbox.services.android.navigation.v5.models.RouteLegProgress
-
Total distance traveled in meters along current leg.
- getDistanceTraveled() - Method in class com.mapbox.services.android.navigation.v5.models.RouteStepProgress
-
Returns distance user has traveled along current step in unit meters.
- getDistanceTraveled() - Method in class com.mapbox.services.android.navigation.v5.RouteProgress
-
Total distance traveled in meters along route.
- getDurationRemaining() - Method in class com.mapbox.services.android.navigation.v5.models.RouteLegProgress
-
Provides the duration remaining in seconds till the user reaches the end of the current step.
- getDurationRemaining() - Method in class com.mapbox.services.android.navigation.v5.models.RouteStepProgress
-
Provides the duration remaining in seconds till the user reaches the end of the current step.
- getDurationRemaining() - Method in class com.mapbox.services.android.navigation.v5.RouteProgress
-
Provides the duration remaining in seconds till the user reaches the end of the route.
- getFractionTraveled() - Method in class com.mapbox.services.android.navigation.v5.models.RouteLegProgress
-
Get the fraction traveled along the current leg, this is a float value between 0 and 1 and isn't guaranteed to
reach 1 before the user reaches the next leg (if another leg exist in route).
- getFractionTraveled() - Method in class com.mapbox.services.android.navigation.v5.models.RouteStepProgress
-
Get the fraction traveled along the current step, this is a float value between 0 and 1 and isn't guaranteed to
reach 1 before the user reaches the next step (if another step exist in route).
- getFractionTraveled() - Method in class com.mapbox.services.android.navigation.v5.RouteProgress
-
Get the fraction traveled along the current route, this is a float value between 0 and 1 and isn't guaranteed to
reach 1 before the user reaches the end of the route.
- getGeometryRemainingOnRoute(Position, DirectionsRoute) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Get the remaining route geometry from the position provided to the end of the directions route.
- getGeometryRemainingOnRoute(Position, DirectionsRoute, int) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Get the remaining route geometry from the position provided to the end of the directions route.
- getHighAlertInterval() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- getLegIndex() - Method in class com.mapbox.services.android.navigation.v5.RouteProgress
-
Index representing the current leg.
- getManeuverZoneRadius() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Get the current radius, in meters, the user must enter to count as completing a step.
- getMapboxNavigationOptions() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
- getMaximumDistanceOffRoute() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Get the current required maximum distance in meters a user can travel away from the step geometry before the
OffRouteListener's called.
- getMaxManipulatedCourseAngle() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Get the maximum angle the user puck will be rotated when snapping the user's course to the route line.
- getMaxTurnCompletionOffset() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Get the current set threshold user must be within to count as completing a
LegStep.
- getMediumAlertInterval() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- getMinimumHighAlertDistanceCycling() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- getMinimumHighAlertDistanceDriving() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- getMinimumHighAlertDistanceWalking() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- getMinimumMediumAlertDistanceCycling() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- getMinimumMediumAlertDistanceDriving() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- getMinimumMediumAlertDistanceWalking() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- getOffRouteThresholdKm() - Method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
- getOrigin() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Get the current origin Position that will be used for the beginning of the route.
- getPreviousStep() - Method in class com.mapbox.services.android.navigation.v5.models.RouteLegProgress
-
Get the previous step the user traversed along, if the user is still on the first step, this will return null.
- getRootObject() - Method in class com.mapbox.services.android.navigation.v5.osrm.TextInstructions
-
- getRoute(Position, Position, Callback<DirectionsResponse>) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Request navigation to acquire a route and notify your callback when a response comes in.
- getRoute(Position, Position, Float, Callback<DirectionsResponse>) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Request navigation to acquire a route and notify your callback when a response comes in.
- getRoute() - Method in class com.mapbox.services.android.navigation.v5.RouteProgress
-
Get the route the navigation session is currently using.
- getSecondsBeforeReroute() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
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.
- getService() - Method in class com.mapbox.services.android.navigation.v5.NavigationService.LocalBinder
-
- getSnapToRoute(Position, RouteLeg, int) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Snaps given position to a RouteLeg step.
- getSnapToRoute(Position, RouteLeg, int, int) - Static method in class com.mapbox.services.android.navigation.v5.RouteUtils
-
Snaps given position to a RouteLeg step.
- getStepIndex() - Method in class com.mapbox.services.android.navigation.v5.models.RouteLegProgress
-
Index representing the current step.
- getTokenizedInstructionHook() - Method in class com.mapbox.services.android.navigation.v5.osrm.TextInstructions
-
- getUpComingStep() - Method in class com.mapbox.services.android.navigation.v5.models.RouteLegProgress
-
Get the next/upcoming step immediately after the current step.
- getUserLocationSnapDistance() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Determines the distance the user must stay within for snapping to route to occur.
- getUserOriginBearing() - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
- getVersionObject() - Method in class com.mapbox.services.android.navigation.v5.osrm.TextInstructions
-
- MANEUVER_ZONE_RADIUS - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Radius in meters the user must enter to count as completing a step.
- MapboxNavigation - Class in com.mapbox.services.android.navigation.v5
-
This is an experimental API.
- MapboxNavigation(Context, String) - Constructor for class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Creates a new MapboxNavigation object.
- MapboxNavigation(Context, String, MapboxNavigationOptions) - Constructor for class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Creates a new MapboxNavigation object.
- MapboxNavigationOptions - Class in com.mapbox.services.android.navigation.v5
-
- MapboxNavigationOptions() - Constructor for class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Creates a new MapboxNavigationOptions object.
- MAX_MANIPULATED_COURSE_ANGLE - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Maximum angle the user puck will be rotated when snapping the user's course to the route line.
- MAXIMUM_ALLOWED_DEGREE_OFFSET_FOR_TURN_COMPLETION - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Threshold user must be in within to count as completing a step.
- MAXIMUM_DISTANCE_BEFORE_OFF_ROUTE - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Maximum number of meters the user can travel away from step before the
OffRouteListener's called.
- MEDIUM_ALERT_INTERVAL - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Number of seconds left on step when a `medium` alert is emitted.
- MEDIUM_ALERT_LEVEL - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
- MINIMUM_DISTANCE_FOR_HIGH_ALERT_CYCLING - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Distance in meters for the minimum length of a step for giving a `high` alert.
- MINIMUM_DISTANCE_FOR_HIGH_ALERT_DRIVING - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Distance in meters for the minimum length of a step for giving a `high` alert.
- MINIMUM_DISTANCE_FOR_HIGH_ALERT_WALKING - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Distance in meters for the minimum length of a step for giving a `high` alert.
- MINIMUM_DISTANCE_FOR_MEDIUM_ALERT_CYCLING - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Distance in meters for the minimum length of a step for giving a `medium` alert while cycling.
- MINIMUM_DISTANCE_FOR_MEDIUM_ALERT_DRIVING - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Distance in meters for the minimum length of a step for giving a `medium` alert while driving.
- MINIMUM_DISTANCE_FOR_MEDIUM_ALERT_WALKING - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Distance in meters for the minimum length of a step for giving a `medium` alert while driving.
- SECONDS_BEFORE_REROUTE - Static variable in class com.mapbox.services.android.navigation.v5.NavigationConstants
-
Seconds used before a reroute occurs.
- setAlertLevelChangeListeners(CopyOnWriteArrayList<AlertLevelChangeListener>) - Method in class com.mapbox.services.android.navigation.v5.NavigationService
-
- setDeadReckoningTimeInterval(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
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.
- setDirectionsProfile(String) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Set the directions profile which will be used when requesting the route.
- setHighAlertInterval(int) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- setLocationEngine(LocationEngine) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Before starting a navigationService, it is required to setup a LocationEngine and pass it into your
instance of MapboxNavigation.
- setLocationEngine(LocationEngine) - Method in class com.mapbox.services.android.navigation.v5.NavigationService
-
- setManeuverZoneRadius(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Radius, in meters, the user must enter to count as completing a step.
- setMaximumDistanceOffRoute(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Maximum distance in meters a user can travel away from the step geometry before the
OffRouteListener's called.
- setMaxManipulatedCourseAngle(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Maximum angle the user puck will be rotated when snapping the user's course to the route line.
- setMaxTurnCompletionOffset(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
Set the threshold user must be within to count as completing a
LegStep.
- setMediumAlertInterval(int) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- setMinimumHighAlertDistanceCycling(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- setMinimumHighAlertDistanceDriving(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- setMinimumHighAlertDistanceWalking(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- setMinimumMediumAlertDistanceCycling(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- setMinimumMediumAlertDistanceDriving(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- setMinimumMediumAlertDistanceWalking(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
- setNavigationEventListeners(CopyOnWriteArrayList<NavigationEventListener>) - Method in class com.mapbox.services.android.navigation.v5.NavigationService
-
- setOffRouteListeners(CopyOnWriteArrayList<OffRouteListener>) - Method in class com.mapbox.services.android.navigation.v5.NavigationService
-
- setOptions(MapboxNavigationOptions) - Method in class com.mapbox.services.android.navigation.v5.NavigationService
-
- setProgressChangeListeners(CopyOnWriteArrayList<ProgressChangeListener>) - Method in class com.mapbox.services.android.navigation.v5.NavigationService
-
- setSecondsBeforeReroute(int) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
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.
- setSnapToRoute(boolean) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Disable or enable the snap to route for navigation, by default this is set to enable.
- setSnapToRoute(boolean) - Method in class com.mapbox.services.android.navigation.v5.NavigationService
-
- setTokenizedInstructionHook(TokenizedInstructionHook) - Method in class com.mapbox.services.android.navigation.v5.osrm.TextInstructions
-
- setupNotification(Activity) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Optionally, set up navigation notification using the default builder provided in the SDK.
- setupNotification(Activity) - Method in class com.mapbox.services.android.navigation.v5.NavigationService
-
- setUserLocationSnapDistance(double) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigationOptions
-
set the distance the user must stay within for snapping to route to occur.
- setUserOriginBearing(float) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Optional but recommended parameter that can be used to route a user in the correct orientation they are already
headed in.
- SnapLocation - Class in com.mapbox.services.android.navigation.v5
-
- startNavigation(DirectionsRoute) - Method in class com.mapbox.services.android.navigation.v5.MapboxNavigation
-
Call startNavigation passing in a DirectionsRoute object to begin a navigation session.
- startRoute(DirectionsRoute) - Method in class com.mapbox.services.android.navigation.v5.NavigationService
-
- step() - Method in class com.mapbox.services.android.navigation.v5.models.RouteStepProgress
-
- stepIndex() - Method in class com.mapbox.services.android.navigation.v5.models.RouteLegProgress
-