Navigate a multi-destination route

Follow this guide to plot a route within your app to multiple destinations, also called waypoints, using the Navigation SDK for Android.

Overview

  1. Integrate the Navigation SDK into your app, as described in Set up your project.
  2. Add a SupportNavigationFragment or NavigationView to your app. This UI element adds the interactive map and turn-by-turn navigation UI to your activity.
  3. Use the NavigationApi class to initialize the SDK.

  4. Define a Navigator to control turn-by-turn navigation:

  5. Build and run your app.

See the code

Add a navigation fragment

The SupportNavigationFragment is the UI component that displays the visual output of navigation, including an interactive map and turn-by-turn directions. You can declare the fragment in your XML layout file as shown below:

<?xml version="1.0" encoding="utf-8"?>
<fragment xmlns:android="http://schemas.android.com/apk/res/android"
    android:name="com.google.android.libraries.navigation.SupportNavigationFragment"
    android:id="@+id/navigation_fragment"
    android:layout_width="match_parent"
    android:layout_height="match_parent"/>

Alternatively, you can construct the fragment programmatically, as described in the Android documentation, using FragmentActivity.getSupportFragmentManager().

As an alternative to a fragment, the UI component is also available as a NavigationView. In most cases, we recommend using SupportNavigationFragment, which is a wrapper for NavigationView, instead of interacting directly with NavigationView. For more information, see Navigation map interaction best practices .

Request location permission

Your app must request location permission in order to determine the location of the device.

This tutorial provides the code you need to request fine location permission. For more details, see the guide to Android permissions.

  1. Add the permission as a child of the <manifest> element in your Android manifest:

    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.navsdkmultidestination">
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
</manifest>

  2. Request runtime permissions in your app, giving the user the opportunity to allow or deny location permission. The following code checks whether the user has granted fine location permission. If not, it requests the permission:

    if (ContextCompat.checkSelfPermission(this.getApplicationContext(),
        android.Manifest.permission.ACCESS_FINE_LOCATION)
            == PackageManager.PERMISSION_GRANTED) {
    mLocationPermissionGranted = true;
} else {
    ActivityCompat.requestPermissions(this,
            new String[] { android.Manifest.permission.ACCESS_FINE_LOCATION },
            PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION);
}

if (!mLocationPermissionGranted) {
    displayMessage("Error loading Navigation SDK: "
            + "The user has not granted location permission.", DISPLAY_BOTH);
    return;
}

  3. Override the onRequestPermissionsResult() callback to handle the result of the permission request:

    @Override
public void onRequestPermissionsResult(int requestCode, @NonNull String permissions[],
                                       @NonNull int[] grantResults) {
    mLocationPermissionGranted = false;
    switch (requestCode) {
        case PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION: {
            // If request is canceled, the result arrays are empty.
            if (grantResults.length > 0
                    && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
                mLocationPermissionGranted = true;
            }
        }
    }
}

Initialize the Navigation SDK and configure a journey

