Documentation de référence sur la struct FlpLocationInterface
#include <
fused_location.h
>
Champs de données |
|
| size_t | size |
| int(* | init )( FlpCallbacks *callbacks) |
| int(* | get_batch_size )() |
| int(* | start_batching )(int id, FlpBatchOptions *options) |
| int(* | update_batching_options )(int id, FlpBatchOptions *new_options) |
| int(* | stop_batching )(int id) |
| void(* | cleanup () |
| void(* | get_batched_location )(int last_n_locations) |
| int(* | inject_location )( FlpLocation *location) |
| const void *(* | get_extension )(const char *name) |
| void(* | flush_batched_locations )() |
Description détaillée
Représente l'interface FLP standard.
Définition à la ligne 321 du fichier fused_location.h .
Documentation des champs
| void(* cleanup)() |
Ferme l'interface. Si des opérations par lot sont en cours, elles doivent être arrêtées.
Définition à la ligne 398 du fichier fused_location.h .
| void(* flush_batched_locations)() |
Récupérez tous les emplacements groupés actuellement stockés et effacez la mémoire tampon. flp_location_callback DOIT être appelé en réponse, même s'il n'y a pas d'emplacements à effacer (dans ce cas, num_locations doit être défini sur 0). Les appels suivants à get_batched_location ou flush_batched_locations ne doivent pas renvoyer les lieux renvoyés dans cet appel.
Définition à la ligne 436 du fichier fused_location.h .
| int(* get_batch_size)() |
Renvoie la taille de lot (en nombre d'objets FlpLocation ) disponible sur le matériel. Notez que les tailles d'échantillon peuvent varier selon les implémentations matérielles. Cette valeur doit renvoyer le nombre d'échantillons définis au format FlpLocation . La couche supérieure l'utilisera pour déterminer l'intervalle de traitement par lot et si l'AP doit être réveillé ou non.
Définition à la ligne 343 du fichier fused_location.h .
| void(* get_batched_location)(int last_n_locations) |
Obtenez la position fusionnée qui a été groupée. flp_location_callback est utilisé pour renvoyer la position. L'objet d'emplacement n'est supprimé de la mémoire tampon que lorsqu'elle est pleine. Ne le supprimez pas du tampon simplement parce qu'il a été renvoyé à l'aide du rappel. En d'autres termes, lorsqu'il n'y a pas de nouvel objet de position, deux appels à get_batched_location(1) doivent renvoyer le même objet de position. Paramètres : last_n_locations : nombre d'établissements à obtenir. Il peut s'agir d'un ou de plusieurs. Si la valeur de last_n_locations est "1", vous obtenez la dernière position connue par le matériel.
Définition à la ligne 412 du fichier fused_location.h .
| const void*(* get_extension)(const char *name) |
Obtenez un pointeur vers les informations de l'extension.
Définition à la ligne 427 du fichier fused_location.h .
| int(* init)( FlpCallbacks *callbacks) |
Ouvre l'interface et fournit les routines de rappel à l'implémentation de cette interface. Une fois appelé, vous devez répondre en appelant le rappel flp_capabilities_callback dans FlpCallbacks pour spécifier les fonctionnalités compatibles avec votre implémentation.
Définition à la ligne 333 du fichier fused_location.h .
| int(* inject_location)( FlpLocation *location) |
Injecte la position actuelle à partir d'un autre fournisseur de position. La latitude et la longitude sont mesurées en degrés, et la précision attendue est mesurée en mètres. Paramètres : location : l'objet de localisation injecté. Valeur renvoyée: FLP_RESULT_SUCCESS ou FLP_RESULT_ERROR.
Définition à la ligne 422 du fichier fused_location.h .
| taille_t |
défini sur sizeof(FlpLocationInterface)
Définition à la ligne 325 du fichier fused_location.h .
| int(* start_batching)(int id, FlpBatchOptions *options) |
Commencez à regrouper des établissements. Cette API est principalement utilisée lorsque l'AP est en veille et que l'appareil peut regrouper des positions dans le matériel. flp_location_callback permet de renvoyer les positions. Lorsque le tampon est plein et que FLP_BATCH_WAKEUP_ON_FIFO_FULL est utilisé, le point d'accès est réveillé. Lorsque le tampon est plein et que FLP_BATCH_WAKEUP_ON_FIFO_FULL n'est pas défini, l'objet d'emplacement le plus ancien est supprimé. Dans ce cas, l'AP ne sera pas réveillé. La couche supérieure utilisera l'API get_batched_location pour demander explicitement l'emplacement. Si FLP_BATCH_CALLBACK_ON_LOCATION_FIX est défini, l'implémentation appelle flp_location_callback chaque fois qu'une correction de position est effectuée. Ce paramètre remplace le paramètre d'indicateur FLP_BATCH_WAKEUP_ON_FIFO_FULL. Il appartient aux couches supérieures (appelant) de l'éteindre, si elles savent que l'AP peut s'endormir. Cette option est utile pour les applications de navigation lorsque le système est en mode haute puissance. Paramètres : id : ID de la requête. options : consultez la définition de la structure FlpBatchOptions . Valeur renvoyée: FLP_RESULT_SUCCESS en cas de réussite, FLP_RESULT_INSUFFICIENT_MEMORY, FLP_RESULT_ID_EXISTS ou FLP_RESULT_ERROR en cas d'échec.
Définition à la ligne 367 du fichier fused_location.h .
| int(* stop_batching)(int id) |
Arrêtez le traitement par lot. Paramètres : id : ID de la requête. Valeur renvoyée: FLP_RESULT_SUCCESS en cas de réussite, FLP_RESULT_ID_UNKNOWN ou FLP_RESULT_ERROR en cas d'échec.
Définition à la ligne 392 du fichier fused_location.h .
| int(* update_batching_options)(int id, FlpBatchOptions *new_options) |
Mise à jour des FlpBatchOptions associés à une requête de traitement par lot. Lorsqu'une opération de traitement par lot est en cours et qu'une option de traitement par lot telle que FLP_BATCH_WAKEUP_ON_FIFO_FULL doit être mise à jour, cette API est utilisée. Par exemple, cela peut se produire lorsque l'AP est actif et que l'application Maps est utilisée. Paramètres : id : ID d'une requête par lot existante. new_options : FlpBatchOptions Valeur renvoyée : FLP_RESULT_SUCCESS en cas de réussite, FLP_RESULT_ID_UNKNOWN, FLP_RESULT_ERROR en cas d'erreur.
Définition à la ligne 382 du fichier fused_location.h .
La documentation de ce struct a été générée à partir du fichier suivant :
- hardware/libhardware/include/hardware/ fused_location.h