Package-level declarations

Types

Link copied to clipboard

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

Link copied to clipboard

Represents guidance announcement type.

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

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

Link copied to clipboard
data class GuidanceAnnouncement(val id: UniqueId = UniqueId(), val language: String, message: String, messagePhonetics: Phonetics? = null, 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.

Link copied to clipboard

Responsible for generation of guidance related to upcoming road maneuvers.

Link copied to clipboard

Factory to create a GuidanceEngine.

Link copied to clipboard
data class GuidanceEngineOptions(val instructionDistanceThreshold: Distance = INSTRUCTION_DISTANCE_THRESHOLD, val language: String? = null, val announcementMode: AnnouncementMode = AnnouncementMode.Comprehensive)

Options used by GuidanceEngineFactory.

Link copied to clipboard
value class InstructionPhase(phase: Int)

Represents instruction triggering phase.

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