com.tomtom.sdk.navigation:navigation-engines/com.tomtom.sdk.navigation.guidance/GuidanceEngine

GuidanceEngine

interface GuidanceEngine : AutoCloseable

Responsible for generation of Guidance and LaneGuidance related to upcoming road maneuvers.

Properties

Link copied to clipboard
Link copied to clipboard
abstract var announcementsEnabled: Boolean

Defines whether generation of announcements is enabled.

Link copied to clipboard
abstract val availableLanguages: List<Locale>

Returns a list of languages (represented as Locale) supported by GuidanceEngine.

Functions

Link copied to clipboard
abstract fun generateGuidance(navigationSnapshot: NavigationSnapshot): Guidance

Generates Guidance which might be a new upcoming maneuver or the same with updated distance to next maneuver.

Link copied to clipboard
abstract fun generateLaneGuidance(navigationSnapshot: NavigationSnapshot): LaneGuidanceUpdate?

Generates LaneGuidance. Note: LaneGuidanceUpdate is suppressed (set to null) when none of the lanes are set as recommended.

Inherited functions

Link copied to clipboard
abstract fun close()