generateLaneGuidance

abstract fun generateLaneGuidance(navigationSnapshot: NavigationSnapshot): LaneGuidanceUpdate?

Generates LaneGuidanceUpdate based on the provided NavigationSnapshot.

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

Note: A LaneGuidanceUpdate is only generated when the input meets the SDK's internal validity criteria for lane guidance. Specifically:

  • The NavigationSnapshot must correspond to a route segment near a maneuver (e.g., turn, merge, exit).

  • There must be at least two lanes available.

  • The lanes must include valid direction data, and at least one recommended direction to follow.

Return

If the call succeeds, returns a LaneGuidanceUpdate.

Parameters

navigationSnapshot

Throws

if GuidanceFailure has happen.