GuidanceMgr (CPIK Libraries)

Contents
Overview
Description A class containing static methods for obtaining navigational information such as location, road info, and the location of road safety cameras.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 10.9
Type Class
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
getCurrentRoad()
Road
Gets information about the current road.
getRouteCoordinates(boolean, double, double)
ArrayList<Coordinate>
Retrieves a list of latitude / longitude coordinates for the current route.
getRouteTmcCodes()
ArrayList<String>
Retrieves a list of TMC location codes along the current route.
getRouteTmcCodes(boolean)
ArrayList<String>
Retrieves a list of TMC location codes along the current route.
getTurnInstruction (boolean)
TurnInstruction
Gets the upcoming turn instruction.
getLaneAssist()
LaneAssistInfo
Gets the current lane assist information.
getCurrentSafetyCamera()
SafetyCamera
Gets safety camera information.
getGPSDevice()
GPSDevice
Gets the CoPilot GPS Device to manually push GPS coordinates or NMEA sentences.
getCurrentPosition()
PositionInfo
Obtains a variety of data pertaining to CoPilot’s current or last known position including.
getETA()
Date
Obtains the current Estimated Time of Arrival for the first destination of the trip.
getDistanceToDestination()
Double
Gets the distance from CoPilot’s current position (map-snapped) to its destination.
setChevronDisplaySetting(ChevronDisplayType)
Void
Sets display type for the chevron that represents the current position on the map. Deprecated in CoPilot 10.11
getChevronDisplaySetting()
ChevronDisplayType
Returns display type for the map chevron. Deprecated in CoPilot 10.11
enableEarlyTurnWarning()
Void
Enables/Disables the turn warning at 2 KM or 2 Miles.
disableEarlyTurnWarning()
Void
Enables/disables early turn warning.
isEarlyTurnWarningEnabled()
Boolean
Returns whether the 2 KM or 2 Mile turn warning is enabled.
enableFarTurnWarning()
Void
Enables/Disables the turn warning at 1 KM or 1 Mile.
disableFarTurnWarning()
Void
Disables the 1 KM or 1 Mile turn warning. (Available only till CP 9.6.8)
isFarTurnWarningEnabled()
Boolean
Returns whether the 1 KM or 1 Mile turn warning is enabled.
enableNearTurnWarning()
Void
Enables/Disables the turn warning at .5 KM or .5 Mile.
disableNearTurnWarning()
Void
Disables the .5 KM or .5 Mile turn warning. (Available only till CP 9.6.8.)
isNearTurnWarningEnabled()
Boolean
Returns whether the .5 KM or .5 Mile turn warning is enabled.
enableTurnRestrictions(boolean)
Void
Sets whether turn restrictions will be displayed during navigation.
enableClearTurnView(boolean)
Void
Sets whether clear turn view is enabled only on highways.
enableClearTurnViewOnlyHighways(boolean)
Void
Sets whether clear turn view is enabled only on highways.
setClearTurnInstructionDrawDistance(int)
Void
Sets when clear turn instructions will be drawn in 1/10 KM/Miles.
setClearTurnInstructionDrawDistance(int)
Void
Sets when clear turn instructions will be drawn in 1/10 KM/Miles.
setClearTurnInstructionHideDistance(int)
Void
Sets when clear turn instructions will be hidden in 1/10 KM/Miles.
showTurnAfterNext(boolean)
Void
Sets whether the second turn ahead on the trip will be drawn.
isTurnRestrictionEnabled()
Boolean
Returns whether turn restrictions will display during navigation.
isClearTurnViewEnabled()
Boolean
Returns whether clear turn view is enabled.
isClearTurnViewEnabledOnlyForHighways()
Boolean
Returns whether clear turn view is enabled only on highways.
getClearTurnInstructionDrawDistance()
Int
Returns the distance at which clear turns are displayed in 1/10 KM/Miles.
getClearTurnInstructionHideDistance()
Int
Returns the distance at which clear turns are hidden in 1/10 KM/Miles.
isTurnAfterNextEnabled()
Boolean
Returns whether the second turn ahead on the trip will be drawn.
suspendNavigation(Boolean)
Void
Suspends navigation. When this API is called, the position on the map will not update and guidance will stop until re-enabled.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GeocodingException

Overview
Description Exception thrown when there has been a Geocoding error.
Supported on Android Since Version 9.6.0.821
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Description
GeocodingException() A default constructor.
GeocodingException(String detailMessage, List placeList, List addressList) Overloading constructor with different error type parameters.
GeocodingException(String detailMessage, Throwable throwable) Overloading constructor with different parameters.
GeocodingException(String detailMessage) Overloading constructor with single string parameters.
GeocodingException(Throwable throwable) Overloading constructor with single throwable parameters.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceException

Overview
Description Exception thrown when there has been an error executing Guidance operations such as turn warnings.
Supported on Android Since Version 9.6.0.821
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Description
GuidanceException() A default constructor.
GuidanceException(String detailMessage, Throwable throwable) Overloading constructor with different parameters.
GuidanceException(String detailMessage) Overloading constructor with single string parameters.
GuidanceException (Throwable throwable) Overloading constructor with single throwable parameters.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceSettings

