com.tomtom.sdk.navigation:navigation-engines/com.tomtom.sdk.navigation.guidance/GuidanceAnnouncement

GuidanceAnnouncement

class GuidanceAnnouncement(val id: UniqueId = UniqueId(), val language: Locale, val announcementType: AnnouncementType, val ssmlMessage: String)

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.

Parameters

id

The ID of the announcement.

language

The language of the ssmlMessage.

announcementType

Type of the announcement.

ssmlMessage

A verbal message for the maneuver in SSML format.

Constructors

Link copied to clipboard
constructor(id: UniqueId = UniqueId(), language: Locale, announcementType: AnnouncementType, ssmlMessage: String)

Properties

Link copied to clipboard
Link copied to clipboard
val id: UniqueId
Link copied to clipboard
Link copied to clipboard
val plainTextMessage: String

A verbal message for the maneuver in plain text.

Link copied to clipboard

Functions

Link copied to clipboard
operator fun component1(): UniqueId
Link copied to clipboard
operator fun component2(): Locale
Link copied to clipboard
operator fun component3(): AnnouncementType
Link copied to clipboard
operator fun component4(): String
Link copied to clipboard
fun copy(id: UniqueId = this.id, language: Locale = this.language, announcementType: AnnouncementType = this.announcementType, ssmlMessage: String = this.ssmlMessage): GuidanceAnnouncement

Creates a copy of this GuidanceAnnouncement object.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String