アプリは、ユーザーがルートに沿って移動する際に発生するイベントをリッスンできます。
概要
ナビゲーション イベントをリッスンするには、次のインターフェースを使用します。
コードの確認
ナビゲーション アクティビティの Java コードを表示または非表示にします。
package com.example.navsdkmultidestination;
import android.content.pm.PackageManager;
import android.os.Bundle;
import android.support.v4.app.ActivityCompat;
import android.support.v4.content.ContextCompat;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;
import android.widget.Toast;
import androidx.annotation.NonNull;
import com.google.android.libraries.navigation.ArrivalEvent;
import com.google.android.libraries.navigation.Camera;
import com.google.android.libraries.navigation.ListenableResultFuture;
import com.google.android.libraries.navigation.LocationEvent;
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) 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);
}
}
});
}
/**
* 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(LocationEvent locationEvent) {
displayMessage("onLocationUpdated: Navigation engine has provided a new"
+ " road-snapped location: "
+ locationEvent.getLocation().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 開発者サービスの Location API で Fused Location Provider から返された位置情報とは異なる場合があります。
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
を返すようになりました。この列挙型は、重い、中間の、軽い、または不明のいずれかです。これは、マップ UI の ETA 上に表示される色に対応します(重い = 赤、中 = 黄色、明るい = 緑)。これは、独自の ETA フッターを作成する必要がある場合に役立ちます。
メモリリークを回避するには、リスナーが不要になったときに 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);
}
});