The NavigationApi class provides initialization logic that authorizes your app to use Google navigation. The Navigator class provides control over configuring and starting/stopping a navigation journey.

  1. Create a helper method to show a message on screen and in the log.

    private void displayMessage(String errorMessage, String displayMedium) {
    if (displayMedium.equals(DISPLAY_BOTH) || displayMedium.equals(DISPLAY_TOAST)) {
        Toast.makeText(this, errorMessage, Toast.LENGTH_LONG).show();
    }

    if (displayMedium.equals(DISPLAY_BOTH) || displayMedium.equals(DISPLAY_LOG)) {
        Log.d(TAG, errorMessage);
    }
}

  2. Initialize the Navigation SDK and override the onNavigatorReady() callback to start navigation when the navigator is ready:

    NavigationApi.getNavigator(this, new NavigationApi.NavigatorListener() {
            /**
             * Sets up the navigation UI when the navigator is ready for use.
             */
            @Override
            public void onNavigatorReady(Navigator navigator) {
                displayMessage("Navigator ready.", DISPLAY_BOTH);
                mNavigator = navigator;
                mNavFragment = (SupportNavigationFragment) getFragmentManager()
                        .findFragmentById(R.id.navigation_fragment);

                // Set the camera to follow the device location with 'TILTED' driving view.
                mNavFragment.getCamera().followMyLocation(Camera.Perspective.TILTED);

                // Navigate to the specified places.
                navigateToPlaces();
            }

            /**
             * Handles errors from the Navigation SDK.
             * @param errorCode The error code returned by the navigator.
             */
            @Override
            public void onError(@NavigationApi.ErrorCode int errorCode) {
                switch (errorCode) {
                    case NavigationApi.ErrorCode.NOT_AUTHORIZED:
                        displayMessage("Error loading Navigation SDK: Your API key is "
                                + "invalid or not authorized to use the Navigation SDK.",
                                DISPLAY_BOTH);
                        break;
                    case NavigationApi.ErrorCode.TERMS_NOT_ACCEPTED:
                        displayMessage("Error loading Navigation SDK: User did not accept "
                                + "the Navigation Terms of Use.", DISPLAY_BOTH);
                        break;
                    case NavigationApi.ErrorCode.NETWORK_ERROR:
                        displayMessage("Error loading Navigation SDK: Network error.",
                                DISPLAY_BOTH);
                        break;
                    case NavigationApi.ErrorCode.LOCATION_PERMISSION_MISSING:
                        displayMessage("Error loading Navigation SDK: Location permission "
                                + "is missing.", DISPLAY_BOTH);
                        break;
                    default:
                        displayMessage("Error loading Navigation SDK: " + errorCode,
                                DISPLAY_BOTH);
                }
            }
        });

  3. Add a method to create a Waypoint object from a given place ID and title.

    private void createWaypoint(String placeId, String title) {
    try {
        mWaypoints.add(
          Waypoint.builder()
                 .setPlaceIdString(placeId)
                 .setTitle(title)
                 .build()
        );
    } catch (Waypoint.UnsupportedPlaceIdException e) {
        displayMessage("Error starting navigation: Place ID is not supported: " + placeId,
                DISPLAY_BOTH);
    }
}

  4. Add a method to display the calculated travel time and distance to each waypoint.

    private void displayTimesAndDistances() {
    List<TimeAndDistance> timesAndDistances = mNavigator.getTimeAndDistanceList();
    int leg = 1;
    String message = "You're on your way!";
    for (TimeAndDistance timeAndDistance : timesAndDistances) {
        message = message + "\nRoute leg: " + leg++
                + ": Travel time (seconds): " + timeAndDistance.getSeconds()
                + ". Distance (meters): " + timeAndDistance.getMeters();
    }
    displayMessage(message, DISPLAY_BOTH);
}

  5. Set all the waypoints for this journey. (Note that you may receive an error if you use place IDs for which the navigator cannot plot a route. The sample app in this tutorial uses place IDs for waypoints in Australia. See the notes below about getting different place IDs.) After calculating directions, the SupportNavigationFragment displays a polyline representing the route on the map, with a marker at each waypoint.

    private void navigateToPlaces() {

    // Set up a waypoint for each place that we want to go to.
    createWaypoint("ChIJq6qq6jauEmsRJAf7FjrKnXI", "Sydney Star");
    createWaypoint("ChIJ3S-JXmauEmsRUcIaWtf4MzE", "Sydney Opera House");
    createWaypoint("ChIJLwgLFGmuEmsRzpDhHQuyyoU", "Sydney Conservatorium of Music");

    // If this journey is already in progress, no need to restart navigation.
    // This can happen when the user rotates the device, or sends the app to the background.
    if (mSavedInstanceState != null
            && mSavedInstanceState.containsKey(KEY_JOURNEY_IN_PROGRESS)
            && mSavedInstanceState.getInt(KEY_JOURNEY_IN_PROGRESS) == 1) {
        return;
    }

    // Create a future to await the result of the asynchronous navigator task.
    ListenableResultFuture<Navigator.RouteStatus> pendingRoute =
            mNavigator.setDestinations(mWaypoints);

    // Define the action to perform when the SDK has determined the route.
    pendingRoute.setOnResultListener(
            new ListenableResultFuture.OnResultListener<Navigator.RouteStatus>() {
                @Override
                public void onResult(Navigator.RouteStatus code) {
                    switch (code) {
                        case OK:
                            mJourneyInProgress = true;
                            // Hide the toolbar to maximize the navigation UI.
                            if (getActionBar() != null) {
                                getActionBar().hide();
                            }

                            // Register some listeners for navigation events.
                            registerNavigationListeners();

                            // Display the time and distance to each waypoint.
                            displayTimesAndDistances();

                            // Enable voice audio guidance (through the device speaker).
                            mNavigator.setAudioGuidance(
                                    Navigator.AudioGuidance.VOICE_ALERTS_AND_GUIDANCE);

                            // Simulate vehicle progress along the route for demo/debug builds.
                            if (BuildConfig.DEBUG) {
                                mNavigator.getSimulator().simulateLocationsAlongExistingRoute(
                                        new SimulationOptions().speedMultiplier(5));
                            }

                            // Start turn-by-turn guidance along the current route.
                            mNavigator.startGuidance();
                            break;
                        // Handle error conditions returned by the navigator.
                        case NO_ROUTE_FOUND:
                            displayMessage("Error starting navigation: No route found.",
                                    DISPLAY_BOTH);
                            break;
                        case NETWORK_ERROR:
                            displayMessage("Error starting navigation: Network error.",
                                    DISPLAY_BOTH);
                            break;
                        case ROUTE_CANCELED:
                            displayMessage("Error starting navigation: Route canceled.",
                                    DISPLAY_BOTH);
                            break;
                        default:
                            displayMessage("Error starting navigation: "
                                    + String.valueOf(code), DISPLAY_BOTH);
                    }
                }
            });
}

Build and run your app

  1. Connect an Android device to your computer. Follow the instructions to enable developer options on your Android device and configure your system to detect the device. (Alternatively, you can use the Android Virtual Device (AVD) Manager to configure a virtual device. When choosing an emulator, make sure you pick an image that includes the Google APIs.)
  2. In Android Studio, click the Run menu option (or the play button icon). Choose a device as prompted.

Hints for improved user experience

  • The user must accept the Google Navigation Terms of Service before navigation becomes available. This acceptance is only required once. By default, the SDK prompts for acceptance the first time the navigator is invoked. If you prefer, you can trigger the Navigation Terms of Service dialog at an early point in your app's UX flow, such as during signup or login, using showTermsAndConditionsDialog().
  • Navigation quality and ETA accuracy are significantly improved if you use place IDs to initialize a waypoint, rather than a latitude/longitude destination.

  • This sample derives the waypoints from specific place IDs. Other ways to get a place ID include the following: