GuidanceAnnouncement

public struct GuidanceAnnouncement : Equatable

The Announcement class contains information about what the GuidanceEngine should announce during route navigation.

Important

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

Lifecycle

  • Initializer.

    Declaration

    Swift

    public init(
    uuid: UUID = UUID(),
    point: CLLocationCoordinate2D,
    distanceInMeters: Double,
    type: String,
    maneuver: AnnouncementManeuver,
    message: String? = nil,
    verbalMessage: String? = nil,
    verbalMessagePhonetics: Phonetics? = nil
)

    Parameters

    uuid

    The unique ID of the announcement.
    point

    The coordinate where the announcement should be triggered
    distanceInMeters

    The distance before the instruction at which the announcement should be triggered.
    type

    The type of the announcement.
    maneuver

    The type of the maneuver.
    message

    A human-readable message for the announcement
    verbalMessage

    The tagged message to be used for verbal instruction playback.
    verbalMessagePhonetics

    Phonetic transcriptions of the verbal message.

  • Initializer.

    Declaration

    Swift

    public init(announcement: Announcement)

    Parameters

    announcement

    announcement object used as a source of data for creating a GuidanceAnnouncement object.

Public

  • The unique ID of the announcement.

    Declaration

    Swift

    public let uuid: UUID

  • The coordinate where the announcement should be triggered.

    Declaration

    Swift

    public let point: CLLocationCoordinate2D

  • The distance before the instruction at which the announcement should be triggered.

    Declaration

    Swift

    public let distanceInMeters: Double

  • The type of the announcement.

    Declaration

    Swift

    public let type: String

  • The type of the maneuver.

    Declaration

    Swift

    public let maneuver: AnnouncementManeuver

  • A human-readable message for the announcement

    Declaration

    Swift

    public let message: String?

  • The tagged message to be used for verbal instruction playback.

    Declaration

    Swift

    public internal(set) var verbalMessage: String? { get }

  • Phonetic transcription of the verbal message.

    Declaration

    Swift

    public let verbalMessagePhonetics: Phonetics?