LocationCompat

const val EXTRA_BEARING_ACCURACY = "bearingAccuracy": String!

Constant used as a key to store bearing accuracy in getExtras for Android SDK levels below Oreo (26).

const val EXTRA_IS_MOCK = "mockLocation": String!

Constant used as a key to store mock location status in getExtras for Android SDK levels below JBMR2 (18).

const val EXTRA_MSL_ALTITUDE = "androidx.core.location.extra.MSL_ALTITUDE": String!

Constant used as a key to store Mean Sea Level altitude in getExtras.

const val EXTRA_MSL_ALTITUDE_ACCURACY = "androidx.core.location.extra.MSL_ALTITUDE_ACCURACY": String!

Constant used as a key to store Mean Sea Level altitude in getExtras.

const val EXTRA_SPEED_ACCURACY = "speedAccuracy": String!

Constant used as a key to store speed accuracy in getExtras for Android SDK levels below Oreo (26).

const val EXTRA_VERTICAL_ACCURACY = "verticalAccuracy": String!

Constant used as a key to store vertical accuracy in getExtras for Android SDK levels below Oreo (26).

java-static fun getBearingAccuracyDegrees(location: Location): Float

Get the estimated bearing accuracy of this location in degrees.

NOTE: On API levels below 26, the concept of bearing accuracy does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to read a float extra with the key EXTRA_BEARING_ACCURACY and return the result.

java-static fun getElapsedRealtimeMillis(location: Location): Long

Return the time of this fix, in milliseconds of elapsed real-time since system boot.

@ReplaceWith(expression = "location.getElapsedRealtimeNanos()")
java-static fun getElapsedRealtimeNanos(location: Location): Long

Return the time of this fix, in nanoseconds of elapsed real-time since system boot.

