ナビゲーション イベントをリッスンする

アプリは、ユーザーがルートに沿って移動する際に発生するイベントをリッスンできます。

概要

ナビゲーション イベントをリッスンするには、次のインターフェースを使用します。

  • Navigator.ArrivalListener は、デバイスが目的地に到着したときにトリガーされる onArrival() コールバックを提供します。
  • RoadSnappedLocationProvider.LocationListener は、デバイスの位置情報が変更されたときにトリガーされる onLocationChanged() コールバックを提供します。
  • Navigator.RemainingTimeOrDistanceChangedListener は、次の目的地までの時間または距離が指定された量を超えて変化したときにトリガーされる onRemainingTimeOrDistanceChanged() コールバックを提供します。
  • Navigator.RouteChangedListener は、ルートが変更されたときにトリガーされる onRouteChanged() コールバックを提供します。

コードの確認

目的地への到着を検出する

ここでいう目的地とは、最終目的地または経由地のいずれかを指します。到着を検出するには、Navigator.addArrivalListener() を呼び出します。これにより、デバイスが目的地に到着したときにコールバックが登録されます。

到着すると、Android 向け Navigation SDK は onArrival() コールバックを起動します。このコールバックを使用して、Navigator.stopGuidance() でターンバイターン ガイダンスを停止するか、Navigator.continueToNextDestination() で次の経由地に進むことができます。ナビゲーション セッションに目的地が 1 つしか含まれていない場合、または目的地のリストに目的地が残っていない場合、Navigator.continueToNextDestination() を呼び出すと、ガイダンスが自動的に停止します。

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 も返すようになりました。この列挙型は、heavy、medium、light、unknown のいずれかになります。これは、地図の 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);
    }
});

夜間モードはプログラムで設定することもできます。詳しくは、ナイトモードを設定するをご覧ください。