PySide6.QtPositioning.QGeoPositionInfoSource

class QGeoPositionInfoSource

The QGeoPositionInfoSource class is an abstract base class for the distribution of positional updates. More…

Inheritance diagram of PySide6.QtPositioning.QGeoPositionInfoSource

Inherited by: QNmeaPositionInfoSource

Synopsis

Properties

Methods

Virtual methods

Signals

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

The static function createDefaultSource() creates a default position source that is appropriate for the platform, if one is available. Otherwise, QGeoPositionInfoSource will check for available plugins that implement the QGeoPositionInfoSourceFactory interface.

Users of a QGeoPositionInfoSource subclass can request the current position using requestUpdate() , or start and stop regular position updates using startUpdates() and stopUpdates() . When an update is available, positionUpdated() is emitted. The last known position can be accessed with lastKnownPosition() .

If regular position updates are required, setUpdateInterval() can be used to specify how often these updates should be emitted. If no interval is specified, updates are simply provided whenever they are available. For example:

// Emit updates every 10 seconds if available
QGeoPositionInfoSource *source = QGeoPositionInfoSource::createDefaultSource(0);
if (source)
    source->setUpdateInterval(10000);

To remove an update interval that was previously set, call setUpdateInterval() with a value of 0.

Note

The position source may have a minimum value requirement for update intervals, as returned by minimumUpdateInterval() .

Note

To use this class from Android service, see Qt Positioning on Android .

class Error

The Error enumeration represents the errors which can occur.

Constant

Description

QGeoPositionInfoSource.AccessError

The connection setup to the remote positioning backend failed because the application lacked the required privileges.

QGeoPositionInfoSource.ClosedError

The remote positioning backend closed the connection, which happens for example in case the user is switching location services to off. As soon as the location service is re-enabled regular updates will resume.

QGeoPositionInfoSource.NoError

No error has occurred.

QGeoPositionInfoSource.UnknownSourceError

An unidentified error occurred.

QGeoPositionInfoSource.UpdateTimeoutError

If requestUpdate() was called, this error indicates that the current position could not be retrieved within the specified timeout. If startUpdates() was called, this error indicates that this QGeoPositionInfoSource subclass determined that it will not be able to provide further regular updates. In the latter case the error would not be emitted again until after the regular updates resume.
class PositioningMethod

(inherits enum.Flag) Defines the types of positioning methods.

Constant

Description

QGeoPositionInfoSource.NoPositioningMethods

None of the positioning methods.

QGeoPositionInfoSource.SatellitePositioningMethods

Satellite-based positioning methods such as GPS or GLONASS.

QGeoPositionInfoSource.NonSatellitePositioningMethods

Other positioning methods such as 3GPP cell identifier or WiFi based positioning.

QGeoPositionInfoSource.AllPositioningMethods

Satellite-based positioning methods as soon as available. Otherwise non-satellite based methods.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property minimumUpdateIntervalᅟ: int

This property holds This property holds the minimum time (in milliseconds) required to retrieve a position update..

This is the minimum value accepted by setUpdateInterval() and requestUpdate() .

Access functions:
property preferredPositioningMethodsᅟ: Combination of QGeoPositionInfoSource.PositioningMethod

This property holds Sets the preferred positioning methods for this source..

If new methods include a method that is not supported by the source, the unsupported method will be ignored.

If new methods do not include a single method available/supported by the source, the preferred methods will be set to the set of methods which the source has available. If the source has no method availabe (e.g. because its Location service is turned off or it does not offer a Location service), the passed methods are accepted as they are.

The default value for this property is NoPositioningMethods .

Note

Subclass implementations must call the base implementation of setPreferredPositioningMethods() to ensure preferredPositioningMethods() returns the correct value.

See also

supportedPositioningMethods()

Access functions:
property sourceNameᅟ: str

This property holds This property holds the unique name of the position source implementation in use..

This is the same name that can be passed to createSource() in order to create a new instance of a particular position source implementation.

Access functions:
property updateIntervalᅟ: int

