LocationDataSource

sealed class LocationDataSource

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

Functions

Link copied to clipboard
suspend fun start(): Result<Unit>

Start the location data source asynchronously.

Link copied to clipboard
suspend fun stop(): Result<Unit>

Stop the location data source asynchronously.

Properties

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

Link copied to clipboard
val headingChanged: SharedFlow<Double>

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

Link copied to clipboard
open val locationChanged: SharedFlow<Location>

A SharedFlow that emits location changes.

Link copied to clipboard
val status: StateFlow<LocationDataSourceStatus>

Inheritors

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard