navigation:engine/com.tomtom.sdk.navigation.guidance/AnnouncementGenerator

AnnouncementGenerator

interface AnnouncementGenerator

Responsible for generating announcements.

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

Types

object Companion

data class GenerateParams(val announcements: List<Announcement>, val distanceToNextInstruction: Distance, val destinationArrivalStatus: DestinationArrivalStatus, val announcementLanguage: String)

Parameters for announcement generators, e.g.: distance to next instruction in meters, or list of all possible announcements.

Functions

findAnnouncement

open fun findAnnouncement(generateParams: AnnouncementGenerator.GenerateParams): Announcement?

Finds an Announcement if there is one that should be generated.

open fun generate(generateParams: AnnouncementGenerator.GenerateParams): GuidanceAnnouncement

Generates a GuidanceAnnouncement.

hasAnnouncement

open fun hasAnnouncement(generateParams: AnnouncementGenerator.GenerateParams): Boolean

Checks if there is a proper Announcement.

open fun hasArrived(generateParams: AnnouncementGenerator.GenerateParams): Boolean

Checks if the destination is reached.

open fun shouldGenerate(generateParams: AnnouncementGenerator.GenerateParams): Boolean

Checks if a GuidanceAnnouncement should be generated.

abstract fun supportedType(): String

Return supported type of an Announcement.

Inheritors

ArrivalAnnouncementGenerator

ConfirmationAnnouncementGenerator

EarlyAnnouncementGenerator

MainAnnouncementGenerator