com.tomtom.sdk.navigation:navigation-offroad/com.tomtom.sdk.navigation.offroad/Configuration/Configuration

Configuration

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

Basic configuration used to set up Navigation SDK to work in off-road mode.

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

Parameters

context

Initializes Android dependencies.

locationProvider

Informs navigation of location updates.

vehicleProvider

The default VehicleProvider during navigation. 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, locationProvider: LocationProvider, vehicleProvider: VehicleProvider = VehicleProviderFactory.create(), betterProposalAcceptanceMode: BetterProposalAcceptanceMode = BetterProposalAcceptanceMode.Automatic, deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, replanningRetryPolicy: ReplanningRetryPolicy = ReplanningRetryPolicyFactory.create(), routeReplanningEngine: RouteReplanningEngine? = null, guidanceEngine: GuidanceEngine? = null, mapMatchingEngine: MapMatchingEngine? = null, routeTrackingEngine: RouteTrackingEngine? = null, routeProgressEngine: RouteProgressEngine? = null, arrivalDetectionEngine: ArrivalDetectionEngine? = null)

Advanced configuration used to set up Navigation SDK to work in off-road mode.

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

Parameters

context

Initializes Android dependencies.

locationProvider

Informs navigation of location updates.

vehicleProvider

The default VehicleProvider during navigation. 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 OffRoadRouteReplannerFactory.create

guidanceEngine

Engine responsible for generating guidance instructions of the upcoming road maneuvers. If it's not provided, an instance created by OffRoadGuidanceEngineFactory.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 OffRoadMapMatchingEngineFactory.create is used.

routeTrackingEngine

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

routeProgressEngine

Engine responsible for determining the progress made along the current route. If it's not provided, an instance created by OffRoadRouteProgressEngineFactory.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 OffRoadArrivalDetectionEngineFactory.create is used.