Package com.mapbox.navigation.base.options

Types

Link copied to clipboard
class AlertServiceOptions

Alerts service extracts information from the road graph and helps track it through eHorizon. AlertServiceOptions control how Navigation SDK extracts road objects from the road graph and which objects are collected. Some objects may take significant effort to extract and thus there's an option to disable collection of some of the types.

Link copied to clipboard
class CopilotOptions

Defines options for Copilot.

Link copied to clipboard
class DeviceProfile

The navigation SDK has algorithms optimized for the type of data being provided. The device profile selects the optimization.

Link copied to clipboard
enum DeviceType : Enum<DeviceType>

The type of device providing data to the navigator.

Link copied to clipboard
class EHorizonOptions

Defines options for EHorizon.

Link copied to clipboard
class EventsAppMetadata

Custom metadata that can be used to associate app state with events in the telemetry pipeline.

Link copied to clipboard
class HistoryRecorderOptions

Defines options for recording history files.

Link copied to clipboard
class IncidentsOptions

Electronic Horizon supports live incidents on a most probable path. To enable live incidents IncidentsOptions should be provided. If both graph and apiUrl are empty, live incidents are disabled (by default).

Link copied to clipboard
abstract class LocationOptions

Base class for location options that are set via NavigationOptions.locationOptions. The only following implementation at the moment is RealLocationOptions. Use RealLocationOptions if the locations correspond to the actual location of a device.

Link copied to clipboard
sealed class LongRoutesOptimisationOptions

Controls if the Nav SDK behaves in a regular or an optimised way.

Link copied to clipboard
class NavigationOptions

This value will be used to offset the time at which the current location was calculated in such a way as to project the location forward along the current trajectory so as to appear more in sync with the users ground-truth location

Link copied to clipboard
class PredictiveCacheLocationOptions

PredictiveCacheLocationOptions.

Link copied to clipboard
class PredictiveCacheMapsOptions

Predictive cache Maps related options.

Link copied to clipboard
class PredictiveCacheNavigationOptions

Predictive cache Navigation related options.

Link copied to clipboard
class PredictiveCacheOptions

PredictiveCacheOptions

Link copied to clipboard
abstract class RealLocationOptions : LocationOptions

Use this class to specify that locations are real. Set it via NavigationOptions.locationOptions. Can be one of DefaultProvider or CustomProvider.

Link copied to clipboard
class RerouteOptions

Reroute options

Link copied to clipboard
class RoutingTilesOptions

Defines options for routing tiles endpoint and storage configuration.

Properties

Link copied to clipboard
const val DEFAULT_NAVIGATOR_PREDICTION_MILLIS: Long = 1000

Default navigator approximate prediction in milliseconds