location/org.maplibre.compose.location

Package-level declarations

Types

AndroidHeadingProvider

class AndroidHeadingProvider(context: Context) : HeadingProvider

A HeadingProvider built on Android's SensorManager.

AndroidLocationBackend

interface AndroidLocationBackend

An Android location implementation discovered through ServiceLoader.

AndroidLocationPermissionRequester

class AndroidLocationPermissionRequester : AutoCloseable

Observes and requests foreground location permission on Android.

AndroidLocationProvider

class AndroidLocationProvider : LocationProvider

Foreground location from Android's location service.

AndroidSystemSettingsLauncher

class AndroidSystemSettingsLauncher(context: Context) : SystemSettingsLauncher

Opens Android settings screens related to location.

BrowserLocationPermissionRequester

class BrowserLocationPermissionRequester

Observes and requests browser geolocation permission.

BrowserLocationProvider

class BrowserLocationProvider : LocationProvider

Foreground location from the browser's Geolocation API.

BrowserSystemSettingsLauncher

object BrowserSystemSettingsLauncher : SystemSettingsLauncher

The browser exposes no way to open its settings, so every screen is unavailable.

DesktopLocationBackend

interface DesktopLocationBackend

A host-specific desktop location implementation discovered through ServiceLoader.

DesktopSystemSettingsLauncher

class DesktopSystemSettingsLauncher : SystemSettingsLauncher

Opens the desktop settings screen related to location.

HeadingMeasurement

@Serializable

data class HeadingMeasurement(val bearing: Bearing, val reference: HeadingReference, val accuracy: Rotation? = null, val measuredAt: Instant)

One measured horizontal direction that a device faces.

HeadingProvider

interface HeadingProvider

Supplies device-heading measurements.

HeadingReference

enum HeadingReference : Enum<HeadingReference>

North reference for a HeadingMeasurement bearing.

data class HeadingRequest(val minimumInterval: Duration = 1.seconds)

Preferences for device-heading updates.

IosHeadingProvider

class IosHeadingProvider : HeadingProvider

Device heading provider backed by CLLocationManager.

IosLocationPermissionRequester

class IosLocationPermissionRequester : <ERROR CLASS> ERROR CLASS: Symbol not found for AutoCloseable

Foreground Core Location permission holder.

IosLocationProvider

class IosLocationProvider : LocationProvider

Foreground location from Core Location.

IosSystemSettingsLauncher

class IosSystemSettingsLauncher : SystemSettingsLauncher

Opens the iOS settings screen related to location.

LocationAccuracy

enum LocationAccuracy : Enum<LocationAccuracy>

Accuracy levels for LocationRequest, which are mapped to platform accuracy and power levels.

LocationAccuracyAuthorization

enum LocationAccuracyAuthorization : Enum<LocationAccuracyAuthorization>

The accuracy level that the user authorized.

LocationBackendAvailability

sealed interface LocationBackendAvailability

Whether a location implementation has a usable platform backend.

sealed interface LocationEvent

Events emitted while collecting LocationProvider.updates.

LocationMeasurement

@Serializable

data class LocationMeasurement(val position: Position, val horizontalAccuracy: Length? = null, val altitudeAccuracy: Length? = null, val distancePerSecond: Length? = null, val distancePerSecondAccuracy: Length? = null, val course: Bearing? = null, val courseAccuracy: Rotation? = null, val measuredAt: Instant)

One measured geographic location.

LocationPermission

sealed interface LocationPermission

Current foreground location authorization.

LocationProvider

interface LocationProvider : AutoCloseable

Supplies foreground location updates and permission status.

LocationRequest

data class LocationRequest(val accuracy: LocationAccuracy = LocationAccuracy.High, val minimumInterval: Duration = 1.seconds, val minimumDistance: Length = 1.meters)

Preferences for foreground location updates.

LocationUnavailableReason

enum LocationUnavailableReason : Enum<LocationUnavailableReason>

Reasons that a provider cannot currently deliver location measurements.

SystemSettingsLauncher

interface SystemSettingsLauncher

Opens system settings screens related to location.

UnsupportedLocationProvider

object UnsupportedLocationProvider : LocationProvider

A provider for a target or host that has no installed location implementation.

XdgPortalWindow

sealed interface XdgPortalWindow

A window that an XDG portal can use as the parent for a system dialog.

Functions

asMapLibreLocationMeasurement

fun Location.asMapLibreLocationMeasurement(): LocationMeasurement

fun ERROR CLASS: Symbol not found for CLLocation.asMapLibreLocationMeasurement(): LocationMeasurement

asMapLibreLocationUpdate

fun Location.asMapLibreLocationUpdate(): LocationEvent.Update

Converts this platform location and preserves its monotonic age at receipt.

createDefaultHeadingProvider

fun createDefaultHeadingProvider(context: Context): HeadingProvider

Creates the default Android heading provider: the discovered backend's provider when one is available, and the sensor-based AndroidHeadingProvider otherwise.

createDefaultLocationProvider

fun createDefaultLocationProvider(context: Context): LocationProvider

Creates the default Android location provider: the discovered backend's provider when one is available, a provider that reports the failure when discovery is misconfigured, and the framework AndroidLocationProvider otherwise.

fun createDefaultLocationProvider(window: XdgPortalWindow? = null): LocationProvider

Creates the default desktop location provider from the installed backend. The provider's system dialogs are parented to window, and LocationProvider.close releases its process resources.