This property holds This property holds the requested interval in milliseconds between each update..

If the update interval is not set (or is set to 0) the source will provide updates as often as necessary.

If the update interval is set, the source will provide updates at an interval as close to the requested interval as possible. If the requested interval is less than the minimumUpdateInterval() , the minimum interval is used instead.

Changes to the update interval will happen as soon as is practical, however the time the change takes may vary between implementations. Whether or not the elapsed time from the previous interval is counted as part of the new interval is also implementation dependent.

The default value for this property is 0.

Note

Subclass implementations must call the base implementation of setUpdateInterval() so that updateInterval() returns the correct value.

Note

This property can’t be used to tune update frequency on iOS and macOS, because their APIs do not provide such possibility. On these systems this parameter is only used to set UpdateTimeoutError and trigger an errorOccurred signal if the update is not received within the desired interval.

Access functions:
__init__(parent)
Parameters:

parent – QObject

Creates a position source with the specified parent.

static availableSources()
Return type:

list of strings

Returns a list of available source plugins. This includes any default backend plugin for the current platform.

backendProperty(name)
Parameters:

name – str

Return type:

object

Returns the value of the backend-specific property named name, if present. Otherwise, the returned value will be invalid. Supported backend-specific properties are listed and described in Qt Positioning plugins#Default plugins .

static createDefaultSource(parent)
Parameters:

parent – QObject

Return type:

QGeoPositionInfoSource

Creates and returns a position source with the given parent that reads from the system’s default sources of location data, or the plugin with the highest available priority.

Returns nullptr if the system has no default position source, no valid plugins could be found or the user does not have the permission to access the current position.

static createDefaultSource(parameters, parent)
Parameters:

  • parameters – Dictionary with keys of type .QString and values of type QVariant.

  • parent – QObject

Return type:

QGeoPositionInfoSource

Creates and returns a position source with the given parent that reads from the system’s default sources of location data, or the plugin with the highest available priority.

Returns nullptr if the system has no default position source, no valid plugins could be found or the user does not have the permission to access the current position.

This method passes parameters to the factory to configure the source.

static createSource(sourceName, parent)
Parameters:

  • sourceName – str

  • parent – QObject

Return type:

QGeoPositionInfoSource

Creates and returns a position source with the given parent, by loading the plugin named sourceName.

Returns nullptr if the plugin cannot be found.

static createSource(sourceName, parameters, parent)
Parameters:

  • sourceName – str

  • parameters – Dictionary with keys of type .QString and values of type QVariant.

  • parent – QObject

Return type:

QGeoPositionInfoSource

Creates and returns a position source with the given parent, by loading the plugin named sourceName.

Returns nullptr if the plugin cannot be found.

This method passes parameters to the factory to configure the source.

abstract error()
Return type:

Error

Returns the type of error that last occurred.

Note

Since Qt6 the last error is always reset when calling startUpdates() or requestUpdate() .

errorOccurred(positioningError)
Parameters:

positioningError – Error

This signal is emitted after an error occurred. The positioningError parameter describes the type of error that occurred.

abstract lastKnownPosition([fromSatellitePositioningMethodsOnly=false])
Parameters:

fromSatellitePositioningMethodsOnly – bool

Return type:

QGeoPositionInfo

Returns an update containing the last known position, or a null update if none is available.

If fromSatellitePositioningMethodsOnly is true, this returns the last known position received from a satellite positioning method; if none is available, a null update is returned.

abstract minimumUpdateInterval()
Return type:

int

Getter of property minimumUpdateIntervalᅟ .

positionUpdated(update)
Parameters:

update – QGeoPositionInfo

If startUpdates() or requestUpdate() is called, this signal is emitted when an update becomes available.

The update value holds the value of the new update.

preferredPositioningMethods()
Return type:

Combination of PositioningMethod

See also

setPreferredPositioningMethods()

Getter of property preferredPositioningMethodsᅟ .

abstract requestUpdate([timeout=0])
Parameters:

timeout – int

