InstructionPhoneticsType

Specifies whether to include the phonetic transcription of street names, signpost text, and road numbers in the instruction.

When using any value other than none, phonetic information will be returned in the Response as follows:

• Instructions containing a com.tomtom.sdk.route.Instruction.street street field are extended with:

• Instruction.phoneticStreet: Phonetic string in the requested phonetic format.

• Instruction.phoneticStreetLanguageCode: Language code in which the phonetic string is encoded.

• Instructions containing a com.tomtom.sdk.route.Instruction.signpostText field are extended with:

• Instruction.phoneticSignPostText: Phonetic string in the requested phonetic format.

• Instruction.phoneticSignPostTextLanguageCode: Language code in which the phonetic string is encoded.

• Instructions containing a com.tomtom.sdk.route.Instruction.roadNumbers array are extended with:

• Instruction.phoneticRoadNumbers: Array of phonetic strings in the requested phonetic format corresponding to the respective elements of the roadNumbers array.

• Instruction.phoneticRoadNumberLanguageCodes: Array of language codes in which the respective phonetic strings are encoded.

Important: This is a Public Preview API. It may be changed or removed at any time.