Overview
Description Class that contains ways to edit and retrieve CoPilot settings related to Guidance.
Supported on Android Since Version 9.6.0.821
Type Class
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
isSpeedAlertEnabled()
Boolean
Returns whether or not an alert should appear when the driver is exceeding the speed limit by a given threshold.
setSpeedAlert(boolean)
Void
Sets whether or not an alert should appear when the driver is exceeding the speed limit by a given threshold.
isSpeedAlertAudioEnabled()
Boolean
Returns whether or not an audio alert is played when the driver is exceeding the speed limit by a given threshold.
setSpeedAlertAudio(boolean)
Void
Sets whether or not an audio alert is played when the driver is exceeding the speed limit by a given threshold.
isSpeedLimitOnMap()
Boolean
Returns whether or not the speed limit is being shown on the map.
setSpeedLimitOnMap(boolean)
Void
Sets whether or not to show the speed limit on the map.
getSpeedLimitThreshold()
SpeedThreshold
Gets the amount over the speed limit the driver can travel before receiving a speed limit warning.
setThreshold(SpeedThreshold)
Void
Sets when speed limit warnings appear.
isSafetyCameraAlertEnabled()
Boolean
Returns whether or not safety camera alerts are enabled.
setSafetyCameraAlert(boolean)
Void
Enables or disables safety camera alerts.
getSafetyCameraAlertRange()
SafetyCamera AlertRange
Gets how far in advance a driver is warned about an approaching safety camera.
setSafetyCameraAlertRange(SafetyCameraAlertRange)
Void
Sets how far in advance a driver is warned about an approaching safety camera
getMapMode()
MapMode
Gets the current day-night mode of the map.
setMapMode(MapMode)
Void
Sets CoPilot’s map scheme to selected background. The map is refreshed.
setDistanceToSayTurnNow(int)
Void
Sets the distance ahead of the turn where CoPilot should speak its “Turn Now” announcement.
getDistanceToSayTurnNow()
int
Gets the currently set distance ahead of a turn at which CoPilot will speak its “Turn Now” announcement.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceSettings.isSpeedAlertEnabled

Overview
Description Returns whether or not an alert should appear when the driver is exceeding the speed limit by a given threshold.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Boolean - True if enabled, false if disabled.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceSettings.setSpeedAlert

Overview
Description Toggles whether or not alerts will appear when the driver is exceeding the speed limit by a given threshold.
Supported on Android Since Version 9.6.0.821
Platforms Supported Android, Linux
Type Method
Package com.alk.cpik.guidance

Syntax

static void enableSpeedLimitAlert(boolean)

Parameters

boolean speedAlertEnabled - True to enable, false to disable.

Return Value

Void

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.isSpeedAlertEnabled()
  • GuidanceSettings.isSpeedAlertAudioEnabled()
  • GuidanceSettings.setSpeedAlertAudio()
  • GuidanceSettings.isSpeedLimitOnMap()
  • GuidanceSettings.setSpeedLimitOnMap()
  • GuidanceSettings.getSpeedLimitThreshold()
  • GuidanceSettings.setThreshold()

GuidanceSettings.isSpeedAlertAudioEnabled

Overview
Description Returns whether or not an audio alert should play when the driver is exceeding the speed limit by a given threshold.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

static boolean getSpeedLimitAudioAlertEnabled()

Parameters

None

Return Value

boolean - True if enabled, false if disabled.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.isSpeedAlertEnabled()
  • GuidanceSettings.setSpeedAlert()
  • GuidanceSettings.setSpeedAlertAudio()
  • GuidanceSettings.isSpeedLimitOnMap()
  • GuidanceSettings.setSpeedLimitOnMap()
  • GuidanceSettings.getSpeedLimitThreshold()
  • GuidanceSettings.setThreshold()

GuidanceSettings.setSpeedAlertAudio

Overview
Description Toggles whether or not to play an audio alert when the driver is exceeding the speed limit by a given threshold.
Supported on Android Since Version 9.6.0.821
Platforms Supported Android, Linux
Type Method
Package com.alk.cpik.guidance

Syntax

void enableSpeedLimitAudioAlert(boolean)

Parameters

boolean alertEnabled - True to enable, false to disable.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.isSpeedAlertEnabled()
  • GuidanceSettings.setSpeedAlert()
  • GuidanceSettings.isSpeedAlertAudioEnabled()
  • GuidanceSettings.isSpeedLimitOnMap()
  • GuidanceSettings.setSpeedLimitOnMap()
  • GuidanceSettings.getSpeedLimitThreshold()
  • GuidanceSettings.setThreshold()

GuidanceSettings.isSpeedLimitOnMap

Overview
Description Returns whether or not the speed limit is being shown on the map.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

static boolean isSpeedLimitOnMap()

Parameters

None

Return Value

boolean - True if shown, false if hidden

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.isSpeedAlertEnabled()
  • GuidanceSettings.setSpeedAlert()
  • GuidanceSettings.isSpeedAlertAudioEnabled()
  • GuidanceSettings.setSpeedAlertAudio()
  • GuidanceSettings.setSpeedLimitOnMap()
  • GuidanceSettings.getSpeedLimitThreshold()
  • GuidanceSettings.setThreshold()

GuidanceSettings.setSpeedLimitOnMap

Overview
Description Sets whether or not to show the speed limit on the map.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

void enableShowSpeedLimitOnMap(boolean)

Parameters

boolean showSpeedLimitOnMap - True to show, false to hide.

Return Value

Void

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.isSpeedAlertEnabled()
  • GuidanceSettings.setSpeedAlert()
  • GuidanceSettings.isSpeedAlertAudioEnabled()
  • GuidanceSettings.setSpeedAlertAudio()
  • GuidanceSettings.getSpeedLimitThreshold()
  • GuidanceSettings.setThreshold()

GuidanceSettings.getSpeedLimitThreshold

Overview
Description Returns the speed the driver must exceed before a speed limit warning appears in CoPilot.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

