Android APIs
public final class

GpsStatus

extends Object
java.lang.Object
   ↳ android.location.GpsStatus

Class Overview

This class represents the current state of the GPS engine. This class is used in conjunction with the GpsStatus.Listener interface.

Summary

Nested Classes
interface GpsStatus.Listener Used for receiving notifications when GPS status has changed. 
interface GpsStatus.NmeaListener Used for receiving NMEA sentences from the GPS. 
Constants
int GPS_EVENT_FIRST_FIX Event sent when the GPS system has received its first fix since starting.
int GPS_EVENT_SATELLITE_STATUS Event sent periodically to report GPS satellite status.
int GPS_EVENT_STARTED Event sent when the GPS system has started.
int GPS_EVENT_STOPPED Event sent when the GPS system has stopped.
Public Methods
int getMaxSatellites()
Returns the maximum number of satellites that can be in the satellite list that can be returned by getSatellites().
Iterable<GpsSatellite> getSatellites()
Returns an array of GpsSatellite objects, which represent the current state of the GPS engine.
int getTimeToFirstFix()
Returns the time required to receive the first fix since the most recent restart of the GPS engine.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int GPS_EVENT_FIRST_FIX

Added in API level 3

Event sent when the GPS system has received its first fix since starting. Call getTimeToFirstFix() to find the time from start to first fix.

Constant Value: 3 (0x00000003)

public static final int GPS_EVENT_SATELLITE_STATUS

Added in API level 3

Event sent periodically to report GPS satellite status. Call getSatellites() to retrieve the status for each satellite.

Constant Value: 4 (0x00000004)

public static final int GPS_EVENT_STARTED

Added in API level 3

Event sent when the GPS system has started.

Constant Value: 1 (0x00000001)

public static final int GPS_EVENT_STOPPED

Added in API level 3

Event sent when the GPS system has stopped.

Constant Value: 2 (0x00000002)

Public Methods

public int getMaxSatellites ()

Added in API level 3

Returns the maximum number of satellites that can be in the satellite list that can be returned by getSatellites().

Returns
int the maximum number of satellites

public Iterable<GpsSatellite> getSatellites ()

Added in API level 3

Returns an array of GpsSatellite objects, which represent the current state of the GPS engine.

Returns
Iterable<GpsSatellite> the list of satellites

public int getTimeToFirstFix ()

Added in API level 3

Returns the time required to receive the first fix since the most recent restart of the GPS engine.

Returns
int time to first fix in milliseconds