Variables
static final int	EVENT_GPS_INFO = 1
	Get GPS information. More...

static final int	EVENT_NAVIGATION_INFO = 2
	Get navigation information. More...

static final int	EVENT_SPEEDLIMIT = 3
	Get speed limit and velocity information. More...

static final int	EVENT_DESTINATION_REACHED = 4
	Get a message when the destination was reached. More...

static final int	EVENT_NAVIGATION_STOPPED = 5
	Get a message when the navigation was stopped by the user. More...

static final int	EVENT_REROUTE = 6
	Get a message when a rerouting occured. More...

static final int	EVENT_AREA_ALERT = 7
	Get a message when an area is entered or left. More...

static final int	EVENT_BORDER_CROSSED = 8
	Get a message when a country is entered and/or left. More...

static final int	EVENT_ROUTE_CORRIDOR_CROSSED = 9
	Get a message when a corridor around the route is entered and/or left. More...

static final int	EVENT_BUDDY_ALERT = 10
	Get a message when a buddy alert was triggered. More...

static final int	EVENT_CURRENT_TOUR_ADDED_STATION = 11
	Get a message when a station was added to the current tour by the user. More...

static final int	EVENT_CURRENT_TOUR_INSERTED_STATION = 12
	Get a message when a station was inserted to the current tour by the user. More...

static final int	EVENT_CURRENT_TOUR_DELETED_STATION = 13
	Get a message when a station was deleted from the current tour by the user. More...

static final int	EVENT_CURRENT_TOUR_MOVED_STATION = 14
	Get a message when a station of the current tour was moved by the user. More...

static final int	EVENT_CURRENT_TOUR_CHANGED_STATION = 15
	Get a message when a station of the current tour was changed by the user (like changing the coordinates or the name) More...

static final int	EVENT_CURRENT_TOUR_CHANGED_STATUS_OF_STATION = 16
	Get a message when the status of a station (skipped, visited) of the current tour was changed by the user. More...

Detailed Description

Variable Documentation

◆ EVENT_GPS_INFO

final int EVENT_GPS_INFO = 1

staticpackage

Get GPS information.

The PTV Navigator will send this message frequently with the appropriate fields filled in when a client before registered itself at the service for getting GPS information.
This is done by setting the "EventType" value of the attached bundle to EVENT_GPS_INFO.
To get information when the PTV Navigator is not the foreground application, be sure to set the "GPS active in the background" option in the PTV Navigator settings, otherwise no information will be sent.

Attention: Information will only be sent when a navigation is running and the gps settings of the PTV Navigator are set to "GPS active in background".

Sending a message with this bundle key will register the listening to this event.
Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type
MercPosX	The mercator x position	int
MercPosY	The mercator y position	int
GeoPosX	The geodecimal x position	int
GeoPosY	The geodecimal y position	int
Course	The course in degree	int
Velocity	The speed in km/h	int

Returned error codes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_NAVIGATION_INFO

final int EVENT_NAVIGATION_INFO = 2

staticpackage

Get navigation information.

The PTV Navigator will send this message frequently with the appropriate fields filled in when a client before registered itself at the service for getting navigation information.
To get navigation information, the PTV Navigator has to be in an active navigation situation.
Also, when the PTV Navigator is not the foreground application, be sure to set the "GPS active in the background" option in the PTV Navigator settings, otherwise no information will be sent.

See Register for event listening for more details.

Attention: Information will only be sent when a navigation is running and the gps settings of the PTV Navigator are set to "GPS active in background".

Sending a message with this bundle key will register the listening to this event.
Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type
EventType	EVENT_NAVIGATION_INFO	int
DestinationName	The last target name	String
DestinationMercPosX	The mercator x position of the last target	int
DestinationMercPosY	The mercator x position of the last target	int
NextDestinationName	The next targets name	String
NextDestinationMercPosX	The mercator x position of the next target	int
NextDestinationMercPosY	The mercator x position of the next target	int
TimeToDestination	The time to the last destination with delays caused by traffic events	int
DistToDestination	The distance to the last destination	int
TimeToNextDestination	The time to the next destination with delays caused by traffic events	int
DistToNextDestination	The distance to the next destination	int
RoadType	The road type of the current segment [0..14]	int
TrafficDelayOnRoute	The current traffic delay on the route from the current position	int

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_SPEEDLIMIT

