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 ordered by distance. Provided instructions are bounded by com.tomtom.sdk.navigation.guidance.GuidanceEngineOptions.
For example, if the threshold is set to 400 meters (the default) and the first instruction has a route offset of 700 meters, the system will include all instructions that fall within the range of 700 + 400 = 1100 meters from the starting point.
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)