static SpeedLimitWarningThreshold getSpeedLimitWarningThreshold()

Parameters

None

Return Value

SpeedLimitWarningThreshold – An Enum indicating the speed which must be reached in miles per hour before the speed limit warning is provided.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.isSpeedAlertEnabled()
  • GuidanceSettings.setSpeedAlert()
  • GuidanceSettings.isSpeedAlertAudioEnabled()
  • GuidanceSettings.setSpeedAlertAudio()
  • GuidanceSettings.isSpeedLimitOnMap()
  • GuidanceSettings.setSpeedLimitOnMap()
  • GuidanceSettings.setThreshold()
  • GuidanceSettings.setThreshold()

GuidanceSettings.setThreshold

Overview
Description Sets how fast a driver can be over the speed limit before a warning appears in CoPilot.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

void setThreshold(SpeedThreshold threshold)

Parameters

Threshold - How fast a driver can be over the speed limit before receiving a speed limit warning.

Return Value

Void

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.isSpeedAlertEnabled()
  • GuidanceSettings.setSpeedAlert()
  • GuidanceSettings.isSpeedAlertAudioEnabled()
  • GuidanceSettings.setSpeedAlertAudio()
  • GuidanceSettings.isSpeedLimitOnMap()
  • GuidanceSettings.setSpeedLimitOnMap()
  • GuidanceSettings.getSpeedLimitThreshold()

GuidanceSettings.isSafetyCameraAlertEnabled

Overview
Description Returns whether or not safety camera alerts are enabled.
Supported on Android Since Version 9.6.0.821
Platforms Supported Android, Linux
Type Method
Package com.alk.cpik.guidance

Syntax

boolean areSafetyCamerasEnabled()

Return Value

Boolean - True if enabled, false if disabled.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.setSafetyCameraAlert()
  • GuidanceSettings.getSafetyCameraAlertRange()
  • GuidanceSettings.setSafetyCameraAlertRange()

GuidanceSettings.setSafetyCameraAlert

Overview
Description Enables or disables visual safety camera alerts.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

void enableSafetyCameraAlerts(boolean)

Parameters

boolean cameraEnabled - True to enable, false to disable.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.isSafetyCameraAlertEnabled()
  • GuidanceSettings.getSafetyCameraAlertRange()
  • GuidanceSettings.setSafetyCameraAlertRange()

GuidanceSettings.getSafetyCameraAlertRange

Overview
Description Returns how far in advance a driver will be warned about a safety camera.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

SafetyCameraAlertRange getSafetyCameraLookaheadLevel()

Return Value

SafetyCameraAlertRange - An AlertRange object that represents how far in advance a driver should be warned about a safety camera.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.isSafetyCameraAlertEnabled()
  • GuidanceSettings.setSafetyCameraAlert()
  • GuidanceSettings.setSafetyCameraAlertRange()

GuidanceSettings.setSafetyCameraAlertRange

Overview
Description Sets how far in advance a driver will be warned about a safety camera.
Supported on Android Since Version 9.6.0.821
Platforms Supported Android, Linux
Type Method
Package com.alk.cpik.guidance

Type

Method

Package

com.alk.cpik.guidance

Syntax

void setSafetyCameraLookaheadLevel(AlertRange)

Parameters

AlertRange – An enum that represents how far in advance a driver should be warned about a safety camera.

Return Value

void

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • GuidanceSettings.isSafetyCameraAlertEnabled()
  • GuidanceSettings.setSafetyCameraAlert()
  • GuidanceSettings.getSafetyCameraAlertRange()

GuidanceSettings.setMapMode

Overview
Description Sets the current map scheme to the selected day-night background.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

void setMapMode(MapMode)

Parameters

Mode - MapMode to be set.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • Guidance.getMapMode

GuidanceSettings.getMapMode

Overview
Description Gets the current day-night mode of the map.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

MapMode getMapMode()

Return Value

Returns the MapMode object being used with CoPilot.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • Guidance.serMapMode

GuidanceSettings.setDistanceToSayTurnNow

Overview
Description Sets the distance ahead of the turn at which CoPilot should tell the driver to turn. If CoPilot is set to use metric, the distance will be interpreted as meters. Otherwise, the distance is interpreted in yards.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

void setDistanceToSayTurnNow(distanceForTurnNow)

Parameters

distanceForTurnNow - The distance where CoPilot should speak its “Turn Now” announcement in yards or meters.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • Guidance.getDistanceToSayTurnNow

GuidanceSettings.getDistanceToSayTurnNow

Overview
Description Gets the distance ahead of the turn at which CoPilot should tell the driver to turn.
Supported on Android Since Version 9.6.0.821
Type Method
Package com.alk.cpik.guidance

Syntax

Static int getDistanceToSayTurnNow

Return Value

Integer value indicating the current setting. If getUnitsOfMeasure() returns metric then the returned value will be in meters. Otherwise, the return value will be in yards.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Related APIs

  • Guidance.setDistanceToSayTurnNow

SpeedThreshold

Overview
Description An enum that corresponds to how much a speed limit has been exceeded. The units of this value are either km/h if CoPilot is set to metric, or mph if CoPilot is set to imperial.
Supported on Android Since Version 9.6.0.821
Type Enum
Package com.alk.cpik.guidance

Values

Value Description
LEVEL_0 Exceed the speed limit by 5 units
LEVEL_1 Exceed the speed limit by 10 units
LEVEL_2 Exceed the speed limit by 15 units
LEVEL_3 Exceed the speed limit by 20 units
LEVEL_4 Exceed the speed limit by 25 units
LEVEL_5 Exceed the speed limit by 30 units

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

