provideExitSignIcon

Generates an exit sign image.

The reference parameter is used to construct an image for the exit sign. If the reference cannot be resolved to a valid image asset, a fallback image is generated.

An exit sign reference can be obtained from GuidanceInstructions which are provided by navigation engine during the navigation session.

Example Usage

val provider = RoadShieldIconProvider(context)
val image = guidanceInstruction?.signpost?.exitIconReference?.let { exitIconReference ->
    val exitNumber = guidanceInstruction?.signpost?.exitNumber.orEmpty()

    provider.provideExitSignIcon(
        reference = exitIconReference,
        content = exitNumber,
    ).value().toAndroidBitmap()
}

Parameters