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

NavigationUiOptions

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
class NavigationUiOptions(val unitSystemType: UnitSystemType = UnitSystemType.default, val isSoundEnabled: Boolean = true, val keepInBackground: Boolean = false, val voiceLanguage: Locale = Locale.US, val adaptVoiceLanguage: Boolean = false, showWaypointArrivalPanel: Boolean = false, showBetterRouteProposalPanel: Boolean = false, val showRoadShieldsAsImages: Boolean = false, val isDarkTheme: Boolean = false, useEffectiveSpeed: Boolean = false) : Parcelable

Deprecated

This will be removed from future releases after 2026-07-26.

Represents navigation options that are configurable.

Constructors

Link copied to clipboard
constructor(unitSystemType: UnitSystemType = UnitSystemType.default, isSoundEnabled: Boolean = true, keepInBackground: Boolean = false, voiceLanguage: Locale = Locale.US, adaptVoiceLanguage: Boolean = false, showWaypointArrivalPanel: Boolean = false, showBetterRouteProposalPanel: Boolean = false, showRoadShieldsAsImages: Boolean = false, isDarkTheme: Boolean = false, useEffectiveSpeed: Boolean = false)

Properties

Link copied to clipboard
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.

Link copied to clipboard
val isDarkTheme: Boolean = false

Whether the road shields and exit sign use a light or dark theme.

Link copied to clipboard
val isSoundEnabled: Boolean = true

Returns whether voice guidance is turned on.

Link copied to clipboard
val keepInBackground: Boolean = false

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

Link copied to clipboard
val showRoadShieldsAsImages: Boolean = false

Whether to show road shield and exit signs as images.

Link copied to clipboard
val unitSystemType: UnitSystemType

Returns preferred UnitSystemType. If provided value is UnitSystemType.Dynamic then the UnitSystem will be resolved dynamically based on current location country by the SDK. Once set, unitSystemType will be propagated to TomTomNavigation.configuration.unitSystem and other parts of the SDK.

Link copied to clipboard
val voiceLanguage: Locale

Preferred language of the voice guidance.

Inherited functions

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