the base path to the audio files. Works with audioFilesFolderRelativePath. If not specified (null), default value will be used with Core.getInstance().getExternalScopedStoragePath()

audioFilesFolderRelativePath

var audioFilesFolderRelativePath: String

the relative path (from the audioFilesBasePath) to the folder containing all audio files folders (one for each language)

betterRouteListeners

open override val betterRouteListeners: ArrayList<BetterRouteListener>

Better route with traffic observable methods

currentRoute

var currentRoute: Route?

the Route used for the current guidance. Its value will only change when startSession will be called, or when re-route events occur during a session of type SessionState.GUIDANCE

currentRouteListeners

open override val currentRouteListeners: ArrayList<CurrentRouteListener>

Current route updates observable methods

instructionsListeners

open override val instructionsListeners: ArrayList<InstructionsListener>

Instructions observable methods

isSafetyCameraAlertsEnabled

var isSafetyCameraAlertsEnabled: Boolean

Enable or disable safety camera alerts, or get the current value.

language

var language: Locale

an US-ASCII string that defines an ISO 639-1 (2-letter) language code that defines the language used for guidance's instructions (Text-to-Speech and Audio files). Default value is "en".

mapView

var mapView: MapView?

the MapView attached to this Navigation

metric

var metric: Boolean

If true the navigation will use metric unit system (default). Otherwise, if false, it'll use imperial unit system.

navigationErrorListeners

open override val navigationErrorListeners: ArrayList<NavigationErrorListener>

Navigation error observable methods

navigationIconPath

lateinit var navigationIconPath: String

the absolute path to the icon path used for vehicle icon during navigation. If not specified (null), default value will be used with Core.getInstance().getExternalScopedStoragePath() and navigation_icon_default_name res.

navigationProgressListeners

open override val navigationProgressListeners: ArrayList<NavigationProgressListener>

NavigationProgress observable methods

reroutingListeners

open override val reroutingListeners: ArrayList<ReroutingListener>

Re-routing observable methods

safetyCameraAlertListeners

open override val safetyCameraAlertListeners: ArrayList<SafetyCameraAlertListener>

Safety Alerts observable methods

speedLimitListeners

open override val speedLimitListeners: ArrayList<SpeedLimitListener>

SpeedLimit observable methods

ttsMode

var ttsMode: Boolean

indicates if the guidance's instructions will be played using Text-to-Speech. Default value if true. If set to false, audio files will be used instead (using resources deployed from the assets).

ttsWithRoadName

var ttsWithRoadName: Boolean

If true TTS instructions will include the road name

zoomLevel2D

var zoomLevel2D: Double

zoom level applied in NavigationMapViewMode.GUIDANCE_VIEW_2D and NavigationMapViewMode.GUIDANCE_VIEW_NORTH

zoomLevel3D

var zoomLevel3D: Double

zoom level applied in NavigationMapViewMode.GUIDANCE_VIEW_3D

Functions

addAlertListener

open override fun addAlertListener(listener: AlertListener)

addArrivalListener

open override fun addArrivalListener(listener: ArrivalListener)

addBetterRouteListener

open override fun addBetterRouteListener(listener: BetterRouteListener)

addCurrentRouteListener

open override fun addCurrentRouteListener(listener: CurrentRouteListener)

addEVAlertingListener

open override fun addEVAlertingListener(listener: EVAlertingListener)

addInstructionsListener

open override fun addInstructionsListener(listener: InstructionsListener)

addNavigationErrorListener

open override fun addNavigationErrorListener(listener: NavigationErrorListener)

addNavigationProgressListener

open override fun addNavigationProgressListener(listener: NavigationProgressListener)

addReroutingListener

open override fun addReroutingListener(listener: ReroutingListener)

addSafetyCameraAlertListener

open override fun addSafetyCameraAlertListener(listener: SafetyCameraAlertListener)

addSpeedLimitListener

open override fun addSpeedLimitListener(listener: SpeedLimitListener)

attachMapView

fun attachMapView(mapView: MapView, verticalVehiclePos: Double = 0.23): Error?

Attach a MapView to the navigation

changeLocationDataSource

fun changeLocationDataSource(loc: LocationDataSource): Error?

