アプリは、ユーザーがルートをナビゲートする際に発生するイベントをリッスンできます。
概要
次のインターフェースを使用して、ナビゲーション イベントをリッスンします。
Navigator.ArrivalListenerは、デバイスが目的地に到達したときにトリガーされるonArrival()コールバックを提供します。RoadSnappedLocationProvider.LocationListenerは、デバイスの位置情報が変更されたときにトリガーされるonLocationChanged()コールバックを提供します。Navigator.RemainingTimeOrDistanceChangedListenerはonRemainingTimeOrDistanceChanged()コールバックを提供します。これは、次の目的地までの時間または距離が指定された量を超えて変化したときにトリガーされます。Navigator.RouteChangedListenerは、ルートの変更時にトリガーされるonRouteChanged()コールバックを提供します。
コードの確認
ナビゲーション アクティビティの Java コードを表示または非表示にする
package com.example.navsdkmultidestination; import android.content.pm.PackageManager; import android.location.Location; import android.os.Bundle; import android.util.Log; import android.widget.Toast; import androidx.annotation.NonNull; import androidx.appcompat.app.AppCompatActivity; import androidx.core.app.ActivityCompat; import androidx.core.content.ContextCompat; import com.google.android.gms.maps.GoogleMap.CameraPerspective; import com.google.android.libraries.navigation.ArrivalEvent; import com.google.android.libraries.navigation.ListenableResultFuture; import com.google.android.libraries.navigation.NavigationApi; import com.google.android.libraries.navigation.Navigator; import com.google.android.libraries.navigation.RoadSnappedLocationProvider; import com.google.android.libraries.navigation.SimulationOptions; import com.google.android.libraries.navigation.SupportNavigationFragment; import com.google.android.libraries.navigation.TimeAndDistance; import com.google.android.libraries.navigation.Waypoint; import java.util.ArrayList; import java.util.List; /** * An activity that displays a map and a navigation UI, guiding the user from their current location * to multiple destinations, also known as waypoints. */ public class NavigationActivityMultiDestination extends AppCompatActivity { private static final String TAG = NavigationActivityMultiDestination.class.getSimpleName(); private static final String DISPLAY_BOTH = "both"; private static final String DISPLAY_TOAST = "toast"; private static final String DISPLAY_LOG = "log"; private Navigator mNavigator; private RoadSnappedLocationProvider mRoadSnappedLocationProvider; private SupportNavigationFragment mNavFragment; private final List<Waypoint> mWaypoints = new ArrayList<>(); private Navigator.ArrivalListener mArrivalListener; private Navigator.RouteChangedListener mRouteChangedListener; private Navigator.RemainingTimeOrDistanceChangedListener mRemainingTimeOrDistanceChangedListener; private RoadSnappedLocationProvider.LocationListener mLocationListener; private Bundle mSavedInstanceState; private static final String KEY_JOURNEY_IN_PROGRESS = "journey_in_progress"; private boolean mJourneyInProgress = false; // Set fields for requesting location permission. private static final int PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION = 1; private boolean mLocationPermissionGranted; /** * Sets up the navigator when the activity is created. * * @param savedInstanceState The activity state bundle. */ @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // Save the navigator state, used to determine whether a journey is in progress. mSavedInstanceState = savedInstanceState; if (mSavedInstanceState != null && mSavedInstanceState.containsKey(KEY_JOURNEY_IN_PROGRESS)) { mJourneyInProgress = (mSavedInstanceState.getInt(KEY_JOURNEY_IN_PROGRESS) != 0); } setContentView(R.layout.activity_main); // Initialize the Navigation SDK. initializeNavigationSdk(); } /** Releases navigation listeners when the activity is destroyed. */ @Override protected void onDestroy() { super.onDestroy(); if ((mJourneyInProgress) && (this.isFinishing())) { mNavigator.removeArrivalListener(mArrivalListener); mNavigator.removeRouteChangedListener(mRouteChangedListener); mNavigator.removeRemainingTimeOrDistanceChangedListener( mRemainingTimeOrDistanceChangedListener); if (mRoadSnappedLocationProvider != null) { mRoadSnappedLocationProvider.removeLocationListener(mLocationListener); } displayMessage("OnDestroy: Released navigation listeners.", DISPLAY_LOG); } } /** Saves the state of the app when the activity is paused. */ @Override protected void onSaveInstanceState(Bundle outState) { super.onSaveInstanceState(outState); if (mJourneyInProgress) { outState.putInt(KEY_JOURNEY_IN_PROGRESS, 1); } else { outState.putInt(KEY_JOURNEY_IN_PROGRESS, 0); } } /** * Starts the Navigation SDK and sets the camera to follow the device's location. Calls the * navigateToPlaces() method when the navigator is ready. */ private void initializeNavigationSdk() { /* * Request location permission, so that we can get the location of the * device. The result of the permission request is handled by a callback, * onRequestPermissionsResult. */ 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; } // Get a navigator. 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) getSupportFragmentManager().findFragmentById(R.id.navigation_fragment); // Set the camera to follow the device location with 'TILTED' driving view. mNavFragment.getMapAsync( googleMap -> googleMap.followMyLocation(CameraPerspective.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); } } }); } /** Requests directions from the user's current location to a list of waypoints. */ 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); } } }); } /** * Creates a waypoint from a given place ID and title. * * @param placeId The ID of the place to be converted to a waypoint. * @param title A descriptive title for the waypoint. */ 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); } } /** Displays 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); } /** * Registers some event listeners to show a message and take other necessary steps when specific * navigation events occur. */ private void registerNavigationListeners() { mArrivalListener = new Navigator.ArrivalListener() { @Override public void onArrival(ArrivalEvent arrivalEvent) { displayMessage( "onArrival: You've arrived at a waypoint: " + mNavigator.getCurrentRouteSegment().getDestinationWaypoint().getTitle(), DISPLAY_BOTH); // Start turn-by-turn guidance for the next leg of the route. if (arrivalEvent.isFinalDestination()) { displayMessage("onArrival: You've arrived at the final destination.", DISPLAY_BOTH); } else { mNavigator.continueToNextDestination(); mNavigator.startGuidance(); } } }; // Listens for arrival at a waypoint. mNavigator.addArrivalListener(mArrivalListener); mRouteChangedListener = new Navigator.RouteChangedListener() { @Override public void onRouteChanged() { displayMessage( "onRouteChanged: The driver's route has changed. Current waypoint: " + mNavigator.getCurrentRouteSegment().getDestinationWaypoint().getTitle(), DISPLAY_LOG); } }; // Listens for changes in the route. mNavigator.addRouteChangedListener(mRouteChangedListener); // Listens for road-snapped location updates. mRoadSnappedLocationProvider = NavigationApi.getRoadSnappedLocationProvider(getApplication()); mLocationListener = new RoadSnappedLocationProvider.LocationListener() { @Override public void onLocationChanged(Location location) { displayMessage( "onLocationUpdated: Navigation engine has provided a new" + " road-snapped location: " + location.toString(), DISPLAY_LOG); } @Override public void onRawLocationUpdate(Location location) { displayMessage( "onLocationUpdated: Navigation engine has provided a new" + " raw location: " + location.toString(), DISPLAY_LOG); } }; if (mRoadSnappedLocationProvider != null) { mRoadSnappedLocationProvider.addLocationListener(mLocationListener); } else { displayMessage("ERROR: Failed to get a location provider", DISPLAY_LOG); } mRemainingTimeOrDistanceChangedListener = new Navigator.RemainingTimeOrDistanceChangedListener() { @Override public void onRemainingTimeOrDistanceChanged() { displayMessage( "onRemainingTimeOrDistanceChanged: Time or distance estimate" + " has changed.", DISPLAY_LOG); } }; // Listens for changes in time or distance. mNavigator.addRemainingTimeOrDistanceChangedListener( 60, 100, mRemainingTimeOrDistanceChangedListener); } /** Handles the result of the request for location permissions. */ @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; } } } } /** * Shows a message on screen and in the log. Used when something goes wrong. * * @param errorMessage The message to display. */ 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); } } }
目的地に到着したことを検出する
ここで、目的地とは最終目的地またはウェイポイントのいずれかを指します。到着を検出するには、Navigator.addArrivalListener() を呼び出します。これにより、デバイスが目的地に到達したときにコールバックが登録されます。
到着すると、Navigation SDK for Android は onArrival() コールバックをトリガーし、ターンバイターン ガイダンスを停止します。次のウェイポイントに進むには Navigator.continueToNextDestination() を明示的に呼び出し、ターンバイターン ナビゲーションを続行するには Navigator.startGuidance() を呼び出す必要があります。
continueToNextDestination() を呼び出すと、ナビゲータは前の目的地に関するすべての情報を破棄します。前のルートセグメントに関する情報を分析する場合は、continueToNextDestination() を呼び出す前にナビゲータから情報を取得する必要があります。
メモリリークを回避するには、リスナーが不要になったときに removeArrivalListener(listener) を呼び出す必要があります。
mNavigator.addArrivalListener(new Navigator.ArrivalListener() {
@Override
public void onArrival(ArrivalEvent arrivalEvent) {
displayMessage("onArrival: You've arrived at a waypoint: "
+ mNavigator.getCurrentRouteSegment().getDestinationWaypoint().getTitle(),
DISPLAY_BOTH);
// Start turn-by-turn guidance for the next leg of the route.
if (arrivalEvent.isFinalDestination()) {
displayMessage("onArrival: You've arrived at the final destination.",
DISPLAY_BOTH);
} else {
mNavigator.continueToNextDestination();
mNavigator.startGuidance();
}
}
});
位置情報の更新データを受信する
NavigationApi から RoadSnappedLocationProvider を取得し、RoadSnappedLocationProvider.addLocationListener() を呼び出して、デバイスの位置情報または向きが変更されたときにコールバックを登録します。この位置情報は道路にスナップされるため、Google Play 開発者サービスの位置情報 API の統合位置情報プロバイダから返される位置情報とは異なる場合があります。
Navigation SDK は、可能な限り頻繁に位置情報を更新します。位置情報の更新が利用可能になると、Navigation SDK は onLocationChanged() コールバックをトリガーします。
道路スナップによる位置情報の更新はナビゲーションとは独立しており、ナビゲーションを停止した後も続行できます。位置情報の更新をサブスクライブすると、バッテリーの消耗、メモリリーク、デバイスの位置情報の不用意な収集が発生する可能性があります（位置情報の更新をバックグラウンドで実行したままにしている場合）。リスナーが不要になったら、RoadSnappedLocationProvider.removeLocationListener を呼び出します。
mRoadSnappedLocationProvider =
NavigationApi.getRoadSnappedLocationProvider(getApplication());
if (mRoadSnappedLocationProvider != null) {
mRoadSnappedLocationProvider.addLocationListener(
new RoadSnappedLocationProvider.LocationListener() {
@Override
public void onLocationChanged(Location location) {
displayMessage("onLocationUpdated: Navigation engine has provided a new"
+ " road-snapped location: "
+ location.toString(),
DISPLAY_LOG);
}
});
} else {
displayMessage("ERROR: Failed to get a location provider", DISPLAY_LOG);
}
時間と距離の更新を受け取る
Navigator.addRemainingTimeOrDistanceChangedListener() を呼び出して、残り時間（秒）または距離（メートル）が指定されたしきい値を超えて変化したときにコールバックを登録します。
時間または距離の変化が指定された量を超えると、Navigation SDK は onRemainingTimeOrDistanceChanged() コールバックをトリガーします。
残り時間と距離を確認するには、Navigator.getTimeAndDistanceList() を呼び出します。リスト内の時間と距離は累積値です。つまり、各ウェイポイント間の時間と距離ではなく、現在の位置から各ウェイポイントまでの時間と距離が表示されます。TimeAndDistance オブジェクトも delaySeverity を返すようになりました。この列挙型は、heavy、medium、light、unknown のいずれかになります。これは、地図 UI の所要時間に表示される色に対応しています（混雑が激しい = 赤、混雑が中程度 = 黄色、混雑が少ない = 緑）。これは、独自の配達予定日フッターを作成する必要がある場合に便利です。
メモリリークを回避するには、リスナーが不要になったときに Navigator.removeRemainingTimeOrDistanceChangedListener(listener) を呼び出す必要があります。
以下のサンプルは、残り時間が 60 秒以上変化した場合、または残りの距離が 100 メートル以上変化した場合にコールバックをリクエストします。
mNavigator.addRemainingTimeOrDistanceChangedListener(60, 100,
new Navigator.RemainingTimeOrDistanceChangedListener() {
@Override
public void onRemainingTimeOrDistanceChanged() {
displayMessage("onRemainingTimeOrDistanceChanged: Time or distance estimate"
+ " has changed.",
DISPLAY_LOG);
}
});
残り時間と距離情報を組み込みディスプレイに表示するには、setEtaCardEnabled() メソッドを使用して、値 TRUE のパラメータを渡します。時間と距離の表示を抑制するには、この値を FALSE に設定します。
getTimeAndDistanceList() メソッドを使用して、複数のウェイポイントの所要時間を公開することもできます。
ルートの更新を受け取る
Navigator.addRouteChangedListener() を呼び出して、ルート変更時のコールバックを登録します。
ルートが変わると、Navigation SDK は onRouteChanged() コールバックを呼び出します。Navigator.getRouteSegments と Navigator.getCurrentRouteSegment() を呼び出して、新しいルートを検索できます。
メモリリークを回避するには、リスナーが不要になったときに removeRouteChangedListener(listener) を呼び出す必要があります。
mNavigator.addRouteChangedListener(new Navigator.RouteChangedListener() {
@Override
public void onRouteChanged() {
displayMessage("onRouteChanged: The driver's route has changed. Current waypoint: "
+ mNavigator.getCurrentRouteSegment().getDestinationWaypoint().getTitle(),
DISPLAY_LOG);
}
});
夜間モードの切り替えを検出する
NavigationView.addOnNightModeChangedListener または SupportNavigationFragment.addOnNightModeChangedListener を呼び出して、夜間モードが変更されたときにコールバックを登録します。
次の例は、ナビゲーション フラグメントで夜間モードの変更をリッスンする方法を示しています。
mNavFragment.addOnNightModeChangedListener(new NavigationView.OnNightModeChangedListener() {
@Override
public void onNightModeChanged(NightModeChangedEvent nightModeChangedEvent) {
displayMessage("Night mode is active: " + nightModeChangedEvent.inNightMode(),
DISPLAY_LOG);
}
});
夜間モードをプログラムで設定することもできます。詳しくは、夜間モードを設定するをご覧ください。