GuidanceEngine
public protocol GuidanceEngine : ManageableEngine
Responsible for generation of Guidance
and LaneGuidance
related to upcoming road maneuvers.
Important
This is a Public Preview API. It may be changed or removed at any time.-
Defines whether generation of announcements is enabled.
Declaration
Swift
var announcementsEnabled: Bool { get set }
-
Defines the
AnnouncementMode
for thisGuidanceEngine
.Declaration
Swift
var announcementMode: AnnouncementMode { get set }
-
Returns a list of languages (represented as Locale) supported by
GuidanceEngine
.Declaration
Swift
var availableLanguages: [Locale] { get }
-
Generates guidance which might be a new upcoming maneuver or the same with updated distance to next maneuver.
Throws
NavigationSnapshotError.unavailableTripSnapshot
if there is no route plan available.GuidanceEngineError.noNextInstructions
if there are no new instructions.Declaration
Swift
func generateGuidance(navigationSnapshot: NavigationSnapshot) throws -> Guidance
Parameters
navigationSnapshot
The snapshot of the current navigation session.
Return Value
Guidance object containing guidance information related to the current position on the route.
-
Generates a lane guidance object related to the current position on the route based on input parameters.
Note
LaneGuidanceUpdate
is suppressed (set to nil) when none of the lanes are set as recommended.Declaration
Swift
func generateLaneGuidance(navigationSnapshot: NavigationSnapshot) -> LaneGuidanceUpdate?
Parameters
navigationSnapshot
The snapshot of the current navigation session.
Return Value
Lane guidance info object containing lane guidance information related to the current position on the route.