SafetyCameraAlertRange

Overview
Description An enum of all available ranges at which a safety camera alert can be triggered.
Supported on Android Since Version 9.6.0.821
Type Enum
Package com.alk.cpik.guidance

Package

com.alk.cpik.guidance

Values

Value Description
SHORT This value sets the alert range to the shortest possible distance. This is currently set at 250 yards/meters.
MEDIUM This value sets the alert range to the middle distance available. This is currently set to 500 yards/meters.
LONG This value sets the alert range to the longest distance available. This is currently set to 1000 yards/meters.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

MapMode

Overview
Description An enum of all the different map background styles.
Supported on Android Since Version 9.6.0.821
Type Enum
Package com.alk.cpik.guidance

Values

Value Description
DAY Map has a lighter background
NIGHT Map has a dark background
AUTO Lets CoPilot decide whether the map background should be light or dark

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Coordinate

Overview
Description An instance of this class represents a latitude and longitude.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 10.9
Type Class
Package com.alk.cpik

Constructors

Method Name Description
Coordinate() Creates a new latitude/longitude pair at 0.0N, 0.0E. (0.0N, 0.0E) is typically used as an error value for GPS positions.
Coordinate(double dLat, double dLon) Creates a new latitude/longitude pair using the values provided.

Methods

Method Name Return Type Description
getLatitude()
double
Gets decimal representation of the stop’s latitude.
getLongitude()
double
Gets decimal representation of the stop’s longitude.
setLatitude(double latitude)
void
Sets latitude of a location.
setLongitude(double longitude)
void
Sets longitude of a location.

Sample Code

Example Output

Coordinates: 50.85N, 4.35E

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

PositionInfo

Overview
Description An object that contains information about the current position.
Supported on Android Since Version 9.6.0.821
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Return Type Details
getPosition()
Coordinate
Gets position - absolute.
getSnappedPosition()
Coordinate
Gets position - snapped to the nearest road.
getSpeed()
double
Gets speed in either mph or km/h depending on CoPilot’s unit setting.
getHeading()
double
Gets heading in degrees.
getAltitude()
double
Gets altitude in feet.
getTimeStamp()
Date
Gets time in UTC.
getGpsFixQuality()
GPSFixQuality
Gets the quality of a GPS lock.
getNumSatellites()
int
Gets number of satellites contributing fix information to CoPilot’s best know position.
getNumTrackedSatellites()
int
Gets number of satellites being tracked.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GPSFixQuality

Overview
Description An enum whose values represent the possible quality of a GPS lock.
Supported on Android Since Version 9.6.0.821
Type Enum
Package com.alk.cpik.guidance

Values

Value Description
FIX_NONE No GPS Fix
FIX_2D A two-dimensional
AUTO Let CoPilot decide whether the map background should be light or dark.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

CPPositionInfo

Overview
Description Container object for information about the current position
Supported on iOS Since Version 10.9
Type Object
Package com.alk.cpik.guidance

Properties

Property Name Type
coordinate Coordinate
altitude Double
heading double
speed double
timestamp NSDate*
fixQuality CPGpsState
numSatellites short

CPGpsState

Overview
Description Enum whose values represent the possible quality of a GPS lock
Supported on iOS Since Version 10.9
Type Enum
Package com.alk.cpik.guidance

Values

Value Description
GpsFix_None No GPS Fix
GpsFix_2D A two-dimensional
GpsFix_3D Lets CoPilot identify if the day or night map style should be used

Road

Overview
Description An object that is created and populated by CoPilot on a getCurrentRoadInfo call. The information in the road object only pertains to the portion of the road corresponding to the current GPS position.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 10.9
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
getMinimumAddress()
int
Gets the lowest address number on this link.
getMaximumAddress()
int
Gets the highest address number on this link.
getRoadName()
String
Gets the name of the road that the link is a part of.
getRegion()
String
Gets the region that this road is located in.
getCountryInfo() Country Gets information about the country where the link is located.
getState()
String
Gets the name of the state where the link is located.
getSpeedLimit()
int
Gets the speed limit of this link.
getTruckSpeedLimit()
int
Gets the truck speed limit. If there is no truck specific speed limit, it will be 0.
hasToll()
Boolean
Returns whether or not a toll must be paid to access this link.
isUrban()
Boolean
Returns whether or not this road is in an urban area. Urban roads are prone to congestion and should be avoided by through traffic.
getRouteNumbers()
List<String>
Gets the list of route numbers that are associated with this road.
getAllowedVehicles()
List<AllowedVehicleType>
Gets an array of specifying which vehicle types which are allowed to access this road.
getCity()
String
Gets the city that this road is located in.
getZip()
String
Gets the ZIP/postal code that this road is located in.
isInNationalNetwork()
Boolean
Returns whether this road is part of the National Network is a government-designed system of highways.
isCommercialProhibited()
Boolean
Returns whether this road is Commercial Prohibited, which designates a road that cannot be driven on by a truck under any circumstances
isTruckDesignated()
Boolean
Returns whether this road is Truck Designated - a high-quality, rural highway, usually divided, that is not limited access but lacks congestion and has few stoplights.
isStateOversized()
Boolean
Returns whether this road is State Oversized – state-designated oversized highways that are similar to highways in the National Network.
isPropaneRestricted()
Boolean
Returns whether propane is restricted on this road.
isForbiddenToTrailers()
Boolean
Returns whether or not trailers are forbidden on this road.
hasOversizedAccess
Boolean
Returns true if the road has oversized access.
isOvertakingProhibited()
Boolean
Returns whether or not overtaking (passing) is prohibited on this road.
isUnnamedRoad()
Boolean
Returns whether or not the current road is unnamed.
getHazmatRestrictions()
List<HazmatRestrictions>
Denotes the hazmat restrictions of this road.
getDimensionRestrictions()
RestrictedDimensions
Outlines what are the truck restrictions on this road.
getRoadClass()
RoadClass
Return this road’s class.
getRoadSubClass()
RoadSubClass
Return this road’s subclass.