Attempts to get the current position and emit positionUpdated() with this information. If the current position cannot be found within the given timeout (in milliseconds) or if timeout is less than the value returned by minimumUpdateInterval() , an errorOccurred() signal with the UpdateTimeoutError is emitted.

If the timeout is zero, the timeout defaults to a reasonable timeout period as appropriate for the source.

This does nothing if another update request is in progress. However it can be called even if startUpdates() has already been called and regular updates are in progress.

If the source uses multiple positioning methods, it tries to get the current position from the most accurate positioning method within the given timeout.

Note

Since Qt6 this method always resets the last error to NoError before requesting the position.

Note

To understand how to use this method from an Android service, see Qt Positioning on Android .

setBackendProperty(name, value)
Parameters:

  • name – str

  • value – object

Return type:

bool

Sets the backend-specific property named name to value. Returns true on success, false otherwise. Backend-specific properties can be used to configure the positioning subsystem behavior at runtime. Supported backend-specific properties are listed and described in Qt Positioning plugins#Default plugins .

See also

backendProperty

setPreferredPositioningMethods(methods)
Parameters:

methods – Combination of PositioningMethod

See also

preferredPositioningMethods()

Setter of property preferredPositioningMethodsᅟ .

setUpdateInterval(msec)
Parameters:

msec – int

See also

updateInterval()

Setter of property updateIntervalᅟ .

sourceName()
Return type:

str

Getter of property sourceNameᅟ .

abstract startUpdates()

Starts emitting updates at regular intervals as specified by setUpdateInterval() .

If setUpdateInterval() has not been called, the source will emit updates as soon as they become available.

An errorOccurred() signal with the UpdateTimeoutError will be emitted if this QGeoPositionInfoSource subclass determines that it will not be able to provide regular updates. This could happen if a satellite fix is lost or if a hardware error is detected. Position updates will recommence if the data becomes available later on. The UpdateTimeoutError error will not be emitted again until after the periodic updates resume.

Note

Since Qt6 this method always resets the last error to NoError before starting the updates.

Note

To understand how to use this method from an Android service, see Qt Positioning on Android .

On iOS, starting from version 8, Core Location framework requires additional entries in the application’s Info.plist with keys NSLocationAlwaysUsageDescription or NSLocationWhenInUseUsageDescription and a string to be displayed in the authorization prompt. The key NSLocationWhenInUseUsageDescription is used when requesting permission to use location services while the app is in the foreground. The key NSLocationAlwaysUsageDescription is used when requesting permission to use location services whenever the app is running (both the foreground and the background). If both entries are defined, NSLocationWhenInUseUsageDescription has a priority in the foreground mode.

abstract stopUpdates()

Stops emitting updates at regular intervals.

abstract supportedPositioningMethods()
Return type:

Combination of PositioningMethod

Returns the positioning methods available to this source. Availability is defined as being usable at the time of calling this function. Therefore user settings like turned off location service or limitations to Satellite-based position providers are reflected by this function. Runtime notifications when the status changes can be obtained via supportedPositioningMethodsChanged() .

Not all platforms distinguish the different positioning methods or communicate the current user configuration of the device. The following table provides an overview of the current platform situation:

Platform

Brief Description

Android

Individual provider status and general Location service state are known and communicated when location service is active.

GeoClue

Hardcoced to always return AllPositioningMethods .

GeoClue2

Individual providers are not distinguishable but disabled Location services reflected.

iOS

Hardcoced to always return AllPositioningMethods .

macOS

Hardcoced to always return AllPositioningMethods .

Windows (UWP)

Individual providers are not distinguishable but disabled Location services reflected.

See also

supportedPositioningMethodsChanged() setPreferredPositioningMethods()

supportedPositioningMethodsChanged()

This signal is emitted when the supported positioning methods changed. The cause for a change could be a user turning Location services on/off or restricting Location services to certain types (e.g. GPS only). Note that changes to the supported positioning methods cannot be detected on all platforms. supportedPositioningMethods() provides an overview of the current platform support.

updateInterval()
Return type:

int

See also

setUpdateInterval()

Getter of property updateIntervalᅟ .