onAnnouncementGenerated

abstract fun onAnnouncementGenerated(announcement: GuidanceAnnouncement, shouldPlay: Boolean)

Called whenever the upcoming maneuver announcement has been generated.

The announcement is generated based on the distance to maneuver and upcoming instructions.

The announcement could include one or more instructions when they are close to each other, i.e., entering and exiting a roundabout. The parameter that indicates whether instructions would be combined is GuidanceInstruction.combineWithNext

Configure the announcement verbosity by changing the property TomTomNavigation.configuration.guidanceAnnouncementMode. If the property TomTomNavigation.configuration.guidanceAnnouncementsEnabled is set to false, this method will not be invoked.

Parameters

announcement

GuidanceAnnouncement about the upcoming maneuver.

shouldPlay

Whether the announcement should be triggered.

Note: Do not rely on the shouldPlay parameter of the listener when: Using the AnnouncementListener with AnnouncementConflictResolutionStrategy.PriorityCancellation to resolve the conflict between guidance and warning announcements.