Example Output

Minimum address: 12; Maximum address: 206; Route numbers: [560, 49]; Road name: Church Lane; Region: Europe; Country: United Kingdom

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Road.RoadClass

Overview
Description An enum of all of the possible road classes.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version Android, Linux
Type Enum
Package com.alk.cpik.guidance

Values

Value Description
NONE No road class data available for this particular link
COMMERCIAL_PROHIBITED Commercial vehicles are prohibited
TRUCK_DESIGNATED Designated for use by trucks
TRUCK_RESTRICTED Restricted for use by trucks
CLOSED Closed
INTERSTATE Highway
DIVIDED_HIGHWAY Divided Highway
PRIMARY Primary Road
FERRY Ferry route
SECONDARY Secondary road
RAMP Ramp, such as a highway exit
LOCAL Local road, such as residential roads.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

SafetyCamera

Overview
Description An object containing information about a specific safety camera.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 10.9
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
isShowing()
boolean
Returns whether or not the safety camera alert is showing on the navigation dialog.
distance()
Double
Returns the distance between the current position and the safety camera.
speedLimit()
Int
Returns the maximum speed that will not trigger the camera.
id()
String
Returns the unique string identifier for this specific instance of a safety camera.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Traffic

Overview
Description A class containing methods that can edit or retrieve traffic-related settings.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 9.6
Type Class
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
setTrafficMaxDistance(int)
Void
Sets the FlowRouteLookaheadMiles value as part of the FlowTraffic configuration.
setTrafficAlertEnabled(boolean)
Void
Sets whether traffic is enabled or disabled.
setTrafficRequestTimer(int)
Void
Sets RouteRerequestSecs as part of the FlowTraffic configuration.
setTrafficMinutesToAlert(int)
Void
Sets SignificantETTDeltaMins as part of the FlowTraffic configuration.
getTrafficMaxDistance()
Int
Returns the FlowTraffic configuration’s FlowRouteLookaheadMiles.
getTrafficAlertEnabled()
boolean
Returns whether FlowTraffic configuration is active.
getTrafficRequestTimer()
Int
Returns the FlowTraffic configuration’s RouteRerequestSecs.
getTrafficMinutesToAlert()
Int
Returns the FlowTraffic configuration’s SignificantETTDeltaMins.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Country

Overview
Description An object that contains information about a country. This object provides the user with information detailing the country name in both local and set language, country code, drive side, currency, unit of measurement and also the language(s) spoken in that country.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 10.9
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
getCountryName()
String
Returns the name of the country.
getCountryNameInCurrentLanguage()
String
Returns the name of the country in CoPilot’s current language.
getCountryCode()
String
Returns the country code of the country.
getDriveSide()
DriveSide
Returns the side of the road on which the country drives.
getCurrency()
String
Returns the currency used in the country.
getUnitsOfMeasure()
UnitsOfMeasure
Returns the distance units used in the country.
getLanguages()
ArrayList<String>
Returns a list of the languages spoken in the country.
getSpeedInfo()
String
Returns the speed info used in the country.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

LaneAssistInfo

Overview
Description An object that contains a list of lanes associated with a lane assist event.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 10.9
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
getLanes()
List<Lane>
Gets the current lanes. The first lane in the array is the left-most lane on the road.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

Lane

Overview
Description Contains information about a lane, returned by getLaneAssist.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 10.9
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
getTurnCode()
TurnCode
Returns the turning code. i.e. STRAIGHT, LEFT, RIGHT, SHARP_LEFT, SHARP_RIGHT, UTURN, WAYPOINT etc.
getLaneMarker()
LaneMarker
Returns the LaneMarker, DASHED and SOLID.
isValid()
boolean
Returns true if the lane is valid.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onShowLaneAssist
onHideLaneAssist

OverSpeedLimitWarning

Overview
Description An object that contains information related to the speed limit exceeded event.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 10.9
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
getSpeedLimit() Int Returns the current speed limit of the road on which the user is traveling.
getCurrentSpeed() Int Returns the current speed the user is traveling.
getIsTruck()
boolean
Returns whether or not this is a truck speed limit. (This is applicable for Europe only.)

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

TruckWarning

Overview
Description An object that contains information associated with truck warnings, such as turn restrictions, sharp curves and notifications of fuel stops ahead.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 10.9
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
getWarningType() TruckWarningType Returns truck warning type of this event.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

TruckWarningType

Overview
Description An enum whose values represent various types of truck warnings. These warnings are available in Europe only.
Supported on Android Since Version 9.6.0.821
Type Enum
Package com.alk.cpik.guidance

Values

Value Description
NO_UTURN A no U-turn restriction on the road.
NO_LEFT A no left turn restriction on the road.
NO_RIGHT A no right turn restriction on the road.
PROTECTED_OVERTAKING_EXTRA_LANE Overtaking extra lane is protected.
PROTECTED_OVERTAKING_EXTRA_LANE_RIGHTSIDE Overtaking extra lane on the right side is protected.
PROTECTED_OVERTAKING_EXTRA_LANE_LEFTSIDE Overtaking extra lane on the left side is protected.
ROAD_NARROWS This road narrows ahead.
SHARP_CURVE_RIGHT There is a sharp right turn.
SHARP_CURVE_LEFT There is a sharp left turn.
STEEP_HILL_UPWARDS There is a steep hill upward direction.
STEEP_HILL_DOWNWARDS There is a steep hill downward direction.
LATERAL_WIND There is a risk of high winds blowing lateral.
RISK_OF_GROUNDING There is a risk of grounding ahead.
TREE_OVERHANG There are overhanging trees ahead.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

