location/org.maplibre.compose.location

Package-level declarations

Types

AndroidLocationBackend

interface AndroidLocationBackend

An Android location implementation discovered through ServiceLoader.

AndroidLocationPermissionRequester

class AndroidLocationPermissionRequester(context: Context)

Observes and requests foreground location permission on Android.

AndroidLocationProvider

class AndroidLocationProvider : LocationProvider

A LocationProvider built on the LocationManager platform APIs.

AndroidOrientationProvider

class AndroidOrientationProvider(context: Context, updateInterval: Duration, coroutineScope: CoroutineScope, sharingStarted: SharingStarted = SharingStarted.WhileSubscribed(stopTimeoutMillis = 1000)) : OrientationProvider

An OrientationProvider built on Android's SensorManager.

AndroidSystemSettingsLauncher

class AndroidSystemSettingsLauncher(context: Context) : SystemSettingsLauncher

Opens Android settings screens related to location.

BearingWithAccuracy

@Serializable

data class BearingWithAccuracy(val value: Bearing, val accuracy: Rotation?)

Represents a bearing value with its potential accuracy.

BrowserLocationPermissionRequester

class BrowserLocationPermissionRequester

Observes and requests browser geolocation permission.

BrowserLocationProvider

class BrowserLocationProvider : LocationProvider

A browser location provider backed by the 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.

DesktopLocationProvider

interface DesktopLocationProvider : LocationProvider, AutoCloseable

A desktop provider whose process resources can be released with close.

DesktopSystemSettingsLauncher

class DesktopSystemSettingsLauncher : SystemSettingsLauncher

Opens the desktop settings screen related to location.

IosLocationPermissionRequester

class IosLocationPermissionRequester

Foreground Core Location permission holder.

IosLocationProvider

class IosLocationProvider : LocationProvider

A LocationProvider built on CLLocationManager.

IosOrientationProvider

class IosOrientationProvider(updateInterval: ERROR CLASS: Symbol not found for Duration, coroutineScope: ERROR CLASS: Symbol not found for CoroutineScope, sharingStarted: ERROR CLASS: Symbol not found for SharingStarted = SharingStarted.WhileSubscribed(stopTimeoutMillis = 1000)) : OrientationProvider

Device heading provider backed by CLLocationManager.

IosSystemSettingsLauncher

class IosSystemSettingsLauncher : SystemSettingsLauncher

Opens the iOS settings screen related to location.

Location

@Serializable

data class Location(val position: PositionWithAccuracy, val altitudeAccuracy: Length? = null, val speed: SpeedWithAccuracy? = null, val course: BearingWithAccuracy? = null, val timestamp: TimeMark)

Describes a user's 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.

LocationEvent

sealed interface LocationEvent

Events emitted while collecting LocationProvider.updates.

LocationPermission

sealed interface LocationPermission

Current foreground location authorization.

LocationProvider

interface LocationProvider

This is an intentionally very limited abstraction over the various platform APIs for geolocation. It is specialized to the use case of maplibre-compose.

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.

NullOrientationProvider

object NullOrientationProvider : OrientationProvider

An orientation provider that never supplies a heading.

Orientation

@Serializable

data class Orientation(val orientation: BearingWithAccuracy? = null, val timestamp: TimeMark)

A device-heading measurement.

OrientationProvider

interface OrientationProvider

Supplies device-heading measurements.

PositionWithAccuracy

@Serializable

data class PositionWithAccuracy(val value: Position, val accuracy: Length?)

Represents a geographical position with an associated accuracy.

SpeedWithAccuracy

@Serializable

data class SpeedWithAccuracy(val distancePerSecond: Length, val accuracy: Length?)

Represents a speed value with its potential accuracy.

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

asMapLibreLocation

fun Location.asMapLibreLocation(): Location

fun ERROR CLASS: Symbol not found for CLLocation.asMapLibreLocation(): Location

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): DesktopLocationProvider

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

createDefaultOrientationProvider

fun createDefaultOrientationProvider(context: Context, updateInterval: Duration, coroutineScope: CoroutineScope): OrientationProvider

Creates the default Android orientation provider: the discovered backend's provider when one is available, and the sensor-based AndroidOrientationProvider otherwise. coroutineScope shares the provider's orientation flow.