maplibre-compose/org.maplibre.compose.location

Package-level declarations

Types

enum BearingUpdate : Enum<BearingUpdate>

How updateCamera updates camera bearing.

HeadingTrackingStatus

sealed interface HeadingTrackingStatus

Current state of device-heading collection managed by rememberLocationState.

LocationChangeScope

sealed interface LocationChangeScope

The measurements that triggered a LocationTrackingEffect callback.

class LocationState

Lifecycle-aware state for foreground location and heading tracking.

LocationTrackingStatus

sealed interface LocationTrackingStatus

Current state of the foreground location updates managed by rememberLocationState.

Functions

LocationTrackingEffect

fun LocationTrackingEffect(locationState: LocationState, enabled: Boolean = true, trackBearing: Boolean = true, onLocationChange: suspend LocationChangeScope.() -> Unit)

A form of LaunchedEffect that is specialized for tracking user location.

mostAccurateBearing

fun LocationState.mostAccurateBearing(): Bearing?

Returns the most accurate bearing measurement available.

mostAccurateBearingAccuracy

fun LocationState.mostAccurateBearingAccuracy(): Rotation?

Returns the estimated error of mostAccurateBearing, or null when unknown.

rememberDefaultHeadingProvider

actual fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

expect fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

actual fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

actual fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

actual fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

actual fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

rememberDefaultLocationProvider

actual fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

expect fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

actual fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

actual fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

actual fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

actual fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

rememberLocationState

fun rememberLocationState(provider: LocationProvider = rememberDefaultLocationProvider(), request: LocationRequest = LocationRequest.Standard, headingProvider: HeadingProvider = NoHeadingProvider, headingRequest: HeadingRequest = HeadingRequest.Standard, enabled: Boolean = true, lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current, minActiveState: Lifecycle.State = Lifecycle.State.STARTED): LocationState

Remembers foreground location and heading state.

rememberSystemSettingsLauncher

actual fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

expect fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

actual fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

actual fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

actual fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

actual fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

suspend fun LocationChangeScope.updateCamera(mapState: MapState, animation: CameraAnimation? = CameraAnimation.Ease.Standard, updateBearing: BearingUpdate = BearingUpdate.TrackAutomatic)

Convenience method for keeping mapState in sync with the location change that triggered this LocationTrackingEffect callback.