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

Package-level declarations

GuidanceEngine: Engine responsible for generating guidance and lane guidance related to upcoming road maneuvers. Returns Guidance and LaneGuidanceUpdate.

Types

Specifies the verbosity of guidance announcements. More verbose levels will result in more announcements, with more details.

AnnouncementType

@JvmInline

value class AnnouncementType

Represents different guidance announcement types, which are used to prepare the driver for the maneuver.

Guidance

data class Guidance(val instructions: List<GuidanceInstruction>, val announcement: GuidanceAnnouncement?, val distanceToManeuver: Distance, val currentPhase: InstructionPhase, val shouldPlay: Boolean = false)

Guidance update provided while navigating a route, including the list of upcoming instructions, guidance announcement and distance to the next maneuver.

GuidanceAnnouncement

class GuidanceAnnouncement(val id: UniqueId = UniqueId(), val language: Locale, val announcementType: AnnouncementType, val ssmlMessage: String)

Guidance announcement relating to a maneuver during navigation. The announcement text message is provided in both Speech Synthesis Markup Language (SSML) and plain-text formats.

GuidanceEngine

interface GuidanceEngine : AutoCloseable

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

LaneGuidance

data class LaneGuidance(val lanes: List<Lane>, val laneSeparators: List<LaneSeparator>, val routeOffset: Distance, val length: Distance)

Contains information about lane guidance.

LaneGuidanceUpdate

data class LaneGuidanceUpdate(val laneGuidance: LaneGuidance, val type: LaneGuidanceUpdateType)

Holds information about LaneGuidance and whether it is starting or ending.

LaneGuidanceUpdateType

@JvmInline

value class LaneGuidanceUpdateType

Type of LaneGuidanceUpdate.