TurnInstruction

Overview
Description An object that contains information related to turn-by-turn guidance instructions.
Supported on Android Since Version 9.6.0.821
Supported on iOS Since Version 10.9
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
getGuidanceInstruction()
String
Retrieves the next guidance instruction.
getExitNumber()
String
Retrieves the exit number.
getExitRoadName()
String
Retrieves the name of the road on which the driver will exit.
getStreetNameForNextTurn()
String
Retrieves the name of the street that the driver should turn onto next.
getDistanceToNextTurn()
String
Retrieves the distance until the approaching turn.
getDistanceToTurnAfterNext()
String
Retrieves the distance until the next (not the approaching) turn. If the driver is supposed to turn onto Street A and then Street B, this will return the distance until Street B.
getTurnIconForNextTurn() TurnArrowImage Retrieves the turn icon ID for the upcoming turn.
getTurnIconForTurnAfterNext() TurnArrowImage Retrieves the turn icon ID for the turn after the approaching turn. If the driver is supposed to turn onto Street A and then Street B, this will return the icon ID for the turn onto Street B.
isUnnamedRoad()
boolean
Returns whether or not the the street to be turned onto is unnamed.
isRoundAbout()
boolean
Designates whether or not the upcoming turn occurs on a round about.
getRoundAboutExitNumber() Int Retrieves which exit number on the roundabout a turn is to be made. If the turn is not on a roundabout, this value will be zero.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

ItineraryInfo

Overview
Description An object that contains data related to a trip’s itinerary. This information, provided by CoPilot, includes turn instructions, turn images and distances.
Supported on Android Since Version 9.6.0.1848
Supported on iOS Since Version 10.9
Type Object
Package com.alk.cpik.guidance

Methods

Method Name Return Type Description
getInstruction()
String
Gets turns instructions.
getDistanceOnSegment()
String
Gets distance on the current trip segment.
getTurnIconForNextTurn() TurnArrowImage An enum of turn arrow images.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getCurrentPosition

Overview
Description Provides information relating to CoPilot’s current or last known location. This will include coordinates as well as other location information detailing the quality of the GPS fix and the number of satellites contributing to the current GPS fix.

Note: The last known position will be returned when the current location cannot be determined. This could potentially be from a previous run of the application, depending when this API is used. An object that contains data related to a trip’s itinerary. This information, provided by CoPilot, includes turn instructions, turn images and distances.

Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

A PositionInfo object populated with data pertaining to CoPilot’s current or last known position.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getLaneAssist

Overview
Description Returns a LaneAssistInfo object representing the current lane assist information.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

A LaneAssistInfo object with the current lane assist information.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getTurnInstruction

Overview
Description Gets information about the upcoming turn instruction.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

A TurnInstruction object that contains the information about the upcoming turn.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getDistanceToDestination

Overview
Description Provides the distance from the current location to the destination that has been entered into CoPilot. This will be returned in miles or kilometers depending on the settings. If CoPilot has not been started, an error will be returned.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

The distance remaining to the destination. This distance will be in miles if CoPilot is set to use imperial measurements or meters if CoPilot is set to use metric measurements.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getCurrentRoad

Overview
Description Gets information about the current road.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

A Road object containing information about the current road.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getRouteCoordinates

Overview
Description Gets a list of coordinates that describe the current guidance route.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Parameters

Boolean bFromCurrentPosition - True if requesting only the points starting from the current position on the route. False if requesting the entire route.

Double dLookAhead – The distance in miles to look ahead on the route.

Double dGranularity – A value between 0.0 and 1.0 that will indicate how coarse the returned list of Coordinates will be. A value of 1.0 will return the finest possible route.

Return Value

An ArrayList object that contains the list of Coordinate objects that represents the route.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getRouteTmcCodes

Overview
Description Gets a list of TMC location codes that describe the current guidance route.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

An ArrayList object that contains the list of TMC location codes describing the current route.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getRouteTmcCodes (No duplicates)

Overview
Description Gets a list of TMC location codes that describe the current guidance route, with the ability to remove duplicates from the list.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version Android, Linux
Type Method
Package com.alk.cpik.guidance

Syntax

Parameters

bRemoveDuplicates – True if the duplicates should be removed from the returned list.

Return Value

An ArrayList object that contains the list of TMC location codes describing the current route.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getCurrentSafetyCamera

Overview
Description Gets the current Safety Camera info, if it exists.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

A SafetyCamera object that contains information about the safety camera that is currently displayed on the CoPilot guidance map.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getETA

Overview
Description Provides details of the current estimated time of arrival (ETA) for the first destination of the trip that CoPilot is navigating. If CoPilot has not yet started or does not have a destination entered, an exception will be thrown.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version Android, Linux
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

A Date object indicating the estimated time of arrival.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getItineraryInfoList

Overview
Description Returns the full itinerary currently stored within CoPilot. Itinerary information will be passed back via onItineraryUpdate. A subsequent onItineraryUpdate will be returned after any of the following events:

- Route calculation finish

- Route is finished

- Refresh of the route calculation dialog

- Current segment (link) is changed