This value can be reliably compared to SystemClock.elapsedRealtimeNanos(), to calculate the age of a fix and to compare location fixes. This is reliable because elapsed real-time is guaranteed monotonic for each system boot and continues to increment even when the system is in deep sleep (unlike getTime().

All locations generated by the LocationManager are guaranteed to have a valid elapsed real-time.

NOTE: On API levels below 17, this method will attempt to provide an elapsed realtime based on the difference between system time and the location time. This should be taken as a best "guess" at what the elapsed realtime might have been, but if the clock used for location derivation is different from the system clock, the results may be inaccurate.

java-static fun getMslAltitudeAccuracyMeters(location: Location): @FloatRange(from = 0.0) Float

Returns the estimated Mean Sea Level altitude accuracy in meters of the location at the 68th percentile confidence level. This means that there is 68% chance that the true Mean Sea Level altitude of the location falls within getMslAltitudeMeters +/- this uncertainty.

This is only valid if hasMslAltitudeAccuracy is true.

NOTE: On API levels below 34, the concept of Mean Sea Level altitude accuracy does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to read a float extra with the key EXTRA_MSL_ALTITUDE_ACCURACY and return the result.

java-static fun getMslAltitudeMeters(location: Location): Double

Returns the Mean Sea Level altitude of the location in meters.

This is only valid if hasMslAltitude is true.

NOTE: On API levels below 34, the concept of Mean Sea Level altitude does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to read a double extra with the key EXTRA_MSL_ALTITUDE and return the result.

java-static fun getSpeedAccuracyMetersPerSecond(location: Location): Float

Get the estimated speed accuracy of this location in meters per second.

NOTE: On API levels below 26, the concept of speed accuracy does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to read a float extra with the key EXTRA_SPEED_ACCURACY and return the result.

java-static fun getVerticalAccuracyMeters(location: Location): Float

Get the estimated vertical accuracy of this location in meters.

NOTE: On API levels below 26, the concept of vertical accuracy does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to read a float extra with the key EXTRA_VERTICAL_ACCURACY and return the result.

java-static fun hasBearingAccuracy(location: Location): Boolean

Returns true if this location has a bearing accuracy.

java-static fun hasMslAltitude(location: Location): Boolean

Returns true if the location has a Mean Sea Level altitude, false otherwise.

NOTE: On API levels below 34, the concept of Mean Sea Level altitude does not exist. In order to allow for backwards compatibility and testing however, this method will return true if an extra value is with the key EXTRA_MSL_ALTITUDE.

java-static fun hasMslAltitudeAccuracy(location: Location): Boolean

Returns true if the location has a Mean Sea Level altitude accuracy, false otherwise.

NOTE: On API levels below 34, the concept of Mean Sea Level altitude accuracy does not exist. In order to allow for backwards compatibility and testing however, this method will return true if an extra value is with the key EXTRA_MSL_ALTITUDE_ACCURACY.

java-static fun hasSpeedAccuracy(location: Location): Boolean

Returns true if this location has a speed accuracy.

java-static fun hasVerticalAccuracy(location: Location): Boolean

Returns true if this location has a vertical accuracy.

java-static fun isMock(location: Location): Boolean

Returns true if this location is marked as a mock location. If this location comes from the Android framework, this indicates that the location was provided by a test location provider, and thus may not be related to the actual location of the device.

NOTE: On API levels below 18, the concept of a mock location does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to read a boolean extra with the key EXTRA_IS_MOCK and use the result to determine whether this should be considered a mock location.

java-static fun removeBearingAccuracy(location: Location): Unit

Removes the bearing accuracy from the location.

java-static fun removeMslAltitude(location: Location): Unit

Removes the Mean Sea Level altitude from the location.

NOTE: On API levels below 34, the concept of Mean Sea Level altitude does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to remove any extra value with the key EXTRA_MSL_ALTITUDE.

java-static fun removeMslAltitudeAccuracy(location: Location): Unit

Removes the Mean Sea Level altitude accuracy from the location.

NOTE: On API levels below 34, the concept of Mean Sea Level altitude accuracy does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to remove any extra value with the key EXTRA_MSL_ALTITUDE_ACCURACY.

java-static fun removeSpeedAccuracy(location: Location): Unit

Removes the speed accuracy from the location.

java-static fun removeVerticalAccuracy(location: Location): Unit

Removes the vertical accuracy from the location.

java-static fun setBearingAccuracyDegrees(location: Location, bearingAccuracyD: Float): Unit

Set the estimated bearing accuracy of this location in degrees.

NOTE: On API levels below 26, the concept of bearing accuracy does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to set a float extra with the key EXTRA_BEARING_ACCURACY to include bearing accuracy. Be aware that this will overwrite any prior extra value under the same key.

java-static fun setMock(location: Location, mock: Boolean): Unit

Sets whether this location is marked as a mock location.

NOTE: On API levels below 18, the concept of a mock location does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to set a boolean extra with the key EXTRA_IS_MOCK to mark the location as mock. Be aware that this will overwrite any prior extra value under the same key.

java-static fun setMslAltitudeAccuracyMeters(
    location: Location,
    mslAltitudeAccuracyMeters: @FloatRange(from = 0.0) Float
): Unit

Sets the Mean Sea Level altitude accuracy of the location in meters.

NOTE: On API levels below 34, the concept of Mean Sea Level altitude accuracy does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to set a float extra with the key EXTRA_MSL_ALTITUDE_ACCURACY to include Mean Sea Level altitude accuracy. Be aware that this will overwrite any prior extra value under the same key.

java-static fun setMslAltitudeMeters(location: Location, mslAltitudeMeters: Double): Unit

Sets the Mean Sea Level altitude of the location in meters.

NOTE: On API levels below 34, the concept of Mean Sea Level altitude does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to set a double extra with the key EXTRA_MSL_ALTITUDE to include Mean Sea Level altitude. Be aware that this will overwrite any prior extra value under the same key.

java-static fun setSpeedAccuracyMetersPerSecond(
    location: Location,
    speedAccuracyMps: Float
): Unit

Set the estimated speed accuracy of this location in meters per second.

NOTE: On API levels below 26, the concept of speed accuracy does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to set a float extra with the key EXTRA_SPEED_ACCURACY to include speed accuracy. Be aware that this will overwrite any prior extra value under the same key.

java-static fun setVerticalAccuracyMeters(location: Location, verticalAccuracyM: Float): Unit

Set the estimated vertical accuracy of this location in meters.

NOTE: On API levels below 26, the concept of vertical accuracy does not exist. In order to allow for backwards compatibility and testing however, this method will attempt to set a float extra with the key EXTRA_VERTICAL_ACCURACY to include vertical accuracy. Be aware that this will overwrite any prior extra value under the same key.