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) : Parcelable
Content copied to clipboard

Represents navigation options that are configurable.

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

Constructors

Link copied to clipboard
fun NavigationUiOptions(    units: Units = Units.AUTO,     isSoundEnabled: Boolean = true,     keepInBackground: Boolean = false,     voiceLanguage: Locale = Locale.US)
Content copied to clipboard

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Content copied to clipboard
Link copied to clipboard
fun getPreferredUnits(context: Context): Units
Content copied to clipboard

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.

Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)
Content copied to clipboard

Properties

Link copied to clipboard
val isSoundEnabled: Boolean = true
Content copied to clipboard

Returns whether voice guidance is turned on.

Link copied to clipboard
val keepInBackground: Boolean = false
Content copied to clipboard

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

Link copied to clipboard
val units: Units
Content copied to clipboard

Returns preferred Units.

Link copied to clipboard
val voiceLanguage: Locale
Content copied to clipboard

Preferred language of the voice guidance.