Added in API level 24

GnssStatus

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

This class represents the current state of the GNSS engine and is used in conjunction with GnssStatus.Callback.

Summary

Nested classes

Builder class to help create new GnssStatus instances.
abstract

Used for receiving notifications when GNSS events happen.
Constants
static Int

Constellation type constant for Beidou.
static Int

Constellation type constant for Galileo.
static Int

Constellation type constant for Glonass.
static Int

Constellation type constant for GPS.
static Int

Constellation type constant for IRNSS.
static Int

Constellation type constant for QZSS.
static Int

Constellation type constant for SBAS.
static Int

Unknown constellation type.
Inherited constants
Public methods
Int

Boolean
equals(other: Any?)
Float
getAzimuthDegrees(satelliteIndex: Int)

Retrieves the azimuth the satellite at the specified index.
Float
getBasebandCn0DbHz(satelliteIndex: Int)

Retrieves the baseband carrier-to-noise density of the satellite at the specified index in dB-Hz.
Float
getCarrierFrequencyHz(satelliteIndex: Int)

Gets the carrier frequency of the signal tracked.
Float
getCn0DbHz(satelliteIndex: Int)

Retrieves the carrier-to-noise density at the antenna of the satellite at the specified index in dB-Hz.
Int
getConstellationType(satelliteIndex: Int)

Retrieves the constellation type of the satellite at the specified index.
Float
getElevationDegrees(satelliteIndex: Int)

Retrieves the elevation of the satellite at the specified index.
Int

Gets the total number of satellites in satellite list.
Int
getSvid(satelliteIndex: Int)

Gets the identification number for the satellite at the specific index.
Boolean
hasAlmanacData(satelliteIndex: Int)

Reports whether the satellite at the specified index has almanac data.
Boolean
hasBasebandCn0DbHz(satelliteIndex: Int)

Reports whether a valid getBasebandCn0DbHz(int satelliteIndex) is available.
Boolean
hasCarrierFrequencyHz(satelliteIndex: Int)

Reports whether a valid getCarrierFrequencyHz(int satelliteIndex) is available.
Boolean
hasEphemerisData(satelliteIndex: Int)

Reports whether the satellite at the specified index has ephemeris data.
Int

Boolean
usedInFix(satelliteIndex: Int)

