Singleton qui fournit des méthodes pour contrôler la navigation.
Toutes les méthodes sont thread-safe, à l'exception de setAudioGuidance et setHeadsUpNotificationEnabled, qui doivent être appelées sur le thread UI.
Récapitulatif des classes imbriquées
interface | Navigator.ArrivalListener | Définit les signatures des méthodes appelées lorsque le conducteur arrive à un point de cheminement. | |
@interface | Navigator.AudioGuidance | AudioGuidance est un ensemble d'indicateurs permettant de spécifier les types d'alertes et de guidage audio utilisés pendant la navigation. | |
interface | Navigator.RemainingTimeOrDistanceChangedListener | Définit les signatures pour les méthodes appelées lorsque le temps ou la distance restants avant la destination suivante change. | |
interface | Navigator.RouteChangedListener | Définit les signatures pour les méthodes appelées lorsque l'itinéraire change. | |
enum | Navigator.RouteStatus | Un RouteStatus est un code d'état qui représente le résultat d'un calcul d'itinéraire, accessible via l'objet Future renvoyé par setDestination(Waypoint) . |
Récapitulatif des méthodes publiques
abstrait vide |
cleanup()
Nettoie l'état interne du navigateur.
|
abstrait vide |
clearDestinations()
Efface toutes les destinations définies précédemment et tous les itinéraires calculés sur la carte.
|
abstrait vide |
clearLicensePlateRestrictionInfo()
Efface les informations sur la plaque d'immatriculation du conducteur actuel.
|
abstrait vide |
clearRemainingTimeOrDistanceChangedListener()
Efface l'écouteur pour les modifications apportées au temps ou à la distance restants.
|
abstrait Waypoint |
continueToNextDestination()
Supprime la destination actuelle.
|
abstrait ListenableResultFuture<RouteInfo> |
fetchRouteInfo(point de cheminement Waypoint, RoutingOptions routerOptions)
Renvoie des informations sur les itinéraires en fonction de chaque valeur de
RoutingOptions.RoutingStrategy . |
abstrait RouteSegment |
getCurrentRouteSegment()
Renvoie l'étape actuelle du trajet.
|
abstrait TimeAndDistance |
getCurrentTimeAndDistance()
Renvoie la durée et la distance estimées entre la position actuelle et la destination actuelle.
|
abstract List<RouteSegment> |
getRouteSegments()
Renvoie une liste de segments d'itinéraire.
|
abstrait Simulateur |
getSimulator()
Renvoie un objet de simulateur à utiliser lors des tests.
|
abstrait List<TimeAndDistance> |
getTimeAndDistanceList()
Renvoie une liste des durées et des distances correspondant à chaque destination de l'itinéraire actuel, représentant la durée et la distance estimées entre la position actuelle et chaque destination.
|
abstrait List<LatLng> |
getTraveledRoute()
Renvoie l'itinéraire emprunté jusqu'à présent au cours de cette session de guidage (depuis le dernier appel à
startGuidance() ). |
abstrait booléen |
isGuidanceRunning()
Renvoie
true si le guidage est en cours d'exécution. |
abstrait vide |
setArrivalListener(écouteur Navigator.ArrivalListener)
Enregistre un écouteur pour les événements d'arrivée.
|
abstrait vide |
setAudioGuidance(guide intégré)
Définit les types de guidage audio (y compris le vibreur) activés.
|
abstrait ListenableResultFuture<Navigator.RouteStatus> |
setDestination(destination Waypoint, RoutingOptions routerOptions, DisplayOptions displayOptions)
Définit une destination unique pour la navigation, en remplaçant toutes les destinations précédemment définies.
|
abstrait ListenableResultFuture<Navigator.RouteStatus> |
setDestination(destination Waypoint, RoutingOptions)
Définit une destination unique pour la navigation, en remplaçant toutes les destinations précédemment définies.
|
abstrait ListenableResultFuture<Navigator.RouteStatus> |
setDestination(destination Waypoint)
Définit une destination unique pour la navigation, en remplaçant toutes les destinations précédemment définies.
|
abstrait ListenableResultFuture<Navigator.RouteStatus> |
setDestinations(options List<Waypoint>, RoutingOptions)
Définit plusieurs destinations pour la navigation, remplaçant toutes les destinations précédemment définies.
|
abstrait ListenableResultFuture<Navigator.RouteStatus> |
setDestinations(List<Waypoint> destinations, RoutingOptions routerOptions, DisplayOptions displayOptions)
Définit plusieurs destinations pour la navigation, remplaçant toutes les destinations précédemment définies.
|
abstrait ListenableResultFuture<Navigator.RouteStatus> |
setDestinations(List<Waypoint> destinations)
Définit plusieurs destinations pour la navigation, remplaçant toutes les destinations précédemment définies.
|
abstrait vide |
setHeadsUpNotificationEnabled(valeur booléenne activée)
Détermine si les notifications prioritaires doivent être affichées.
|
abstrait vide |
setLicensePlateRestrictionInfo(int rawLicensePlateLastDigit, String licensePlateCountryCode)
Définit les informations sur la plaque d'immatriculation du conducteur actuel.
|
abstrait vide |
setRemainingTimeOrDistanceChangedListener(int timeChangeThresholdSecond, int distanceChangeThresholdMeters, écouteur Navigator.RemainingTimeOrDistanceChangedListener)
Enregistre un écouteur lorsque le temps ou la distance restants vers la destination changent de plus d'un seuil spécifié.
|
abstrait vide |
setRouteChangedListener(écouteur Navigator.RouteChangedListener)
Enregistre un écouteur pour les événements de modification de route.
|
abstrait vide |
setSpeedingListener(SpeedingListener SpeedingListener)
Enregistre une valeur
SpeedingListener correspondant au pourcentage supérieur à la limite de vitesse actuelle du conducteur. |
abstrait vide |
startGuidance(Intent CVIntent)
Identique à
startGuidance() , mais en spécifiant un intent qui peut être utilisé pour réactiver l'application à partir de la notification de la barre d'état du navigateur. |
abstrait vide |
startGuidance()
Si une destination a été définie et qu'un itinéraire lui a été calculé, la fonctionnalité de navigation détaillée est activée pour l'itinéraire en question.
|
abstrait vide |
stopGuidance()
Arrête la navigation détaillée.
|
Méthodes publiques
public abstrait vide cleanup ()
Nettoie l'état interne du navigateur.
Remarque: L'appel de cette méthode annulera toutes les demandes en attente envoyées à setDestinations(List
.
public abstract void clearDestinations ()
Efface toutes les destinations définies précédemment et tous les itinéraires calculés sur la carte. Si la navigation est en cours d'exécution, elle sera automatiquement arrêtée.
public abstrait vide clearLicensePlateRestrictionInfo ()
Efface les informations sur la plaque d'immatriculation du conducteur actuel. Cela ne s'appliquera qu'aux appels setDestination effectués après la définition de cette valeur.
public extrait vide clearRemainingTimeOrDistanceChangedListener ()
Efface l'écouteur pour les modifications apportées au temps ou à la distance restants.
public abstrait Waypoint continueToNextDestination ()
Supprime la destination actuelle. À la suite de cet appel, le guidage sera dirigé vers la destination suivante, et les informations sur l'ancienne destination ne seront plus disponibles.
Renvoie
- le guidage se dirige désormais vers les points de cheminement, ou la valeur "null" s'il ne reste plus de points de cheminement
public abstrait ListenableResultFuture<RouteInfo> fetchRouteInfo (point de cheminement Waypoint, RoutingOptions routerOptions)
Renvoie des informations sur les itinéraires en fonction de chaque valeur de RoutingOptions.RoutingStrategy
. Le champ RoutingOptions.RoutingStrategy
est ignoré, car cette méthode renvoie les informations sur l'itinéraire pour toutes les stratégies de routage.
Remarque: Cette valeur est recalculée à chaque appel et peut ne pas correspondre aux itinéraires actuellement utilisés par la navigation, car le trafic et d'autres facteurs peuvent avoir été modifiés entre temps.
Paramètres
waypoint | le point de cheminement de destination de l'itinéraire ; |
---|---|
routingOptions | les options utilisées pour récupérer les informations sur l'itinéraire. |
Renvoie
- le futur renvoyé
public abstrait RouteSegment getCurrentRouteSegment ()
Renvoie l'étape actuelle du trajet. La position de départ de ce RouteSegment correspond à la dernière position connue de l'appareil (en cas d'ancrage sur la route).
Renvoie
- un objet Segment d'itinéraire, ou
null
en l'absence d'itinéraire actuel
public abstrait TimeAndDistance getCurrentTimeAndDistance ()
Renvoie la durée et la distance estimées entre la position actuelle et la destination actuelle.
Renvoie
- un objet de temps et de distance, ou
null
si aucun itinéraire actuel n'est indiqué.
public abstrait List<RouteSegment> getRouteSegments ()
Renvoie une liste de segments d'itinéraire. La destination de chaque segment renvoyé correspond à une destination définie par setDestination(s).
public abstract List<TimeAndDistance> getTimeAndDistanceList ()
Renvoie une liste des durées et des distances correspondant à chaque destination de l'itinéraire actuel, représentant la durée et la distance estimées entre la position actuelle et chaque destination.
public abstrait List<LatLng> getTraveledRoute ()
Renvoie l'itinéraire emprunté jusqu'à présent au cours de cette session de guidage (depuis le dernier appel à startGuidance()
). L'itinéraire enregistré comprend les lieux sur lesquels des liens ont été enregistrés, tels qu'ils seraient renvoyés par RoadSnappedLocationProvider
. Il est simplifié pour supprimer les points redondants, par exemple en transformant des points collinaires consécutifs en un seul segment de ligne.
public abstrait booléen isGuidanceRunning ()
Renvoie true
si le guidage est en cours d'exécution. Notez que le guidage ne s'exécute que lorsqu'un itinéraire vers une destination a été calculé et que startGuidance()
a été appelé.
public abstrait void setArrivalListener (écouteur Navigator.ArrivalListener)
Enregistre un écouteur pour les événements d'arrivée. Remplace tous les écouteurs précédemment enregistrés.
Remarque: Pour éviter les fuites de mémoire, setNavArrivalListener(null)
doit être appelé lorsque l'écouteur n'est plus nécessaire.
Paramètres
écouteur | l'écouteur à enregistrer. Peut être défini sur null pour effacer un écouteur enregistré précédemment.
|
---|
public abstract void setAudioGuidance (int guide)
Définit les types de guidage audio (y compris le vibreur) activés. Par défaut, le vibreur, la voix et la voix sur Bluetooth (si disponibles) sont activés.
Cette méthode doit être appelée au niveau du thread UI.
Paramètres
conseils | une combinaison d'indicateurs Navigator.AudioGuidance spécifiant les types de guidage audio à activer.
|
---|
public abstract ListenableResultFuture<Navigator.RouteStatus> setDestination (Waypoint destination, RoutingOptions routerOptions, DisplayOptions displayOptions)
Définit une destination unique pour la navigation, en remplaçant toutes les destinations précédemment définies. Le futur renvoyé sera défini sur OK
si un itinéraire est trouvé entre la position de l'utilisateur et la destination donnée.
Paramètres
destination | définir la nouvelle destination |
---|---|
routingOptions | les options qui seront utilisées pour générer le routage |
displayOptions | les options qui seront utilisées pour afficher l'itinéraire |
Renvoie
- le futur renvoyé
Génère
NullPointerException | si la destination donnée est nulle |
---|
public abstract ListenableResultFuture<Navigator.RouteStatus> setDestination (destination Waypoint, RoutingOptions options)
Définit une destination unique pour la navigation, en remplaçant toutes les destinations précédemment définies. Le futur renvoyé sera défini sur OK
si un itinéraire est trouvé entre la position de l'utilisateur et la destination donnée. La valeur par défaut DisplayOptions
permet d'afficher la route.
Paramètres
destination | définir la nouvelle destination |
---|---|
options | les options qui seront utilisées pour générer le routage |
Renvoie
- le futur renvoyé
Génère
NullPointerException | si la destination donnée est nulle |
---|
public abstrait ListenableResultFuture<Navigator.RouteStatus> setDestination (destination Waypoint)
Définit une destination unique pour la navigation, en remplaçant toutes les destinations précédemment définies. Le futur renvoyé sera défini sur OK
si un itinéraire est trouvé entre la position de l'utilisateur et la destination donnée. La route sera utilisée à l'aide de la valeur par défaut RoutingOptions
, et de son affichage par la valeur DisplayOptions
par défaut.
Paramètres
destination | définir la nouvelle destination |
---|
Renvoie
- le futur renvoyé
Génère
NullPointerException | si la destination donnée est nulle |
---|
public abstract ListenableResultFuture<Navigator.RouteStatus> setDestinations (List<Waypoint> destinations, RoutingOptions options)
Définit plusieurs destinations pour la navigation, remplaçant toutes les destinations précédemment définies. Le futur renvoyé sera défini sur OK
si un itinéraire est trouvé entre la position de l'utilisateur et la destination donnée. La valeur par défaut DisplayOptions
permet d'afficher la route.
Paramètres
destinations | définir la nouvelle liste de destination |
---|---|
options | les options qui seront utilisées pour générer le routage |
Renvoie
- le futur renvoyé
public abstract ListenableResultFuture<Navigator.RouteStatus> setDestinations (List<Waypoint> destinations, RoutingOptions routerOptions, DisplayOptions displayOptions)
Définit plusieurs destinations pour la navigation, remplaçant toutes les destinations précédemment définies. Le futur renvoyé sera défini sur OK
si un itinéraire est trouvé entre la position de l'utilisateur et la destination donnée.
Paramètres
destinations | définir la nouvelle liste de destination |
---|---|
routingOptions | les options qui seront utilisées pour générer le routage |
displayOptions | les options qui seront utilisées pour afficher l'itinéraire |
Renvoie
- le futur renvoyé
public abstract ListenableResultFuture<Navigator.RouteStatus> setDestinations (List<Waypoint> destinations)
Définit plusieurs destinations pour la navigation, remplaçant toutes les destinations précédemment définies. Le futur renvoyé sera défini sur OK
si un itinéraire est trouvé entre la position de l'utilisateur et la destination donnée. La route sera utilisée à l'aide de la valeur par défaut RoutingOptions
, et de son affichage par la valeur DisplayOptions
par défaut.
Paramètres
destinations | définir la nouvelle liste de destination |
---|
Renvoie
- le futur renvoyé
public abstrait vide setHeadsUpNotificationEnabled (boolean enabled)
Détermine si les notifications prioritaires doivent être affichées. La notification est activée par défaut. Il s'agit d'événements de guidage tels que des changements de direction, etc. qui s'affichent lorsqu'aucune carte n'est visible.
Cette méthode doit être appelée au niveau du thread UI.
Paramètres
activé | Un indicateur pour indiquer si les notifications prioritaires doivent être activées |
---|
public extrait vide setLicensePlateRestrictionInfo (intrawLicensePlateLastDigit, String LicensePlateCountryCode)
Définit les informations sur la plaque d'immatriculation du conducteur actuel. Cela nous permet d'éviter certains types de routes limitées en fonction de leur numéro de plaque d'immatriculation. Cela ne s'appliquera qu'aux appels setDestination effectués après la définition de cette valeur. Idéalement, vous devriez l'appeler immédiatement après avoir obtenu le navigateur.
Paramètres
rawLicensePlateLastDigit | Le dernier chiffre de la plaque d'immatriculation (doit être compris entre 0 et 9) |
---|---|
licensePlateCountryCode | Nous acceptons actuellement que les produits basés sur l'Indonésie (ID) et le Brésil (BZ) soient encore acceptés à l'avenir. Vous pouvez donc nous fournir ces informations de manière proactive. |
public abstrait vide setRemainingTimeOrDistanceChangedListener (int timeChangeThresholdSeconds, int distanceChangeThresholdMeters, écouteur Navigator.RemainingTimeOrDistanceChangedListener)
Enregistre un écouteur lorsque le temps ou la distance restants vers la destination changent de plus d'un seuil spécifié. Remplace tous les écouteurs précédemment enregistrés.
L'écouteur peut être appelé suite aux déplacements de l'utilisateur, à une modification des conditions de circulation, à un changement d'itinéraire, à un changement de destination, ou encore lorsque le temps et la distance restants sont connus pour la première fois.
Remarque: Pour éviter les fuites de mémoire, clearNavProgressionListener()
doit être appelé lorsque l'écouteur n'est plus nécessaire.
Paramètres
timeChangeThresholdSeconds | Si la variation absolue du temps restant en secondes est supérieure ou égale à cette valeur, l'écouteur est appelé. Ce seuil ne doit pas être négatif. |
---|---|
distanceChangeThresholdMeters | Si la variation absolue de la distance restante en mètres est supérieure ou égale à cette valeur, l'écouteur est appelé. Ce seuil ne doit pas être négatif. |
écouteur | l'écouteur à enregistrer. Ne doit pas être null .
|
public abstrait vide setRouteChangedListener (écouteur Navigator.RouteChangedListener)
Enregistre un écouteur pour les événements de modification de route. Remplace tous les écouteurs précédemment enregistrés.
Remarque: Pour éviter les fuites de mémoire, setNavRouteChangeListener(null)
doit être appelé lorsque l'écouteur n'est plus nécessaire.
Paramètres
écouteur | l'écouteur à enregistrer. Peut être défini sur null pour effacer un écouteur enregistré précédemment.
|
---|
public abstrait vide setSpeedingListener (SpeedingListener SpeedingListener)
Enregistre une valeur SpeedingListener
correspondant au pourcentage supérieur à la limite de vitesse actuelle du conducteur.
Si vous définissez une SpeedingListener
sur null
, vous ne recevrez aucune donnée de flux d'excès de vitesse.
Paramètres
speedingListener |
---|
public abstrait vide startGuidance (réactivation de l'intent)
Identique à startGuidance()
, mais en spécifiant un intent qui peut être utilisé pour réactiver l'application à partir de la notification de la barre d'état du navigateur. Sans cet intent, il n'est pas possible de réactiver l'application à partir de la barre d'état.
Paramètres
resumeIntent | l'intent pour réactiver l'application. Dans la plupart des cas, la valeur renvoyée par android.app.Activity#getIntent() conviendra.
|
---|
public abstrait vide startGuidance ()
Si une destination a été définie et qu'un itinéraire lui a été calculé, la fonctionnalité de navigation détaillée est activée pour l'itinéraire en question. Si l'itinéraire n'a pas encore été calculé, la navigation détaillée sera activée par la suite.
Vous devez appeler explicitement stopGuidance() pour arrêter le service de navigation. Le service de navigation ne s'arrête pas automatiquement à votre arrivée. Si vous souhaitez arrêter le service de navigation à l'arrivée, vous devez appeler stopGuidance() dans le NavArrivalListener.
Remarque: Cette méthode ne modifie pas la position de Camera
.
public abstrait vide stopGuidance ()
Arrête la navigation détaillée.