Added in API level 31

GnssMeasurementRequest

class GnssMeasurementRequest : Parcelable
kotlin.Any
   ↳ android.location.GnssMeasurementRequest

This class contains extra parameters to pass in a GNSS measurement request.

Summary

Nested classes

Builder for GnssMeasurementRequest

Constants
static Int

Represents a passive only request.

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Int

Returns the requested time interval between the reported measurements in milliseconds, or PASSIVE_INTERVAL if this is a passive, no power request.

Int

Boolean

Represents whether to enable full GNSS tracking.

String

Returns a string representation of the object.

Unit
writeToParcel(parcel: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<GnssMeasurementRequest!>

Constants

PASSIVE_INTERVAL

Added in API level 34
static val PASSIVE_INTERVAL: Int

Represents a passive only request. Such a request will not trigger any active GNSS measurements or power usage itself, but may receive GNSS measurements generated in response to other requests.

Note that on Android T, such a request will trigger one GNSS measurement. Another GNSS measurement will be triggered after PASSIVE_INTERVAL and so on.

Value: 2147483647

Public methods

describeContents

Added in API level 31
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 31
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getIntervalMillis

Added in API level 33
fun getIntervalMillis(): Int

Returns the requested time interval between the reported measurements in milliseconds, or PASSIVE_INTERVAL if this is a passive, no power request. A passive request will not actively generate GNSS measurement updates, but may receive GNSS measurement updates generated as a result of other GNSS measurement requests.

If the time interval is not set, the default value is 0, which means the fastest rate the GNSS chipset can report.

The GNSS chipset may report measurements with a rate faster than requested.

Note that on Android T, a request interval of PASSIVE_INTERVAL will first trigger one GNSS measurement. Another GNSS measurement will be triggered after PASSIVE_INTERVAL milliseconds ans so on.

Return
Int Value is 0 or greater

hashCode

Added in API level 31
fun hashCode(): Int
Return
Int a hash code value for this object.

isFullTracking

Added in API level 31
fun isFullTracking(): Boolean

Represents whether to enable full GNSS tracking.

If true, GNSS chipset switches off duty cycling. In such a mode, no clock discontinuities are expected, and when supported, carrier phase should be continuous in good signal conditions. All non-blocklisted, healthy constellations, satellites and frequency bands that are meaningful to positioning accuracy must be tracked and reported in this mode. The GNSS chipset will consume more power in full tracking mode than in duty cycling mode. If false, GNSS chipset optimizes power via duty cycling, constellations and frequency limits, etc.

Full GNSS tracking mode affects GnssMeasurement and other GNSS functionalities including GNSS location.

toString

Added in API level 31
fun toString(): String

Returns a string representation of the object.

Return
String This value cannot be null.

writeToParcel

Added in API level 31
fun writeToParcel(
    parcel: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest The Parcel in which the object should be written. This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
parcel Parcel: This value cannot be null.

Properties

CREATOR

Added in API level 31
static val CREATOR: Parcelable.Creator<GnssMeasurementRequest!>