Package com.tomtom.sdk.navigation.guidance

Types

Link copied to clipboard
interface AnnouncementGenerator

Responsible for generating announcements.

Link copied to clipboard
value class AnnouncementMode

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

Link copied to clipboard
value class AnnouncementType

Represents guidance announcement type.

Link copied to clipboard
class ArrivalAnnouncementGenerator : AnnouncementGenerator

Responsible for generating announcement after detecting arrival.

Link copied to clipboard
class ConfirmationAnnouncementGenerator : AnnouncementGenerator

Responsible for generating confirmation announcements.

Link copied to clipboard
class EarlyAnnouncementGenerator : AnnouncementGenerator

Responsible for generating early announcements.

Link copied to clipboard
data class Guidance(    val instructions: List<GuidanceInstruction>,     val announcement: GuidanceAnnouncement? = null,     val distanceToManeuver: Distance,     val currentPhase: InstructionPhase)

Set of information about upcoming maneuvers.

Link copied to clipboard
data class GuidanceAnnouncement(    val id: UniqueId = UniqueId(),     val language: String,     val message: String,     val messagePhonetics: Phonetics? = null,     val announcementType: AnnouncementType)

Fine-grained announcement points, each with its own unique id, message and type.

Link copied to clipboard
interface GuidanceEngine : Disposable

Responsible for generation of guidance related to upcoming road maneuvers.

Link copied to clipboard
object GuidanceEngineFactory

Factory to create a GuidanceEngine.

Link copied to clipboard
data class GuidanceEngineOptions(    val units: Units = Units.AUTO,     val announcementGenerators: List<AnnouncementGenerator> = ANNOUNCEMENT_GENERATORS,     val instructionDistanceThreshold: Distance = INSTRUCTION_DISTANCE_THRESHOLD,     val language: String? = null,     val announcementMode: AnnouncementMode = AnnouncementMode.Comprehensive)

Options used by GuidanceEngineFactory.

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

Contains information about lane guidance.

Link copied to clipboard
data class LaneGuidanceUpdate(val laneGuidance: LaneGuidance, val type: LaneGuidanceUpdateType)

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

Link copied to clipboard
enum LaneGuidanceUpdateType : Enum<LaneGuidanceUpdateType>
Link copied to clipboard
class MainAnnouncementGenerator : AnnouncementGenerator

Responsible for generating main announcements.