AnnouncementGenerator

public protocol AnnouncementGenerator

The AnnouncementGenerator protocol defines functionality for generating announcements during route navigation.

Important

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

  • Method for checking whether any announcement should be generated at the current point on the route.

    Declaration

    Swift

    func shouldGenerate(parameters: AnnouncementGenerationParams) -> Bool

    Parameters

    parameters

    announcement generation parameters

    Return Value

    The check result, true if an announcement should be generated, false otherwise.

  • Generates an announcement object based on input parameters.

    Declaration

    Swift

    func generateAnnouncement(parameters: AnnouncementGenerationParams) throws -> GuidanceAnnouncement

    Parameters

    parameters

    announcement generation parameters

    Return Value

    Generated GuidanceAnnouncement object that should be announced at the current point on the route.