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

LocationDataSource

sealed class LocationDataSource

A location data source object. This object is to provide the location data to the location display.

Functions

start

suspend fun start(): Result<Unit>

Start the location data source asynchronously.

stop

suspend fun stop(): Result<Unit>

Stop the location data source asynchronously.

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>

LocationDataSource status.

Inheritors

CustomLocationDataSource

IndoorsLocationDataSource

SystemLocationDataSource

NmeaLocationDataSource

RouteTrackerLocationDataSource

SimulatedLocationDataSource