final int EVENT_SPEEDLIMIT = 3

staticpackage

Get speed limit and velocity information.

Get information about the current velocity, the current and next speedlimit, the distance to the next changing speedlimit and the road type of the next changing speedlimit, if available.
Speedlimit values can be 0 for two reasons: there is no limit or we have an explicit speedlimit like in towns which we do not show. In these cases, the speedlimit value is set to 0. The next speedlimit will only be set, if there is a speedlimit ahead of the route which is different from the current one. If the speedlimit doesn't change until reaching the target, the next speedlimit will be set to -1.
In cases there the next speedlimit is 0, the road type can be used to determine if we are on a highway or in a town.

Attention: Information will only be sent when a navigation is running and the gps settings of the PTV Navigator are set to "GPS active in background".

Sending a message with this bundle key will register the listening to this event.

Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type
EventType	EVENT_SPEEDLIMIT	int
CurrentVelocity	The current velocity	int
SpeedLimitCar	The current speedlimit for cars	int
SpeedLimitTruck	The current speedlimit for trucks	int
SpeedLimitCarIsImplicit	Flag whether the current speedlimit for cars is implicit or explicit	boolean
SpeedLimitTruckIsImplicit	Flag whether the current speedlimit for trucks is implicit or explicit	boolean
NextSpeedLimitCar	The next changing speedlimit for cars from the current position, or -1 if the limit is not changing anymore	int
NextSpeedLimitTruck	The next changing speedlimit for trucks from the current position, or -1 if the limit is not changing anymore	int
DistToNextSpeedLimitCar	The distance to the next speedlimit for cars, or 0, if the limit is not changing anymore	long
DistToNextSpeedLimitTruck	The distance to the next speedlimit for trucks, or 0, if the limit is not changing anymore	long
RoadTypeOfNextSpeedLimitCar	The road type of the segment of the next speedlimit for cars, or 0, if the limit is not changing anymore	int
RoadTypeOfNextSpeedLimitTruck	The road type of the segment of the next speedlimit for trucks, or 0, if the limit is not changing anymore	int

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_DESTINATION_REACHED

final int EVENT_DESTINATION_REACHED = 4

staticpackage

Get a message when the destination was reached.

Attention: Information will only be sent when a navigation is running and the gps settings of the PTV Navigator are set to "GPS active in background".

Sending a message with this bundle key will register the listening to this event.

Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key

Value

Type

Info

EventType

EVENT_DESTINATION_REACHED

int

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_NAVIGATION_STOPPED

final int EVENT_NAVIGATION_STOPPED = 5

staticpackage

Get a message when the navigation was stopped by the user.

Attention: Information will only be sent when a navigation is running and the gps settings of the PTV Navigator are set to "GPS active in background".

Sending a message with this bundle key will register the listening to this event.

Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key

Value

Type

Info

EventType

EVENT_NAVIGATION_STOPPED

int

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_REROUTE

final int EVENT_REROUTE = 6

staticpackage

Get a message when a rerouting occured.

Attention: Information will only be sent when a navigation is running and the gps settings of the PTV Navigator are set to "GPS active in background".

