Turn-by-turn instructions

VERSION 0.12.0

Navigation SDK for Android is only available upon request. Contact us to get started.

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

1val amsterdam = GeoPoint(52.377956, 4.897070)
2val rotterdam = GeoPoint(51.926517, 4.462456)
3val routePlanningOptions = RoutePlanningOptions(
4    itinerary = Itinerary(origin = amsterdam, destination = rotterdam),
5    guidanceOptions = GuidanceOptions(
6        language = Locale.ENGLISH,
7        instructionType = InstructionType.Tagged,
8        phoneticsType = InstructionPhoneticsType.Ipa,
9        announcementPoints = AnnouncementPoints.All,
10        extendedSections = ExtendedSections.All,
11        progressPoints = ProgressPoints.All
12    )
13)

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 continuing in a clockwise direction:

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

Instructions

To obtain guidance instructions, the instructionsType needs to be set. Possible values are:

InstructionType.Coded - returns raw instruction data without human-readable messages.
InstructionType.Text - returns raw instructions data with human-readable messages in plain text.
InstructionType.Tagged - returns raw instruction data with tagged human-readable messages to permit formatting.

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

Announcement points

The announcementPoints parameter specifies whether to include announcement points in instructions. If specified, the instruction will include up to three additional fine-grained announcement points, each with their own location, maneuver type, and distance to the instruction point. Based on that, the navigation system can decide at which point of time the audio messages should be played.

Possible values are:

AnnouncementPoints.None - Do not include instruction announcement points in instructions.
AnnouncementPoints.All - Include instruction announcement points in instructions, exposing the following instruction fields, where applicable:
- earlyWarningAnnouncement
- mainAnnouncement
- confirmationAnnouncement

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 speedLimit, 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.

Progress points

The progressPoints parameter specifies whether the response should include progress points. Progress points consist of a list of references to polyline points, annotated with a value indicating travelTime or distance up to that point.

Possible values are:

ProgressPoints.None - Do not include progress points in the response.
ProgressPoints.All - Include both progress point 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: