NavigationService

Navigation service. It provides the support for navigation.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

Link copied to clipboard

Intermediate waypoint drop recommended parameters

Link copied to clipboard

Maximum simulation speed multiplier

Link copied to clipboard

Minimum simulation speed multiplier

Link copied to clipboard

Data transfer statistics for this service.

Functions

Link copied to clipboard
external fun cancelNavigation(navigationListener: NavigationListener? = null)

Cancel the active navigation. This method cancels the active navigation. If a route calculation is in progress then the registered ProgressListener will be signaled first with ProgressListener.notifyComplete with GemError.Cancel as input and then the NavigationListener.onNavigationError with GemError.Cancel as input.

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
external fun getBetterRouteTimeDistanceToFork(navigationListener: NavigationListener? = null): TimeDistance?

Get better route time-distance until it forks the navigation route

Link copied to clipboard
external fun getDataSource(navigationListener: NavigationListener): DataSource?

Gets access to navigation data source

Link copied to clipboard
external fun getNavigationInstruction(navigationListener: NavigationListener? = null): NavigationInstruction?

Get the current navigation instruction

Link copied to clipboard
external fun getNavigationRoute(navigationListener: NavigationListener? = null): Route?

Get the current route used for navigation. When the NavigationListener.onRouteUpdated notification is received the API user should request the new route using this method( if this is needed).

Link copied to clipboard
fun getTurnId32(turnDetails: TurnDetails): ETurnId32

Get navigation turn id inside ETurnId32 enumeration

Link copied to clipboard
fun getTurnId64(turnDetails: TurnDetails): ETurnId64

Get navigation turn id inside ETurnId64 enumeration

Link copied to clipboard
external fun isNavigationActive(navigationListener: NavigationListener? = null): Boolean

Check if there is an active navigation in progress.

Link copied to clipboard

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

Link copied to clipboard
external fun isSimulationActive(navigationListener: NavigationListener? = null): Boolean

Check if there is an active simulation in progress.

Link copied to clipboard
external fun isTripActive(navigationListener: NavigationListener? = null): Boolean

Check if there is an active trip ( navigation or simulation ) in progress.

Link copied to clipboard
operator fun not(): Boolean

Checks if this object is valid.

Link copied to clipboard
fun release()

Releases the native referenced value of this object if:

Link copied to clipboard
external fun setNavigationRoadBlock(length: Int, startLink: Int = -1, navigationListener: NavigationListener? = null)

Set a roadblock on the current route having the length specified in meters starting from the current GPS position.

Link copied to clipboard
fun startNavigation(destination: Landmark, navigationListener: NavigationListener, progressListener: ProgressListener, routePreferences: RoutePreferences? = null, positionSource: DataSource? = null): Int
external fun startNavigation(waypoints: LandmarkList, navigationListener: NavigationListener, progressListener: ProgressListener, routePreferences: RoutePreferences? = null, positionSource: DataSource? = null): Int

Start a new navigation.

Link copied to clipboard
external fun startNavigationWithRoute(route: Route, navigationListener: NavigationListener, progressListener: ProgressListener, positionSource: DataSource? = null): Int

Start a new navigation.

Link copied to clipboard
external fun startSimulation(waypoints: LandmarkList, navigationListener: NavigationListener, progressListener: ProgressListener, routePreferences: RoutePreferences? = null, speedMultiplier: Float = 1.0f): Int

Start a new navigation.

Link copied to clipboard
external fun startSimulationWithRoute(route: Route, navigationListener: NavigationListener, progressListener: ProgressListener, speedMultiplier: Float = 1.0f): Int

Start a new navigation.

Link copied to clipboard
external fun updateNavigationSound(navigationListener: NavigationListener? = null)

Request to the navigation service to send the updated sound to the navigation listener. The navigation service will call the NavigationListener.onNavigationSound callback with the updated sound.