setActiveRoutePlan

abstract fun setActiveRoutePlan(routePlan: RoutePlan)

Sets a provided routePlan as active. If the navigation has been successfully started with an active route plan, then this method will replace it with the provided one. If the navigation has been started without an active route plan, then this method will start navigating on the provided one.

If the NavigationStateChangedListener is registered, it is notified with the NavigationState.ActiveGuidance state only if the navigation is currently in the free NavigationState.FreeDriving.

Note that the initial instances of navigation engines will be used in the new navigation session.

Parameters

routePlan

A route plan to be set as active.

Throws

if vehicle used for navigation is incompatible with the given route plan.