RouteProgress

class RouteProgress

This class contains all progress information at any given time during a navigation session. This progress includes information for the current route, leg, and step that the user is traveling along. With every new valid location update, a new route progress will be generated using the latest information.

The latest route progress object can be obtained through the RouteProgressObserver. Note that the route progress object's immutable.

Parameters

navigationRoute

NavigationRoute the navigation session is currently using. When a reroute occurs and a new directions route gets obtained, with the next location update this directions route should reflect the new route.

bannerInstructions

BannerInstructions current instructions for visual guidance.

voiceInstructions

VoiceInstructions current instruction for audio guidance.

currentState

RouteProgressState the current state of progress along the route. Provides route and location tracking information.

currentLegProgress

RouteLegProgress current progress of the active leg, includes time and distance estimations.

upcomingStepPoints

List location coordinates describing the upcoming step.

inTunnel

Boolean value indicating whether the current location is in a tunnel.

distanceRemaining

Float provides the distance remaining in meters until the user reaches the end of the route.

distanceTraveled

Float representing the distance traveled along the route in meters.

durationRemaining

Double seconds time remaining until the route destination is reached.

fractionTraveled

Float fraction traveled along the current route. This value is between 0 and 1 and isn't guaranteed to reach 1 before the user reaches the end of the route.

remainingWaypoints

Int number of waypoints remaining on the current route.

upcomingRoadObjects

list of upcoming road objects.

stale

true if there were no location updates for a significant amount which causes a lack of confidence in the progress updates being sent.

routeAlternativeId

in case of currentState equal to RouteProgressState.OFF_ROUTE, this field can provide the route ID of an alternative route that user turned into causing off-route event (if there is one). This field can be used to find a route with NavigationRoute.id that can be immediately used as the new primary route.

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Returns a hash code value for the object.
toString
Link copied to clipboard
open override fun toString(): String
Returns a string representation of the object.

Properties

bannerInstructions
Link copied to clipboard
val bannerInstructions: BannerInstructions?
BannerInstructions current instructions for visual guidance.
currentLegProgress
Link copied to clipboard
val currentLegProgress: RouteLegProgress?
RouteLegProgress current progress of the active leg, includes time and distance estimations.
currentState
Link copied to clipboard
val currentState: RouteProgressState
RouteProgressState the current state of progress along the route.
distanceRemaining
Link copied to clipboard
val distanceRemaining: Float
Float provides the distance remaining in meters until the user reaches the end of the route.
distanceTraveled
Link copied to clipboard
val distanceTraveled: Float
Float representing the distance traveled along the route in meters.
durationRemaining
Link copied to clipboard
val durationRemaining: Double
Double seconds time remaining until the route destination is reached.
fractionTraveled
Link copied to clipboard
val fractionTraveled: Float
Float fraction traveled along the current route.
inTunnel
Link copied to clipboard
val inTunnel: Boolean
Boolean value indicating whether the current location is in a tunnel.
navigationRoute
Link copied to clipboard
val navigationRoute: NavigationRoute
NavigationRoute the navigation session is currently using.
remainingWaypoints
Link copied to clipboard
val remainingWaypoints: Int
Int number of waypoints remaining on the current route.
route
Link copied to clipboard
val route: DirectionsRoute
DirectionsRoute the navigation session is currently using.
routeAlternativeId
Link copied to clipboard
val routeAlternativeId: String?
in case of currentState equal to RouteProgressState.OFF_ROUTE, this field can provide the route ID of an alternative route that user turned into causing off-route event (if there is one).
stale
Link copied to clipboard
val stale: Boolean
true if there were no location updates for a significant amount which causes a lack of confidence in the progress updates being sent.
upcomingRoadObjects
Link copied to clipboard
val upcomingRoadObjects: List<UpcomingRoadObject>
list of upcoming road objects.
upcomingStepPoints
Link copied to clipboard
val upcomingStepPoints: List<Point>?
List location coordinates describing the upcoming step.
voiceInstructions
Link copied to clipboard
val voiceInstructions: VoiceInstructions?
VoiceInstructions current instruction for audio guidance.