Changes the location data source for the navigation engine. Before calling this method, make sure that the navigation session is stopped.

detachMapView

fun detachMapView(): Error?

Detach the current attached MapView

getNavigationMapViewMode

fun getNavigationMapViewMode(): NavigationMapViewMode?

Get the navigation view mode of the current attached MapView

getSessionState

fun getSessionState(): SessionState

Returns the current session state

hidePassedRoute

fun hidePassedRoute(appContext: Context, hide: Boolean)

Determines if route display should hide the route section between start and current vehicle's position (default is false).

initLocationDataSource

fun initLocationDataSource(loc: LocationDataSource): Error?

Initializes the location data source for the navigation engine. You can use isInit to check if engine is initialized with a LocationDataSource

isInit

fun isInit(): Boolean

Returns true if the Navigation engine has been successfully initialized with a LocationDataSource using initLocationDataSource

isTTSAvailable

fun isTTSAvailable(appContext: Context): Boolean

muteAudio

fun muteAudio()

Mute the vocal instruction without stopping it

notifyOnCircuitNavigationProgressChangedListeners

fun notifyOnCircuitNavigationProgressChangedListeners(navigationProgress: TrackingProgress, percent: Double, state: Int)

notifyOnNavigationProgressChangedListeners

fun notifyOnNavigationProgressChangedListeners(navigationProgress: TrackingProgress)

onCreate

open override fun onCreate(owner: LifecycleOwner)

onDestroy

open override fun onDestroy(owner: LifecycleOwner)

onMapDestroyed

open override fun onMapDestroyed()

Called when the attached MapView is destroyed.

onNewInstruction

open fun onNewInstruction(instruction: String, maneuver: Bitmap?, chainedManeuver: Bitmap?, signpost: Bitmap?, laneInfo: Bitmap?)

Notifies when a new instruction is available during guidance. It provides the instruction's text, the maneuver icon for the instruction, the chained maneuvers icon if any, the signpost icon if any, and the lane info icon if any.

onNewTextInstruction

open override fun onNewTextInstruction(instruction: String)

Notifies when a new text instruction is available during guidance.

onNewVocalInstruction

open override fun onNewVocalInstruction(instruction: String, type: AudioType)

Instructions callback

onPause

open override fun onPause(owner: LifecycleOwner)

onResume

open override fun onResume(owner: LifecycleOwner)

onStart

open override fun onStart(owner: LifecycleOwner)

onStop

open override fun onStop(owner: LifecycleOwner)

removeAlertListener

open override fun removeAlertListener(listener: AlertListener)

removeAllAlertListeners

open override fun removeAllAlertListeners()

removeAllArrivalListeners

open override fun removeAllArrivalListeners()

removeAllBetterRouteListeners

open override fun removeAllBetterRouteListeners()

removeAllCurrentRouteListeners

open override fun removeAllCurrentRouteListeners()

removeAllEVAlertingListeners

open override fun removeAllEVAlertingListeners()

removeAllInstructionsListeners

open override fun removeAllInstructionsListeners()

removeAllNavigationErrorListeners

open override fun removeAllNavigationErrorListeners()

removeAllNavigationProgressListeners

open override fun removeAllNavigationProgressListeners()

removeAllReroutingListeners

open override fun removeAllReroutingListeners()

removeAllSafetyCameraAlertListeners

open override fun removeAllSafetyCameraAlertListeners()

removeAllSpeedLimitListeners

open override fun removeAllSpeedLimitListeners()

removeArrivalListener

open override fun removeArrivalListener(listener: ArrivalListener)

removeBetterRouteListener

open override fun removeBetterRouteListener(listener: BetterRouteListener)

removeCurrentRouteListener

open override fun removeCurrentRouteListener(listener: CurrentRouteListener)

removeEVAlertingListener

open override fun removeEVAlertingListener(listener: EVAlertingListener)

removeInstructionsListener

open override fun removeInstructionsListener(listener: InstructionsListener)

removeNavigationErrorListener

open override fun removeNavigationErrorListener(listener: NavigationErrorListener)

removeNavigationProgressListener

open override fun removeNavigationProgressListener(listener: NavigationProgressListener)

removeReroutingListener

