location/org.maplibre.compose.location/AndroidLocationBackend

AndroidLocationBackend

interface AndroidLocationBackend(source)

An Android location implementation discovered through ServiceLoader.

An installed and available backend supplies the providers that createDefaultLocationProvider and createDefaultHeadingProvider create; the framework providers remain the default otherwise. When several backends are available, the highest priority wins, and equal priorities resolve to the first id in lexicographic order. A ServiceConfigurationError, a LinkageError, or an exception while loading or checking a backend maps LocationProvider.backendAvailability to LocationBackendAvailability.Misconfigured. The installed backend documents its own availability conditions.

Properties

abstract val id: String

A stable name used in diagnostics and to break priority ties.

priority

open val priority: Int

The precedence of this backend when several are available. The backend with the highest priority supplies the default providers. Backends ship with priority 0; declare a higher value for a backend that is a better fit on its own hardware, or a negative value for a last resort.

Functions

createHeadingProvider

open fun createHeadingProvider(context: Context): HeadingProvider?

Creates this backend's heading provider, or returns null so the default framework heading provider is used.

createLocationProvider

@MainThread

abstract fun createLocationProvider(context: Context): LocationProvider

Creates this backend's location provider.

isAvailable

abstract fun isAvailable(context: Context): Boolean

Whether this backend can run on the current device.