Turn-by-turn instructions

VERSION 2.1.2

To use a route in a turn-by-turn navigation context, you must include selected options when creating a request. The key parameters are summarized below, along with an example of routing options:

1
val amsterdam = GeoPoint(52.377956, 4.897070)
2
val rotterdam = GeoPoint(51.926517, 4.462456)
3
val routePlanningOptions = buildRoutePlanningOptions(
4
    itinerary = Itinerary(origin = amsterdam, destination = rotterdam),
5
    language = Locale.ENGLISH,
6
    instructionPhoneticsType = InstructionPhoneticsType.Ipa,
7
)

Vehicle heading

Once you are driving, it’s important to request a route that goes in a specific direction. For that purpose, the heading parameter should be used. It describes the directional heading of the vehicle, expressed in degrees starting at true North and increasing clockwise:

North is 0 degrees.
East is 90 degrees.
South is 180 degrees.
West is 270 degrees.

Instructions

To obtain guidance instructions, the guidanceOptions parameter needs to be set.

If alternative routes are requested, instructions are generated for each route returned.

Phonetics

The phoneticsType parameter specifies whether to include the phonetic transcription of street names, signpost text, and road numbers in the instructions of the response. In areas where phonetic information is not available, the result is not returned.

Possible values are:

InstructionPhoneticsType.None - Do not include phonetic transcriptions in the response.
InstructionPhoneticsType.Ihp - Return phonetic transcriptions in the L&H+ format from Cerence Inc.
InstructionPhoneticsType.Ipa - Return phonetic transcriptions in the IPA (International Phonetic Alphabet).

Extended guidance sections

The extendedSections parameter specifies whether to include sections of type lane and roadShield in the response. All other section types are always included.

Possible values are:

ExtendedSections.None - Do not include extended guidance sections in the response.
ExtendedSections.All - Include the extended guidance section types in the response.

Next steps

Since you have learned how to work with turn-by-turn instructions, here are recommendations for the next steps: