# Print output for @column tags ?>
public
final
class
GpsStatus
extends Object
| java.lang.Object | |
| ↳ | android.location.GpsStatus |
This class is deprecated.
Use GnssStatus instead.
This class represents the current state of the GPS engine and is used in conjunction with GpsStatus.Listener.
Nested classes | |
|---|---|
interface |
GpsStatus.Listener
This interface is deprecated.
Use |
interface |
GpsStatus.NmeaListener
This interface is deprecated.
use |
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 | |
|---|---|
static
GpsStatus
|
create(GnssStatus gnssStatus, int timeToFirstFix)
Builds a GpsStatus from the given GnssStatus. |
int
|
getMaxSatellites()
Returns the maximum number of satellites that can be in the satellite
list that can be returned by |
Iterable<GpsSatellite>
|
getSatellites()
Returns an array of |
int
|
getTimeToFirstFix()
Returns the time required to receive the first fix since the most recent restart of the GPS engine. |
Inherited methods | |
|---|---|
public static final int GPS_EVENT_FIRST_FIX
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
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
Event sent when the GPS system has started.
Constant Value: 1 (0x00000001)
public static final int GPS_EVENT_STOPPED
Event sent when the GPS system has stopped.
Constant Value: 2 (0x00000002)
public static GpsStatus create (GnssStatus gnssStatus, int timeToFirstFix)
Builds a GpsStatus from the given GnssStatus.
| Parameters | |
|---|---|
gnssStatus |
GnssStatus: This value cannot be null. |
timeToFirstFix |
int |
| Returns | |
|---|---|
GpsStatus |
This value cannot be null. |
public int getMaxSatellites ()
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 ()
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 ()
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 |