NavigationService class abstract Routes & Navigation

Navigation service class

Controls navigation and route simulation sessions and provides navigation state and events.

Common operations include starting or stopping navigations and simulations, receiving periodic instruction updates, waypoint/destination notifications and TTS instructions, querying current route/instruction/status and transfer statistics, adjusting simulation speed and temporary route constraints (for example roadblocks or skipped waypoints).

Constructors

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

simulationMaxSpeedMultiplier → double
Gets the maximum simulation speed multiplier.
no setter
simulationMinSpeedMultiplier → double
Gets the minimum simulation speed multiplier.
no setter
transferStatistics → TransferStatistics
Gets the transfer statistics.
no setter

Static Methods

cancelNavigation([TaskHandler? taskHandler]) → void
Cancels the active navigation.
getBetterRouteTimeDistanceToFork({TaskHandler? taskHandler}) → TimeDistance
Gets the better route time-distance until it forks the navigation route.
getDataSource(TaskHandler navigationListener) → DataSource
Get access to navigation data source
getIntermediateWaypointDropParameters() → ParameterList
Gets recommended parameters for intermediate waypoint drop.
getNavigationInstruction({TaskHandler? taskHandler}) → NavigationInstruction?
Gets the current navigation instruction.
getNavigationParameters() → ParameterList
Gets navigation parameters.
getNavigationRoute({TaskHandler? taskHandler}) → Route
Gets the current route used for navigation.
isNavigationActive({TaskHandler? taskHandler}) → bool
Checks if there is an active navigation in progress.
isSimulationActive({TaskHandler? taskHandler}) → bool
Checks if there is an active simulation in progress.
isTripActive({TaskHandler? taskHandler}) → bool
Checks if there is an active trip (navigation or simulation) in progress.
setNavigationRoadBlock(int length, {int startDistance = -1, TaskHandler? taskHandler}) → void
Sets a roadblock on the current route, with the specified length in meters, starting from the current GPS position.
skipNextIntermediateDestination({TaskHandler? taskHandler}) → GemError
Skips the next intermediate destination on the navigation route.
startNavigation(Route route, void onNavigationInstructionUpdate(NavigationEventType eventType, NavigationInstruction? instruction)?, {void onNavigationInstruction(NavigationInstruction instruction, Set<NavigationInstructionUpdateEvents> events)?, void onNavigationStarted()?, void onTextToSpeechInstruction(String textInstruction)?, void onWaypointReached(Landmark landmark)?, void onDestinationReached(Landmark landmark)?, void onRouteUpdated(Route route)?, void onBetterRouteDetected(Route route, int travelTime, int delay, int timeGain)?, void onBetterRouteRejected(GemError reason)?, void onBetterRouteInvalidated()?, void onSkipNextIntermediateDestinationDetected()?, void onTurnAround()?, void onError(GemError error)?, void onNotifyStatusChange(NavigationStatus status)?, bool? autoPlaySound}) → TaskHandler?
Starts a new navigation session.
startSimulation(Route route, void onNavigationInstructionUpdate(NavigationEventType eventType, NavigationInstruction? instruction)?, {void onNavigationInstruction(NavigationInstruction instruction, Set<NavigationInstructionUpdateEvents> events)?, void onNavigationStarted()?, void onTextToSpeechInstruction(String textInstruction)?, void onWaypointReached(Landmark landmark)?, void onDestinationReached(Landmark landmark)?, void onRouteUpdated(Route route)?, void onBetterRouteDetected(Route route, int travelTime, int delay, int timeGain)?, void onBetterRouteRejected(GemError reason)?, void onBetterRouteInvalidated()?, void onSkipNextIntermediateDestinationDetected()?, void onTurnAround()?, void onError(GemError error)?, void onNotifyStatusChange(NavigationStatus status)?, bool? autoPlaySound, double speedMultiplier = 1.0}) → TaskHandler?
Starts a new simulation session.
updateNavigationSound(TaskHandler navigationListener) → void
Request to the navigation service to send the updated sound to the navigation listener.