TomTom SDK for iOS Phonetics

Phonetics

public struct Phonetics : Equatable

Phonetic strings of all of the readable Instruction properties.

  • Creates an instance with the specified parameters.

    Throws

    An error of the type InitializationError.

    Declaration

    Swift

    public init(
    street: String = "",
    streetLanguage: Locale,
    roadNumbers: [String] = [],
    roadNumbersLanguages: [Locale] = [],
    signpostText: String = "",
    signpostTextLanguage: Locale,
    phoneticAlphabet: String = ""
) throws

    Parameters

    street

    Phonetic string for the street.
    streetLanguage

    The language in which street is encoded as Locale.
    roadNumbers

    Phonetic strings for road numbers.
    roadNumbersLanguages

    The languages in which the roadNumbers are encoded as Locales.
    signpostText

    Phonetic string for signpost text.
    signpostTextLanguage

    The language of the signpost text as an IETF language tag, i.e., a dash-separated two-letter ISO-639 language code, and a two-letter ISO 3166 country code as Locale. Example: “en-US”.
    phoneticAlphabet

    Phonetic alphabet indicating the type of phonetics stored.

  • Represents the error that appears during initialization of the object.

    See more

    Declaration

    Swift

    public enum InitializationError : Error

  • Phonetic alphabet indicating the type of phonetics stored.

    Declaration

    Swift

    public let phoneticAlphabet: String

  • Phonetic strings for road numbers.

    Declaration

    Swift

    public let roadNumbers: [String]

  • The languages in which the roadNumbers are encoded.

    Declaration

    Swift

    public let roadNumbersLanguages: [Locale]

  • Phonetic string for signpost text.

    Declaration

    Swift

    public let signpostText: String

  • The Locale of the signpost with language in which signpostText is encoded.

    Declaration

    Swift

    public let signpostTextLanguage: Locale

  • Phonetic string for the street.

    Declaration

    Swift

    public let street: String

  • The Locale of the street name with language in which street is encoded.

    Declaration

    Swift

    public let streetLanguage: Locale