Guidance

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.

Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

instructions

List of next instructions. The number of instructions provided is determined by GuidanceEngineOptions.instructionDistanceThreshold.

announcement

Announcement about the upcoming maneuver.

distanceToManeuver

Distance to the upcoming maneuver.

currentPhase

InstructionPhase of the upcoming maneuver.

Constructors

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

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard