findCurrentBannerText

fun findCurrentBannerText(currentStep: LegStep, stepDistanceRemaining: Double, findPrimary: Boolean): BannerText?

This method returns the current BannerText based on the currentStep distance remaining.

When called, this is the banner text that should be shown at the given point along the route.

Return

current BannerText based on currentStep distance remaining

Since

0.13.0

Parameters

currentStep

holding the current banner instructions

stepDistanceRemaining

to determine progress along the currentStep

findPrimary

if the primary or secondary BannerText should be retrieved