arcgis-maps-kotlin/com.arcgismaps.location/LocationDataSource

LocationDataSource

The location data source provides location information that can be displayed on a map using the MapView.locationDisplay. This is a base class for a number of different location data sources, such as IndoorsLocationDataSource, NmeaLocationDataSource, RouteTrackerLocationDataSource, and SimulatedLocationDataSource. Call LocationDataSource.start() to receive location updates and display the current location using the MapView.locationDisplay.

Since

200.1.0

Properties

error

val error: StateFlow<Throwable?>

An error that describes a problem encountered while starting or running the LocationDataSource. This property is used to notify the user about errors that occur in LocationDataSource. Such errors are critical for LocationDataSource and will cause it stop. If LocationDataSource cannot be started, or it stopped after a successful start, this property will store information related to what caused LocationDataSource to stop.

headingChanged

val headingChanged: SharedFlow<Double>

Set the heading changed callback function for the location data source.

locationChanged

open val locationChanged: SharedFlow<Location>

A SharedFlow that emits location changes.

status

val status: StateFlow<LocationDataSourceStatus>

The current status of the location data source. The status indicates if the location data source is starting, started, stopping, stopped, and has failed to start.

Functions

start

suspend fun start(): Result<Unit>

Starts the location data source asynchronously and prepares to begin receiving location updates.

stop

suspend fun stop(): Result<Unit>

Stop the location data source asynchronously.

Inheritors

CustomLocationDataSource

IndoorsLocationDataSource

SystemLocationDataSource

NmeaLocationDataSource

RouteTrackerLocationDataSource

SimulatedLocationDataSource