Reports whether the satellite at the specified index was used in the calculation of the most recent position fix.
Unit
writeToParcel(parcel: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<GnssStatus!>

Constants

CONSTELLATION_BEIDOU

Added in API level 24
static val CONSTELLATION_BEIDOU: Int

Constellation type constant for Beidou.

Value: 5

CONSTELLATION_GALILEO

Added in API level 24
static val CONSTELLATION_GALILEO: Int

Constellation type constant for Galileo.

Value: 6

CONSTELLATION_GLONASS

Added in API level 24
static val CONSTELLATION_GLONASS: Int

Constellation type constant for Glonass.

Value: 3

CONSTELLATION_GPS

Added in API level 24
static val CONSTELLATION_GPS: Int

Constellation type constant for GPS.

Value: 1

CONSTELLATION_IRNSS

Added in API level 29
static val CONSTELLATION_IRNSS: Int

Constellation type constant for IRNSS.

Value: 7

CONSTELLATION_QZSS

Added in API level 24
static val CONSTELLATION_QZSS: Int

Constellation type constant for QZSS.

Value: 4

CONSTELLATION_SBAS

Added in API level 24
static val CONSTELLATION_SBAS: Int

Constellation type constant for SBAS.

Value: 2

CONSTELLATION_UNKNOWN

Added in API level 24
static val CONSTELLATION_UNKNOWN: Int

Unknown constellation type.

Value: 0

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 24
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.

getAzimuthDegrees

Added in API level 24
fun getAzimuthDegrees(satelliteIndex: Int): Float

Retrieves the azimuth the satellite at the specified index.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater
Return
Float Value is between 0 and 360 inclusive

getBasebandCn0DbHz

Added in API level 30
fun getBasebandCn0DbHz(satelliteIndex: Int): Float

Retrieves the baseband carrier-to-noise density of the satellite at the specified index in dB-Hz.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater
Return
Float Value is between 0 and 63 inclusive

getCarrierFrequencyHz

Added in API level 26
fun getCarrierFrequencyHz(satelliteIndex: Int): Float

Gets the carrier frequency of the signal tracked.

For example it can be the GPS central frequency for L1 = 1575.45 MHz, or L2 = 1227.60 MHz, L5 = 1176.45 MHz, varying GLO channels, etc.

The value is only available if hasCarrierFrequencyHz(int satelliteIndex) is true.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater
Return
Float Value is 0 or greater

getCn0DbHz

Added in API level 24
fun getCn0DbHz(satelliteIndex: Int): Float

Retrieves the carrier-to-noise density at the antenna of the satellite at the specified index in dB-Hz.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater
Return
Float Value is between 0 and 63 inclusive

getConstellationType

Added in API level 24
fun getConstellationType(satelliteIndex: Int): Int

Retrieves the constellation type of the satellite at the specified index.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater
Return
Int Value is android.location.GnssStatus#CONSTELLATION_UNKNOWN, android.location.GnssStatus#CONSTELLATION_GPS, android.location.GnssStatus#CONSTELLATION_SBAS, android.location.GnssStatus#CONSTELLATION_GLONASS, android.location.GnssStatus#CONSTELLATION_QZSS, android.location.GnssStatus#CONSTELLATION_BEIDOU, android.location.GnssStatus#CONSTELLATION_GALILEO, or android.location.GnssStatus#CONSTELLATION_IRNSS

getElevationDegrees

Added in API level 24
fun getElevationDegrees(satelliteIndex: Int): Float

Retrieves the elevation of the satellite at the specified index.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater
Return
Float Value is between -90 and 90 inclusive

getSatelliteCount

Added in API level 24
fun getSatelliteCount(): Int

Gets the total number of satellites in satellite list.

Return
Int Value is 0 or greater

getSvid

Added in API level 24
fun getSvid(satelliteIndex: Int): Int

Gets the identification number for the satellite at the specific index.

This svid is pseudo-random number for most constellations. It is FCN & OSN number for Glonass.

The distinction is made by looking at constellation field getConstellationType(int) Expected values are in the range of:

  • GPS: 1-32
  • SBAS: 120-151, 183-192
  • GLONASS: One of: OSN, or FCN+100
    • 1-25 as the orbital slot number (OSN) (preferred, if known)
    • 93-106 as the frequency channel number (FCN) (-7 to +6) plus 100. i.e. encode FCN of -7 as 93, 0 as 100, and +6 as 106
  • QZSS: 183-206
  • Galileo: 1-36
  • Beidou: 1-63
  • IRNSS: 1-14
Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater
Return
Int Value is between 1 and 206 inclusive

hasAlmanacData

Added in API level 24
fun hasAlmanacData(satelliteIndex: Int): Boolean

Reports whether the satellite at the specified index has almanac data.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater

hasBasebandCn0DbHz

Added in API level 30
fun hasBasebandCn0DbHz(satelliteIndex: Int): Boolean

Reports whether a valid getBasebandCn0DbHz(int satelliteIndex) is available.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater

hasCarrierFrequencyHz

Added in API level 26
fun hasCarrierFrequencyHz(satelliteIndex: Int): Boolean

Reports whether a valid getCarrierFrequencyHz(int satelliteIndex) is available.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater

hasEphemerisData

Added in API level 24
fun hasEphemerisData(satelliteIndex: Int): Boolean

Reports whether the satellite at the specified index has ephemeris data.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater

hashCode

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

usedInFix

Added in API level 24
fun usedInFix(satelliteIndex: Int): Boolean

Reports whether the satellite at the specified index was used in the calculation of the most recent position fix.

Parameters
satelliteIndex Int: An index from zero to getSatelliteCount() - 1 Value is 0 or greater

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<GnssStatus!>