navigation:ui/com.tomtom.sdk.navigation.ui/NavigationUiOptions

NavigationUiOptions

class NavigationUiOptions( val units: Units = Units.AUTO, val isSoundEnabled: Boolean = true, val keepInBackground: Boolean = false, val voiceLanguage: Locale = Locale.US, val adaptVoiceLanguage: Boolean = false) : Parcelable

Represents navigation options that are configurable.

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

Constructors

NavigationUiOptions

fun NavigationUiOptions( units: Units = Units.AUTO, isSoundEnabled: Boolean = true, keepInBackground: Boolean = false, voiceLanguage: Locale = Locale.US, adaptVoiceLanguage: Boolean = false)

Functions

describeContents

abstract fun describeContents(): Int

getPreferredUnits

fun getPreferredUnits(context: Context): Units

If Units is set to Units.AUTO, this method returns the units based on the device's locale settings. If Units is set to a non-auto value, the method returns the preferred units.

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

adaptVoiceLanguage

val adaptVoiceLanguage: Boolean = false

Whether the language of the message should be used for the voice guidance over voiceLanguage, when the language of a message is different from the voiceLanguage.

isSoundEnabled

val isSoundEnabled: Boolean = true

Returns whether voice guidance is turned on.

keepInBackground

val keepInBackground: Boolean = false

Whether or not the navigation should be kept in background within Android Service.

units

val units: Units

Returns preferred Units.

voiceLanguage

val voiceLanguage: Locale

Preferred language of the voice guidance.