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

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

概要

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

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

コードの確認

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

ここで、目的地は最終目的地またはウェイポイントのいずれかを指します。到着を検出するには、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() を呼び出します。リスト内の時間と距離は累積値です。つまり、1 つのウェイポイントから別のウェイポイントまでの時間と距離ではなく、現在の位置から各ウェイポイントまでの時間と距離が表示されます。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);
    }
});

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