open override fun removeReroutingListener(listener: ReroutingListener)

removeSafetyCameraAlertListener

open override fun removeSafetyCameraAlertListener(listener: SafetyCameraAlertListener)

removeSpeedLimitListener

open override fun removeSpeedLimitListener(listener: SpeedLimitListener)

reroute

fun reroute(length: Int = 0, offset: Int = 0, findCharges: Boolean = false)

Forces rerouting (for guidance mode only): Recomputes route after blocking road segments of current route starting from next intersection and within a given length. Call this method during guidance process if you wish to force rerouting

resume

fun resume(): Boolean

This method resumes the navigation thread. After a successful call to suspend, the navigation thread remains suspended until this method is called.

setMaxRouteLengthDisplay

fun setMaxRouteLengthDisplay(appContext: Context, length: Int)

This option defines the maximum length (in meters) of the route to be displayed.

setNavigationMapViewMode

fun setNavigationMapViewMode(viewMode: NavigationMapViewMode)

Sets the navigation view mode of the current attached MapView It should be called after Navigation.attachMapView

setRemotePlanner

fun setRemotePlanner(remotePlanner: RemotePlannerProxy?)

Set the remote planner proxy.

setRemotePlannerOptions

fun setRemotePlannerOptions(allowLocalRerouting: Boolean = false, checkForBetterRoutePeriod: Long = 300, minDurationForBetterRoute: Long = 300, minDistanceForBetterRoute: Long = 2000): Boolean

Set the remote planner options.

setRouteWaypointsVisibility

fun setRouteWaypointsVisibility(appContext: Context, isVisible: Boolean)

Shows or hides route waypoints. It has to be called before starting a guidance session.

setStartUTurnThreshold

fun setStartUTurnThreshold(appContext: Context, startUTurnThreshold: Int)

This option determines, at start point or any via point for which an avoid UTurn restriction is set, the threshold of the difference of ETA between avoiding a UTurn or not, above which UTurn is allowed.

setVehicleHorizontalPosition

fun setVehicleHorizontalPosition(horizontalVehiclePos: Double = 0.5): Boolean

Sets the horizontal position of the vehicle symbol on the attached MapView. The position is defined as a percentage of the MapView width, where 0.5 represents the center. Values less than 0.5 shift the vehicle to the left, values greater than 0.5 shift it to the right.

setVehicleResource

fun setVehicleResource(imageFile: File?)

Set path to the vehicle resource that'll be drawn by the navigation directly The vehicle will be drawn only when StartSession is called

setVehicleVerticalPosition

fun setVehicleVerticalPosition(verticalVehiclePos: Double = 0.23): Boolean

Sets the vertical position of the vehicle symbol on the attached MapView. The position is defined as a percentage of the MapView height, measured from the bottom of the screen.

startSession

fun startSession(appContext: Context? = null, notificationContent: ForegroundNotificationContent? = null, route: Route? = currentRoute, instructionsIconsStyles: InstructionsIconsStyles? = null): Error?

Starts a navigation session with the passed route

stopAudio

fun stopAudio()

Stops the current vocal instruction

stopForegroundNotification

fun stopForegroundNotification(appContext: Context)

Stops the foreground notification if its running

stopSession

open fun stopSession(appContext: Context? = null): Error?

Stops the current session.

suspend

fun suspend(inMaxTime: Long = 2000): Boolean

This method attempts to suspend the navigation thread in order to keep the current navigation position data which contains among other information pointers on current position, route and route sheet.

unMuteAudio

fun unMuteAudio()

Unmute the vocal instruction

updateRouteOptions

fun updateRouteOptions(routeOptions: RouteOptions): Error?

Updates the current route options for the currentRoute. A re-route will occur and the currentRoute will be updated during a guidance. If this method is called when the navigation is not in guidance, it will return an error.

updateVehicleProfile

fun updateVehicleProfile(profile: Profile): Error?

Updates the current vehicle profile for the currentRoute. A re-route will occur and the currentRoute will be updated during a guidance. If this method is called when the navigation is not in guidance, it will return an error.

updateVehicleStatus

fun updateVehicleStatus(vehicleStatus: VehicleStatus): Error?

Updates the vehicle status for the navigation