The Navigation SDK for Android v2 is in public preview. This documentation covers how to install the SDK and use features that are new in v2 like predictive caching.
For more information on fundamental navigation concepts like route generation and tracking route progress, see the documentation for the latest stable version.
For details on how v2 differs from v1 and guidance on migrating from v1 of the Mapbox Navigation SDK for Android to the v2 public preview, see 2.0 Navigation SDK Migration Guide.
The Navigation SDK for Android allows you to build a complete navigation experience with the power of the Mapbox Directions API. You can build a complete turn-by-turn navigation UI inside your application using our pre-built components or use the core logic directly to build something truly custom.
The Navigation SDK provides a collection of features that are critical when building navigation projects, including:
- Navigation routes
- Accurate device location updates
- Voice instruction announcements
- Real-time user progress to their destination
- Off-route detection and rerouting
- Dynamic camera adjustments during turn-by-turn navigation
- Pre-built UI components to show changing navigation information
- Support for navigating with limited or no network connection
The Mapbox Navigation SDK for Android is compatible with applications that are:
- Built using the Android SDK 21 or higher
The Mapbox Navigation SDK for Android is designed to be used with several other Mapbox products.
The Navigation SDK comes with access to the Mapbox Directions API to generate routes between two or more coordinates. The Directions API has many route options like setting a
profile (for example driving, driving with traffic, or walking),
bearing (to influence the direction in which a route will begin), and
exclude (for example, avoiding tolls). Read more about the Directions API in the API documentation.
By default, the Navigation SDK comes with access to the Mapbox Maps SDK for Android. The Navigation SDK uses the Maps SDK to display routes on a map and show the user's location on the map throughout their trip to provide both navigation-related context and nearby places that may be of interest to the driver. The Navigation SDK v2 public preview uses the Maps SDK v10, which is in public beta. Read more in the Maps SDK v10 documentation.
If you use a Mapbox map in your application, you are required to provide attribution according to the Mapbox Maps SDK documentation.
The Mapbox Navigation SDK is distributed under Mapbox's Terms of Service.
Read more about pricing for the Navigation SDK in the pricing guide.