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

Package-level declarations

Types

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

AnnouncementType

value class AnnouncementType

Represents guidance announcement type.

Guidance

data class Guidance(val instructions: List<GuidanceInstruction>, val announcement: GuidanceAnnouncement?, val distanceToManeuver: <Error class: unknown class>, 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

data class GuidanceAnnouncement(val id: <Error class: unknown class> = 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.

InstructionPhase

value class InstructionPhase

Represents instruction triggering phase.

LaneGuidance

data class LaneGuidance(val lanes: List<<Error class: unknown class>>, val laneSeparators: List<<Error class: unknown class>>, val routeOffset: <Error class: unknown class>, val length: <Error class: unknown class>)

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

value class LaneGuidanceUpdateType

Type of LaneGuidanceUpdate.