InstructionPhoneticsType

public enum InstructionPhoneticsType
extension InstructionPhoneticsType: Codable

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 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 [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 [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.
  • Do not include phonetic transcriptions in the response.

    Declaration

    Swift

    case none
  • LHP

    Return phonetic transcriptions in the L&H+ format from Cerence Inc.

    Declaration

    Swift

    case LHP
  • IPA

    Return phonetic transcriptions in the IPA (International Phonetic Alphabet) format. https://en.wikipedia.org/wiki/International_Phonetic_Alphabet

    Declaration

    Swift

    case IPA