com.tomtom.sdk.navigation:navigation/com.tomtom.sdk.navigation.guidance/Guidance

Guidance

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
data class Guidance(val instructions: List<GuidanceInstruction>, val announcement: GuidanceAnnouncement?, val distanceToManeuver: Distance, val currentPhase: InstructionPhase, val shouldPlay: Boolean = false)

Deprecated

This will be removed 6 months after the next release.

Replace with

No replacement available.
Content copied to clipboard

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

Constructors

Link copied to clipboard
constructor(instructions: List<GuidanceInstruction>, announcement: GuidanceAnnouncement?, distanceToManeuver: Distance, currentPhase: InstructionPhase, shouldPlay: Boolean = false)

Properties

Link copied to clipboard
val announcement: GuidanceAnnouncement?

Announcement about the upcoming maneuver.

Link copied to clipboard
val currentPhase: InstructionPhase

InstructionPhase of the upcoming maneuver.

Link copied to clipboard
val distanceToManeuver: Distance

Distance to the upcoming maneuver.

Link copied to clipboard
val instructions: List<GuidanceInstruction>

List of next instructions ordered by distance. Provided instructions are bounded by GuidanceEngineOptions.instructionDistanceThreshold.

Link copied to clipboard
val shouldPlay: Boolean = false

Whether announcement should be triggered according to guidelines.