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.
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.
shouldPlay
Whether announcement should be triggered according to guidelines.
Constructors
Link copied to clipboard
constructor(instructions: List<GuidanceInstruction>, announcement: GuidanceAnnouncement?, distanceToManeuver: Distance, currentPhase: InstructionPhase, shouldPlay: Boolean = false)