AnnouncementGenerator

interface AnnouncementGenerator

Responsible for generating announcements.

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

Types

Link copied to clipboard
data class GenerateParams(    val announcements: List<Announcement>,     val distanceToNextInstruction: Distance,     val destinationArrivalStatus: DestinationArrivalStatus)

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

Functions

Link copied to clipboard
abstract fun generate(generateParams: AnnouncementGenerator.GenerateParams): GuidanceAnnouncement
Link copied to clipboard
abstract fun shouldGenerate(generateParams: AnnouncementGenerator.GenerateParams): Boolean

Checks if a GuidanceAnnouncement should be generated.

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard