navigation:engine/com.tomtom.sdk.navigation/NavigationConfiguration

NavigationConfiguration

data class NavigationConfiguration constructor(val context: Context, val apiKey: String, val locationProvider: LocationProvider, val routeReplanner: RouteReplanner, val mapMatchingEngine: MapMatchingEngine = LegacyMapMatchingEngineFactory.create(context), val horizonEngine: HorizonEngine? = null, val guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createStaticGuidanceEngine( context, GuidanceEngineOptions() ), val routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(context), val routeProgressEngine: RouteProgressEngine = RouteProgressEngineFactory.create(), val routeProjectionEngine: RouteProjectionEngine? = null, val locationContextProviderEngine: LocationContextProviderEngine = LegacyLocationContextProviderEngineFactory.create(context), val arrivalDetectionEngine: ArrivalDetectionEngine = DefaultArrivalDetectionEngineFactory.create(), val routeReplanningEngine: RouteReplanningEngine = RouteReplanningEngineFactory.create(routeReplanner), val replanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(), val continuousReplanningMode: ContinuousReplanningMode = ContinuousReplanningMode.Manual, val deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, val maintainRoutesMode: MaintainRoutesMode = MaintainRoutesMode.ActiveRouteOnly, val apiPath: Uri? = null, val apiKeyParamName: String? = null, val navigationProcessingThrottle: Duration = DEFAULT_LOCATION_UPDATE_THROTTLE, val telemetry: Telemetry? = null)

Configuration of the Navigation SDK.

The Configuration uses Static GuidanceEngine implementation by default. Take a look at GuidanceEngineFactory for different variants/types of GuidanceEngine.

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

Parameters

context

Used to initialize Android dependencies.

apiKey

API key needed for navigation.

locationProvider

Used as default LocationProvider during navigating.

routeReplanner

Used as default RouteReplanner during navigating.

mapMatchingEngine

Used as default MapMatchingEngine during navigating.

horizonEngine

Used as default HorizonEngine during navigating.

guidanceEngine

Used as default GuidanceEngine during navigating.

routeTrackingEngine

Used as default RouteTrackingEngine during navigating.

routeProgressEngine

Used as default RouteProgressEngine during navigating.

routeProjectionEngine

Used as default RouteProjectionEngine during navigating.

locationContextProviderEngine

Used as default LocationContextProviderEngine during navigating.

arrivalDetectionEngine

Used as default ArrivalDetectionEngine during navigating.

routeReplanningEngine

Used as default RouteReplanningEngine during navigating.

replanningRetryPolicy

Used as default ReplanningRetryPolicy during navigating.

continuousReplanningMode

Used as default ContinuousReplanningMode during navigating.

deviationReplanningMode

Defines whether RouteReplanningEngine should try to replan the active RoutePlan after deviation.

maintainRoutesMode

Used as default MaintainRoutesMode during navigation.

apiPath

Path used to download navigation tiles.

apiKeyParamName

Name of the request parameter to use for the key.

navigationProcessingThrottle

Minimal throttle interval in milliseconds to handle location update.

telemetry

Used to send telemetry data. Location update will be ignored when the time difference between location updates is lower than the navigationProcessingThrottle.

Constructors

NavigationConfiguration

fun NavigationConfiguration(context: Context, apiKey: String, locationProvider: LocationProvider, routeReplanner: RouteReplanner, mapMatchingEngine: MapMatchingEngine = LegacyMapMatchingEngineFactory.create(context), horizonEngine: HorizonEngine? = null, guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createStaticGuidanceEngine( context, GuidanceEngineOptions() ), routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(context), routeProgressEngine: RouteProgressEngine = RouteProgressEngineFactory.create(), routeProjectionEngine: RouteProjectionEngine? = null, locationContextProviderEngine: LocationContextProviderEngine = LegacyLocationContextProviderEngineFactory.create(context), arrivalDetectionEngine: ArrivalDetectionEngine = DefaultArrivalDetectionEngineFactory.create(), routeReplanningEngine: RouteReplanningEngine = RouteReplanningEngineFactory.create(routeReplanner), replanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(), continuousReplanningMode: ContinuousReplanningMode = ContinuousReplanningMode.Manual, deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, maintainRoutesMode: MaintainRoutesMode = MaintainRoutesMode.ActiveRouteOnly, apiPath: Uri? = null, apiKeyParamName: String? = null, navigationProcessingThrottle: Duration = DEFAULT_LOCATION_UPDATE_THROTTLE, telemetry: Telemetry? = null)