GuidanceEngine

public protocol GuidanceEngine : ManageableEngine

Responsible for generation of guidance 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 this GuidanceEngine.

    Declaration

    Swift

    var announcementMode: AnnouncementMode { get set }

  • 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) -> LaneGuidanceInfo?

    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.