Sending a message with this bundle key will register the listening to this event.

Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type
EventType	EVENT_REROUTE	int
RerouteType	Type of Rerouting (REROUTE_TO_ROUTE(1), REROUTE_TO_TARGET(2), ENQUIRE_REROUTE(3), AUTOMATIC_REROUTE(4), ENQUIRED_REROUTE_ACCEPTED(5)	int
TimeDiff	Time difference to old route (only included with types ENQUIRE_REROUTE(3), AUTOMATIC_REROUTE(4), ENQUIRED_REROUTE_ACCEPTED(5))	int
DistDiff	Distance difference to old route (only included with types ENQUIRE_REROUTE(3), AUTOMATIC_REROUTE(4), ENQUIRED_REROUTE_ACCEPTED(5))	int

Reroute types

Key	Value	Type
REROUTE_TO_ROUTE	1	A local rerouting has happened
REROUTE_TO_TARGET	2	The complete route was recalculated
ENQUIRE_REROUTE	3	A better route is available. Waiting for user interaction.
AUTOMATIC_REROUTE	4	A better route was automatically taken.
ENQUIRED_REROUTE_ACCEPTED	5	A better route was accepted.

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_AREA_ALERT

final int EVENT_AREA_ALERT = 7

staticpackage

Get a message when an area is entered or left.

Attention: Information will only be sent when the gps settings of the PTV Navigator are set to "GPS active in background".

Sending a message with this bundle key will register the listening to this event.

Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key

Value

Type

Info

EventType

EVENT_AREA_ALERT

int

AreaAlertType

1 when an area was entered, 2 when an area was left

int

AreaLayerName

The name of the area layer which was entered or left

String

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_BORDER_CROSSED

final int EVENT_BORDER_CROSSED = 8

staticpackage

Get a message when a country is entered and/or left.

Attention: Information will only be sent when the gps settings of the PTV Navigator are set to "GPS active in background".

Sending a message with this bundle key will register the listening to this event.

Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key

Value

Type

Info

EventType

EVENT_BORDER_CROSSED

int

CountryCodeFrom

The country code of the left country

int

CountryCodeTo

The country code of the entered country

int

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_ROUTE_CORRIDOR_CROSSED

final int EVENT_ROUTE_CORRIDOR_CROSSED = 9

staticpackage

Get a message when a corridor around the route is entered and/or left.

Attention: Information will only be sent when a navigation is running and the gps settings of the PTV Navigator are set to "GPS active in background".

Sending a message with this bundle key will register the listening to this event.

Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type
EventType	EVENT_ROUTE_CORRIDOR_CROSSED	int
CorridorId	The id to identify the corridor	int
CrossingDirection	1 for entering the corridor, 2 for leaving the corridor	int
GeoPosX	The geodecimal x position where the corridor was crossed	int
GeoPosY	The geodecimal y position where the corridor was crossed	int
MercPosX	The mercator x position where the corridor was crossed	int
MercPosY	The mercator y position where the corridor was crossed	int

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_BUDDY_ALERT

final int EVENT_BUDDY_ALERT = 10

staticpackage

Get a message when a buddy alert was triggered.

The PTV Navigator will send this message frequently with the appropriate fields filled in when a client before registered itself at the service for getting buddy alert information.
To get buddy alert information, the PTV Navigator has to be in an active navigation situation, a buddy must have been added and positioned before, and an alert must have been set to this buddy.

Attention: Information will only be sent when a navigation is running and the gps settings of the PTV Navigator are set to "GPS active in background".

Sending a message with this bundle key will register the listening to this event.

Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type
EventType	EVENT_BUDDY_ALERT	int
AlertType	The type of alert (0 = in, 1 = out)	int
AlertID	The id of the alert	int

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_CURRENT_TOUR_ADDED_STATION

final int EVENT_CURRENT_TOUR_ADDED_STATION = 11

staticpackage

Get a message when a station was added to the current tour by the user.

The message will only be sent if a navigation is active. The station sent by the navigator is of type Station (see the class declaration for more infos).

The PTV Navigator will send this message with the appropriate fields filled in when a client before registered itself at the service for getting information when a station was added to the current tour.

Sending a message with this bundle key will register the listening to this event.
Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type	Info
EventType	EVENT_CURRENT_TOUR_ADDED_STATION	int
Station	The station which was added	Station

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_CURRENT_TOUR_INSERTED_STATION

final int EVENT_CURRENT_TOUR_INSERTED_STATION = 12

staticpackage

Get a message when a station was inserted to the current tour by the user.

The message will only be sent if a navigation is active. The station sent by the navigator is of type Station (see the class declaration for more infos).

The PTV Navigator will send this message with the appropriate fields filled in when a client before registered itself at the service for getting information when a station was inserted to the current tour.

Sending a message with this bundle key will register the listening to this event.
Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type	Info
EventType	EVENT_CURRENT_TOUR_INSERTED_STATION	int
Station	The station which was inserted	Station

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_CURRENT_TOUR_DELETED_STATION

final int EVENT_CURRENT_TOUR_DELETED_STATION = 13

staticpackage

Get a message when a station was deleted from the current tour by the user.

The message will only be sent if a navigation is active. The station sent by the navigator is of type Station (see the class declaration for more infos).

The PTV Navigator will send this message with the appropriate fields filled in when a client before registered itself at the service for getting information when a station was deleted from the current tour.

Sending a message with this bundle key will register the listening to this event.
Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type	Info
EventType	EVENT_CURRENT_TOUR_DELETED_STATION	int
Station	The station which was deleted	Station

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_CURRENT_TOUR_MOVED_STATION

final int EVENT_CURRENT_TOUR_MOVED_STATION = 14

staticpackage

Get a message when a station of the current tour was moved by the user.

The message will only be sent if a navigation is active. The station sent by the navigator is of type Station (see the class declaration for more infos).

The PTV Navigator will send this message with the appropriate fields filled in when a client before registered itself at the service for getting information when a station of the current tour was moved.

Sending a message with this bundle key will register the listening to this event.
Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type	Info
EventType	EVENT_CURRENT_TOUR_MOVED_STATION	int
Station	The station which was moved	Station

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_CURRENT_TOUR_CHANGED_STATION

final int EVENT_CURRENT_TOUR_CHANGED_STATION = 15

staticpackage

Get a message when a station of the current tour was changed by the user (like changing the coordinates or the name)

The message will only be sent if a navigation is active. The station sent by the navigator is of type Station (see the class declaration for more infos).

The PTV Navigator will send this message with the appropriate fields filled when a station of the current tour was changed. The client has to register itself for this event before the change.

Sending a message with the bundle key EVENT_CURRENT_TOUR_CHANGED_STATION will register the listening to this event.
In case of a change of any station, PTV Navigator sends a message with the "what" field set to "MSG_RI_EVENT_DATA".

Returned bundle:

Key	Value	Type	Info
EventType	EVENT_CURRENT_TOUR_CHANGED_STATION	int
Station	The station which was moved	Station

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

◆ EVENT_CURRENT_TOUR_CHANGED_STATUS_OF_STATION

final int EVENT_CURRENT_TOUR_CHANGED_STATUS_OF_STATION = 16

staticpackage

Get a message when the status of a station (skipped, visited) of the current tour was changed by the user.

The message will only be sent if a navigation is active. The station sent by the navigator is of type Station (see the class declaration for more infos).

The PTV Navigator will send this message with the appropriate fields filled in when a client before registered itself at the service for getting information when a status of a station of the current tour was changed.

Sending a message with this bundle key will register the listening to this event.
Messages sent from the PTV Navigator with the "what" field set to "MSG_RI_EVENT_DATA" and this bundle key will hold the following information:

Returned bundle:

Key	Value	Type	Info
EventType	EVENT_CURRENT_TOUR_CHANGED_STATUS_OF_STATION	int
Station	The station which was moved	Station

Returned Errorcodes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_IS_INITIALIZING if the Remote Interface service is not initialized yet.

Variables

Detailed Description

Variable Documentation

◆ EVENT_GPS_INFO

Returned bundle:

Returned error codes:

◆ EVENT_NAVIGATION_INFO

Returned bundle:

Returned Errorcodes:

◆ EVENT_SPEEDLIMIT

Returned bundle:

Returned Errorcodes:

◆ EVENT_DESTINATION_REACHED

Returned bundle:

Returned Errorcodes:

◆ EVENT_NAVIGATION_STOPPED

Returned bundle:

Returned Errorcodes:

◆ EVENT_REROUTE

Returned bundle:

Reroute types

Returned Errorcodes:

◆ EVENT_AREA_ALERT

Returned bundle:

Returned Errorcodes:

◆ EVENT_BORDER_CROSSED

Returned bundle:

Returned Errorcodes:

◆ EVENT_ROUTE_CORRIDOR_CROSSED

Returned bundle:

Returned Errorcodes:

◆ EVENT_BUDDY_ALERT

Returned bundle:

Returned Errorcodes:

◆ EVENT_CURRENT_TOUR_ADDED_STATION

Returned bundle:

Returned Errorcodes:

◆ EVENT_CURRENT_TOUR_INSERTED_STATION

Returned bundle:

Returned Errorcodes:

◆ EVENT_CURRENT_TOUR_DELETED_STATION

Returned bundle:

Returned Errorcodes:

◆ EVENT_CURRENT_TOUR_MOVED_STATION

Returned bundle:

Returned Errorcodes:

◆ EVENT_CURRENT_TOUR_CHANGED_STATION

Returned bundle:

Returned Errorcodes:

◆ EVENT_CURRENT_TOUR_CHANGED_STATUS_OF_STATION

Returned bundle:

Returned Errorcodes: