Announcement

public struct Announcement

The Announcement class contains information about what should be announced at specific points during route navigation.

Lifecycle

  • Initializes a announcement with all its initial values.

    Declaration

    Swift

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

    Parameters

    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

    The phonetic transcription of the verbal message.

Public

  • 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 let verbalMessage: String?

  • Phonetic transcription of the verbal message.

    Declaration

    Swift

    public let verbalMessagePhonetics: Phonetics?