TomTomNavigation
The TomTomNavigation interface serves as the primary interface for controlling the navigation process. It provides a comprehensive set of functionalities for managing and customizing a navigation session.
To manage the lifecycle of a navigation session, the interface offers methods to start and stop navigation. It also provides functionality to set and select active routes.
The interface also includes a range of listeners that allow developers to receive updates on various aspects of the navigation.
In addition to the listeners, the interface enables customization of the navigation experience. Note that by changing these properties in runtime, the navigation initialization configuration is overridden. Users can configure the betterProposalAcceptanceMode, which determines how to handle better route proposals. They can also choose the deviationReplanningMode, which defines whether the navigation automatically replans the route. The unitSystem and preferredLanguage can be customized to provide guidance instructions and announcements in the desired format and language.
Threading: This API isn't thread-safe and it's recommended to make API calls always on the same thread.
Properties
The current BetterProposalAcceptanceMode.
Controls how the route deviations are handled. When the deviation is detected the RouteTrackingStateUpdatedListener provides a RouteTrackingState with a RouteTrackingState.hasDeviated property set to true.
The current language used within TomTomNavigation in guidance instructions and announcement language.
The LocationProvider used by the TomTomNavigation for providing location updates to the navigation.
Provides access to current registered engines and allows updating them.
The current NavigationSnapshot. Can be null when navigation is not yet started or already stopped.
The current NavigationState within TomTomNavigation.
The preferred language to be used within TomTomNavigation in guidance instructions and announcement language.
UnitSystem to be used within TomTomNavigation.
The VehicleProvider used by the TomTomNavigation for providing vehicle updates to the navigation.
Functions
Adds an ActiveRouteChangedListener. The listener is notified of changes to the active route whenever a new active route has been set.
Adds a DestinationArrivalListener. The listener is notified of arrival to the destination whenever ArrivalDetectionEngine successfully detects it.
Adds a GuidanceUpdatedListener. The listener is notified of new Guidance instances, whenever there is a change in location and the GuidanceEngine successfully generates it.
Adds a HorizonUpdatedListener for a specific set of horizon options. The listener is notified of updates to the horizon snapshot and the horizon position that are generated for these options.
Adds a LaneGuidanceUpdatedListener. The listener is notified of new LaneGuidance instances whenever there is a change in location and the GuidanceEngine successfully generates it.
Adds a LanguageChangedListener. The listener is notified of changes to the navigation language.
Adds a LocationContextUpdatedListener. The listener is notified of updates to the location context data.
Adds a LocationMapMatchedListener. The listener is notified of new MapMatchingResult each time a location change occurs and the MapMatchingEngine successfully matches it.
Adds a NavigationStateChangedListener. The listener is notified of changes to the NavigationState.
Adds a ProgressUpdatedListener. The listener is notified of new RouteProgress along the active route each time a location update occurs and the RouteProgressEngine successfully calculates it.
Adds a RouteAddedListener. The listener is notified of a new Route whenever it is added to the navigation session.
Adds a RouteRemovedListener. The listener is notified of a removed Route whenever it is removed from the navigation session.
Adds a RouteTrackingStateUpdatedListener. The listener is notified of updates to the RouteTrackingState.
Adds a RouteUpdatedListener. The listener is notified of successful updates to the Route.
Adds a WaypointArrivalListener. The listener is notified of waypoint arrival or departure whenever ArrivalDetectionEngine successfully detects it.
Marks a departure from the given waypoint independently from ArrivalDetectionEngine.hasArrivedAtWaypoint.
Removes a previously added ActiveRouteChangedListener.
Removes a previously added DestinationArrivalListener.
Removes a previously added GuidanceUpdatedListener.
Removes a previously added HorizonUpdatedListener.
Removes a previously added LaneGuidanceUpdatedListener.
Removes a previously added LanguageChangedListener.
Removes a previously added LocationContextUpdatedListener.
Removes a previously added LocationMapMatchedListener.
Removes a previously added NavigationStateChangedListener.
Removes a previously added ProgressUpdatedListener.
Removes a previously added RouteAddedListener.
Removes a previously added RouteRemovedListener.
Removes a previously added RouteTrackingStateUpdatedListener.
Removes a previously added RouteUpdatedListener.
Removes a previously added WaypointArrivalListener.
Sets a provided routePlan as active.
Starts navigation without a Route. In this case, navigation just provides a MapMatchingResult and LocationContext. Therefore, navigation interacts only with LocationMapMatchedListener and LocationContextUpdatedListener.
Starts navigation with provided NavigationOptions. Navigation goes through all steps: