Announcement

public struct Announcement

Fine-grained announcement points, each with its own message, location and distance to the instruction point.

Important

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

Lifecycle


                    
                    
                    init(uuid:point:distance:type:verbalMessage:verbalMessagePhonetics:)

Initializes a announcement with all its initial values.

Declaration

Swift

public init(
    uuid: UUID = UUID(),
    point: CLLocationCoordinate2D,
    distance: Measurement<UnitLength>,
    type: String,
    verbalMessage: String = "",
    verbalMessagePhonetics: Phonetics? = nil
)

Parameters

`uuid`	The ID of the announcement.
`point`	Location of the announcement defined as a latitude longitude pair.
`distance`	Distance from `point` to the `Instruction.maneuverPoint`.
`type`	The type of the announcement.
`verbalMessage`	The tagged message to be used for verbal instruction playback. Empty string by default.
`verbalMessagePhonetics`	Phonetic strings of all of the readable `Instruction` properties. `nil` by default.

Public

uuid
Unique ID of the announcement.
Declaration
Swift

public let uuid: UUID
point
The coordinate where the announcement should be triggered.
Declaration
Swift

public let point: CLLocationCoordinate2D
distance
The distance before the instruction at which the announcement should be triggered.
Declaration
Swift

public let distance: Measurement<UnitLength>
type
The type of the announcement.
Declaration
Swift

public let type: String
verbalMessage
The tagged message to be used for verbal instruction playback.
Declaration
Swift

public let verbalMessage: String
verbalMessagePhonetics
Phonetic transcription of the verbal message.
Declaration
Swift

public let verbalMessagePhonetics: Phonetics?