The Navigation SDK for iOS is only available upon request. Contact us to get started.
Planning a route for turn-by-turn navigation requires that specific parameters be included in the request. An example of routing options that can be used for this purpose is as follows:
The most important parameters are summarized below.
To obtain guidance instructions,
instructionsType needs to be set. Possible values are:
coded: returns raw instruction data without human-readable messages.
text: returns raw instructions data with human-readable messages in plain text.
tagged: returns raw instruction data with tagged human-readable messages to permit formatting.
If alternative routes are requested, instructions will be generated for each route returned.
none: Do not include instruction announcement points.
all: Include instruction announcement points. If the method is called with value
all, the instruction will include up to three additional fine-grained announcement points, each with its own location, maneuver type, and distance to the instruction point.
none: Do not include instruction road shield references.
all: Include instructions for road shield references.
phonetics parameter of
GuidanceOptions specifies whether to include phonetic transcriptions of street names, signpost texts, and road numbers in the instructions. In areas where phonetic information is not available, the result will not be returned. Possible values are:
none: Do not include phonetic transcriptions in the response.
LHP: Return phonetic transcriptions in the L&H+ format from Cerence Inc.
IPA: Return phonetic transcriptions in the IPA (International Phonetic Alphabet).
When driving, it’s important to request a route in a specific direction. For that purpose, the
heading parameter should be used. It describes the directional heading of the vehicle, 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.
Per default, all sections except for lanes, speed limits, and roadshields are included in the response. If you want to include these three as well, specify
More details about available route sections can be found in the Sections document.
To get the best turn-by-turn experience, it’s required to include the extended sections as well.