Configuration

constructor(context: Context, ndsStore: NdsStore, locationProvider: LocationProvider, routePlanner: RoutePlanner, vehicleProvider: VehicleProvider = VehicleProviderFactory.create(), betterProposalAcceptanceMode: BetterProposalAcceptanceMode = BetterProposalAcceptanceMode.Automatic, deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic)

Basic configuration used to set up Navigation SDK to work in offline mode.

Parameters

context

The application context. Initializes Android dependencies.

ndsStore

The NdsStore object that is used to provide offline map data to the navigation engines.

locationProvider

Informs navigation of location updates.

routePlanner

Used to update the active RoutePlan or to replan after deviation.

vehicleProvider

Enables navigation to listen to the changes of the vehicle state. Information from VehicleProvider.vehicle is leveraged by the HorizonEngine to provide the relevant virtual horizon. Additionally, it is used as a request parameter for route replannings during the navigation session. Notably, it supersedes any vehicle information specified in the RoutePlan.routePlanningOptions whether at the navigation start, or during any subsequent automatic or manual route replanning events. If it's not provided, an instance created by VehicleProviderFactory.create is used.

betterProposalAcceptanceMode

Specifies how better route proposals are applied during navigation. If it's not provided, the mode is set to BetterProposalAcceptanceMode.Automatic.

deviationReplanningMode

Defines whether navigation should try to replan the active RoutePlan after deviation. If it's not provided, the deviation replanning mode is set to DeviationReplanningMode.Automatic.


constructor(context: Context, ndsStore: NdsStore, ndsMapUpdater: NdsMapUpdater? = null, locationProvider: LocationProvider, routePlanner: RoutePlanner? = null, vehicleProvider: VehicleProvider = VehicleProviderFactory.create(), betterProposalAcceptanceMode: BetterProposalAcceptanceMode = BetterProposalAcceptanceMode.Automatic, deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, replanningRetryPolicy: ReplanningRetryPolicy = ReplanningRetryPolicyFactory.create(), routeReplanningEngine: RouteReplanningEngine? = null, dataStoreMaintenanceEngine: DataStoreMaintenanceEngine? = null, guidanceEngine: GuidanceEngine? = null, horizonEngine: HorizonEngine? = null, mapMatchingEngine: MapMatchingEngine? = null, routeTrackingEngine: RouteTrackingEngine? = null, routeProgressEngine: RouteProgressEngine? = null, arrivalDetectionEngine: ArrivalDetectionEngine? = null, safetyLocationsConfiguration: SafetyLocationsConfiguration? = null, hazardsConfiguration: HazardsConfiguration? = null, traffic: Traffic? = null)

Advanced configuration used to set up Navigation SDK to work in offline mode.

At least one of the following properties must be specified:

  • routePlanner

  • routeReplanningEngine

Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

context

The application context. Initializes Android dependencies.

ndsStore

The NdsStore object that is used to provide offline map data to the navigation engines.

ndsStoreUpdater

The NdsMapUpdater implementation that will update the given NdsStore with the areas of interest (for example: current position) that navigation provides.

locationProvider

Informs navigation of location updates.

routePlanner

Used by RouteReplanningEngine to update the active RoutePlan or to replan after a deviation. If a custom RouteReplanningEngine is specified in the configuration, this parameter will be ignored.

vehicleProvider

Enables navigation to listen to the changes of the vehicle state. Information from VehicleProvider.vehicle is leveraged by the HorizonEngine to provide the relevant virtual horizon. Additionally, it is used as a request parameter for route replannings during the navigation session. Notably, it supersedes any vehicle information specified in the RoutePlan.routePlanningOptions whether at the navigation start, or during any subsequent automatic or manual route replanning events. If it's not provided, an instance created by VehicleProviderFactory.create is used.

betterProposalAcceptanceMode

Specifies how better route proposals are applied during navigation. If it's not provided, the mode is set to BetterProposalAcceptanceMode.Automatic.

deviationReplanningMode

Defines whether navigation should try to replan the active RoutePlan after deviation. If it's not provided, the deviation replanning mode is set to DeviationReplanningMode.Automatic.

replanningRetryPolicy

Specifies how to handle requests which failed during replanning of a Route. If it's not provided, an instance of ReplanningRetryPolicyFactory.create is used.

routeReplanningEngine

Engine responsible for replanning a route during navigation. If it's not provided, an instance of RouteReplanningEngineFactory.create is used, with RouteReplanner created from OfflineRouteReplannerFactory.create.

dataStoreMaintenanceEngine

Engine responsible for instantiating updates of the data store. If it's not provided, an instance created by DataStoreMaintenanceEngineFactory.create is used.

guidanceEngine

Engine responsible for generating guidance instructions of the upcoming road maneuvers. If it's not provided, an instance created by GuidanceEngineFactory.createDynamicGuidanceEngine is used.

horizonEngine

Engine responsible for providing location context data extending beyond the driver's visible horizon. If it's not provided, an instance created by OfflineHorizonEngineFactory.create is used.

mapMatchingEngine

Engine responsible for improving position accuracy by attempting to match it to the map or the route. If it's not provided, an instance created by OfflineMapMatchingEngineFactory.create is used.

routeTrackingEngine

Engine responsible for detecting whether the routes are being followed. If it's not provided, an instance created by RouteTrackingEngineFactory.create is used.

routeProgressEngine

Engine responsible for determining the progress made along the current route. If it's not provided, an instance created by RouteProgressEngineFactory.create is used.

arrivalDetectionEngine

Engine responsible for deciding if the route's destination has been reached. If it's not provided, an instance created by DefaultArrivalDetectionEngineFactory.create is used.

safetyLocationsConfiguration

Configuration parameters for safety location data sources. If no configuration is specified, the horizon will not contain any safety location elements. If a custom HorizonEngine is specified in the configuration, this parameter will be ignored.

hazardsConfiguration

Configuration parameters for hazard data sources. If no configuration is specified, the horizon will not contain any hazard elements. If a custom HorizonEngine is specified in the configuration, this parameter will be ignored.

traffic

Traffic Data Provider. If no traffic is specified, the horizon will not contain any traffic events. If a custom HorizonEngine is specified in the configuration, this parameter will be ignored.

Throws

If neither routePlanner nor routeReplanningEngine is specified.