- Any Detour

- Penalty added to link/segment (traffic received)

- Penalty removed from link/segment (traffic is cleared)

- Update itinerary report in case language or distance unit changed

- Trip is changed

Supported on Android Since Version 9.6.0.1848
Supported on iOS Since Version 10.9
Type Class
Package com.alk.cpik.guidance

Methods

Return Value

A list representing each ItineraryInfo object.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getGPSDevice

Overview
Description Gets the CoPilot GPS Device used to manually push GPS Coordinates or NMEA sentences.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Singleton instance of the CoPilot GPS Device.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.setChevronDisplaySetting

Overview
Description Sets the type of information that will be displayed under the chevron in CoPilot. The chevron is the arrow or dot displayed on the map to indicate the current position.
Supported on Android Since Version 9.6.0.868
Deprecated on Android Since Version 10.11
Type Method
Package com.alk.cpik.guidance

Syntax

Parameters

chevronDisplayType – Sets the ChevronDisplayType enum value.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getChevronDisplaySetting

Overview
Description Gets the type of information that will be displayed under the chevron in CoPilot. The chevron is the arrow or dot displayed on the map to indicate the current position.
Supported on Android Since Version 9.6.0.868
Deprecated on Android Since Version 10.11
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

ChevronDisplayType enum value

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.enableEarlyTurnWarning

Overview
Description Enables the early turn warning that occurs at 2 miles or 2 kilometers before the turn.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.isEarlyTurnWarningEnabled

Overview
Description Checks whether or not the early turn warning, which occurs at 2 miles or 2 kilometers before the turn, is enabled.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Boolean - True if the early turn warning is enabled. False otherwise.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.enableNearTurnWarning

Overview
Description Enables the near turn warning that occurs at .5 kilometers or .5 miles before the turn.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.isNearTurnWarningEnabled

Overview
Description Checks whether or not the near turn warning, which occurs at .5 kilometers or .5 miles before the turn, is enabled.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Boolean – True if the near turn warning is enabled. False otherwise.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.enableFarTurnWarning

Overview
Description Enables the far turn warning that occurs at 1 kilometer or 1 mile before the turn.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version Android, Linux
Type Method
Package com.alk.cpik.guidance

Syntax

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.isFarTurnWarningEnabled

Overview
Description Checks whether or not the far turn warning, which occurs at 1 kilometer or 1 mile before the turn, is enabled.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version Android, Linux
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Boolean true if the near turn warning is enabled. False otherwise.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.enableTurnRestrictions

Overview
Description Enables or disables turn restrictions - signs in the map view to show the driver where any restricted turns (e.g. no left or no right turn) are along the route.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Parameters

Boolean true to enable turn restrictions. False to disable turn restrictions.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.isTurnRestrictionEnabled

Overview
Description Checks to see whether turn restrictions are enabled or disabled. Turn restrictions are signs in the map view to show the driver where any restricted turns (e.g. no left or no right turn) are along the route.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Boolean - True if the feature is enabled. False otherwise.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.enableClearTurnView

Overview
Description Enables or disables the ClearTurn feature, which displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Parameters

Enable - Boolean true to enable ClearTurn. False to disable ClearTurn.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.isClearTurnViewEnabled

Overview
Description Checks to see whether ClearTurn is enabled or disabled. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version Android, Linux
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Boolean - True if the feature is enabled. False otherwise.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.enableClearTurnViewOnlyForHighways

Overview
Description Enables or disables the ClearTurn feature only for highways. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Parameters

Boolean - True to enable ClearTurn. False to disable ClearTurn.

Return Value

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.isClearTurnViewEnabledOnlyForHighways

Overview
Description Checks whether or not ClearTurn is set to show only for highways. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version Android, Linux
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Boolean - True if the feature is enabled. False otherwise.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.setClearTurnInstructionDrawDistance

Overview
Description Sets the distance from the turn at which ClearTurn views will draw. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version Android, Linux
Type Method
Package com.alk.cpik.guidance

Syntax

Parameters

Integer distance measure in 1/10 of a mile or 1/10 of a kilometer.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getClearTurnInstructionDrawDistance

Overview
Description Retrieves the distance at which ClearTurn view will draw. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version 9.6.0.868
Supported on Android Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Integer distance at which Clear Turn will draw in 1/10 of a mile or 1/10 of a kilometer, depending on CoPilot’s unit setting.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.setClearTurnInstructionHideDistance

Overview
Description Sets the distance from the turn at which ClearTurn views will hide. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Parameters

Integer distance at which ClearTurn views will hide in 1/10 of a mile or 1/10 a kilometer.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.getClearTurnInstructionHideDistance

Overview
Description Retrieves the distance at which the ClearTurn view will be hidden. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Integer distance at which the ClearTurn view will be hidden in 1/10 of a mile or 1/10 of a kilometer.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.showTurnAfterNext

Overview
Description Enables or disables the display of the turn after the approaching turn.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Parameters

Boolean - True to enable the feature. False to disable.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.isTurnAfterNextEnabled

Overview
Description Checks whether or not the turn after the approaching turn will display.
Supported on Android Since Version 9.6.0.868
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Return Value

Boolean - True if the feature is enabled. False otherwise.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

GuidanceMgr.suspendNavigation

Overview
Description Suspends navigation. When this API is called, the position on the map will not update and guidance will stop until re-enabled. This is meant to reduce CPU usage at times when navigation is not necessary. GuidanceMgr.getCurrentRoad() will continue to work as expected.

This API differs from CopilotMgr.enableGPS() / CopilotMgr.disableGPS()(Android only) in that the GPS device itself will remain open and the current position will be updated for the GuidanceMgr.getCurrentRoad() API.

