GuidanceAnnouncement
public struct GuidanceAnnouncement : Equatable
Guidance announcement relating to a maneuver during navigation. The announcement text message is provided in both Speech Synthesis Markup Language (SSML) and plain-text formats.
Type of the announcement.
Declaration
Swift
public let announcementType: AnnouncementType
An attributed string that contains a verbal message for the manuever.
Declaration
Swift
public internal(set) var attributedStringMessage: NSAttributedString? { get }
The unique ID of the announcement.
Declaration
Swift
public let id: UUID
Initializes a guidance announcement from a route announcement.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public init(announcement: Announcement, language: Locale) throws
Parameters
announcement
|
|
language
|
The language of the |
Initializes a guidance announcement with the specified parameters.
Declaration
Swift
public init(
id: UUID = UUID(),
language: Locale,
messageContent: String,
announcementType: AnnouncementType
) throws
Parameters
id
|
The ID of the announcement. |
language
|
The language of the |
messageContent
|
A verbal message for the maneuver in |
announcementType
|
Type of the announcement. |
Exceptions that can be thrown during the creation of GuidanceAnnouncement
.
Declaration
Swift
public enum InitializationError : Error
The language of the message
as Locale
.
Declaration
Swift
public let language: Locale
A verbal message for the maneuver in plain text.
Declaration
Swift
public internal(set) var plainTextMessage: String { get }
A verbal message for the maneuver in SSML format.
Declaration
Swift
public internal(set) var ssmlMessage: String { get }