Guidance

public struct Guidance

Guidance update provided while navigating a route, including the list of upcoming instructions, guidance announcement and distance to the next maneuver.

Public

  • List of next instructions. The number of instructions provided is determined by internal threshold.

    Declaration

    Swift

    public let instructions: [GuidanceInstruction]

  • Announcement about the upcoming maneuver.

    Declaration

    Swift

    public let announcement: GuidanceAnnouncement?

  • Should the announcement be played.

    Declaration

    Swift

    public let shouldPlayAnnouncement: Bool

  • The distance to the upcoming maneuver.

    Declaration

    Swift

    public private(set) var distanceToManeuver: Measurement<UnitLength> { get }

  • The phase of the upcoming maneuver.

    Declaration

    Swift

    public let currentPhase: InstructionPhase