Supported on Android Since Version 9.6.0.1453
Supported on iOS Since Version 10.9
Type Method
Package com.alk.cpik.guidance

Syntax

Parameters

bSuspend - true to suspend navigation, or false to re-enable navigation.

Sample Code

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

ChevronDisplayType

Overview
Description An enum of the information displayed beneath the chevron in CoPilot during guidance. The chevron is the arrow or dot displayed on the map to indicate the current position.
Supported on Android Since Version 9.6.0.821
Type Enum
Package com.alk.cpik.guidance

Values

Value Description
NONE Nothing is Displayed.
CURRENT_ROAD Display the current road.
DESTINATION Display the destination.
NEAREST_TOWN Display the nearest town.
Heading Display the current heading.
LAT_LON Display the current latitude/longitude position.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

DriveSide

Overview
Description An enum of the side of the road on which a country drives.
Supported on Android Since Version 9.6.0.821
Type Enum
Package com.alk.cpik.trip

Values

Value Description
DRIVE_SIDE_UNAVAILABLE Drive side information for the country is unavailable.
DRIVE_SIDE_LEFT A country in which they drive on the left side of the road.
DRIVE_SIDE_RIGHT A country in which they drive on the right side of the road.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

UnitsOfMeasure

Overview
Description An enum that provides details on units of measurement.
Supported on Android Since Version 9.6.0.821
Type Enum
Package com.alk.cpik.trip

Values

Value Description
UNAVAILABLE Units of measure are unavailable
METRIC Metric units of measure
IMPERIAL Imperial units of measure

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

CPUnitsOfMeasure

Overview
Description An enum that provides details on units of measurement.
Supported on iOS Since Version 10.9
Type Enum
Package com.alk.cpik.trip

Values

Value Description
CP_UNAVAILABLE Units of measure are unavailable
CP_METRIC Metric units of measure
CP_IMPERIAL Imperial units of measure

SpeedLimitWarningThreshold

Overview
Description An enum of the speed by which the driver must exceed the speed limit to receive a warning.
Supported on Android Since Version 9.6.0.821
Type Enum
Package com.alk.cpik.trip

Values

Value Description
LEVEL_0 Exceeding the speed limit by 5 mph/kph
LEVEL_1 Exceeding the speed limit by 10 mph/kph
LEVEL_2 Exceeding the speed limit by 15 mph/kph
LEVEL_3 Exceeding the speed limit by 20 mph/kph
LEVEL_4 Exceeding the speed limit by 25 mph/kph
LEVEL_5 Exceeding the speed limit by 30 mph/kph

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

AlertRange

Overview
Description An enum of the proximity to a safety camera at which the driver will be alerted.
Supported on Android Since Version 9.6.0.821
Type Enum
Package com.alk.cpik.trip

Values

Value Description
SHORT_RANGE This represent short range alert.
MEDIUM_RANGE This represent medium range alert.
LONG_RANGE This represent long range alert.

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

TurnArrowImage

Overview
Description An enum of the turn arrow images used by CoPilot.
Supported on Android Since Version 9.6.0.821
Platforms Supported Android, Linux
Type Enum
Package com.alk.cpik.trip

Values

ID Value V9 Image V10 Image
NONE
0 STRAIGHT icon image1
1 TURN_LEFT image2 image2
2 TURN_RIGHT image3 image3
3 SLIGHT_LEFT image4 image4
4 SLIGHT_RIGHT image5 image5
5 SHARP_LEFT image6 image6
6 SHARP_RIGHT image7 image7
7 LEFTSIDE_UTURN image8 image8
8 WAYPOINT_FLAG image9 image10
9 START_POINT_FLAG image11 image12
10 END_POINT_FLAG image13 image14
11 ROUNDABOUT_LEFTSIDE_STRAIGHT image15 image15
12 ROUNDABOUT_LEFTSIDE_LEFT image16 image16
13 ROUNDABOUT_LEFTSIDE_RIGHT image17 image17
14 ROUNDABOUT_LEFTSIDE_SLIGHT_LEFT image18 image18
15 ROUNDABOUT_LEFTSIDE_SLIGHT_RIGHT image19 image19
16 ROUNDABOUT_LEFTSIDE_SHARP_LEFT image20 image20
17 ROUNDABOUT_LEFTSIDE_SHARP_RIGHT image21 image21
18 ROUNDABOUT_LEFTSIDE_UTURN image22 image22
19 ROUNDABOUT_RIGHTSIDE_STRAIGHT image23 image23
20 ROUNDABOUT_RIGHTSIDE_LEFT image24 image24
21 ROUNDABOUT_RIGHTSIDE_RIGHT image25 image25
22 ROUNDABOUT_RIGHTSIDE_SLIGHT_LEFT image26 image26
23 ROUNDABOUT_RIGHTSIDE_SLIGHT_RIGHT image27 image27
24 ROUNDABOUT_RIGHTSIDE_SHARP_LEFT image28 image28
25 ROUNDABOUT_RIGHTSIDE_SHARP_RIGHT image29 image29
26 ROUNDABOUT_RIGHTSIDE_UTURN image30 image30
27 RIGHTSIDE_UTURN image31 image31
28 MERGE_LEFT image32 image32
29 MERGE_RIGHT image33 image33
30 LEFTSIDE_OFFRAMP image34 image34
31 RIGHTSIDE_OFFRAMP image35 image35
33 INTERMEDIATE_STOP_FLAG image36 image37

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated
Last updated August 17, 2021.