GuidanceEngine
public protocol GuidanceEngine : ManageableEngine
Responsible for generation of Guidance
and LaneGuidance
related to upcoming road maneuvers.
-
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.
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.
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.