FlpLocationInterface 結構體參考

資料欄位
FlpLocationInterface 結構體參考資料

#include < fused_location.h >

資料欄位

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 )()
 

詳細說明

代表標準 FLP 介面。

定義位於檔案 fused_location.h 的 321 行。

欄位說明文件

void(* cleanup)()

關閉介面。如果有任何批次作業正在進行，應停止這些作業。

定義位於檔案 fused_location.h 的 398 行。

void(* flush_batched_locations)()

擷取目前儲存的所有批次位置並清除緩衝區。即使沒有要清除的位置 (此時 num_locations 應為 0)，也必須在回應中呼叫 flp_location_callback。後續對 get_batched_location 或 flush_batched_locations 的呼叫不應傳回此呼叫中傳回的任何位置。

定義位於檔案 fused_location.h 的 436 行。

int(* get_batch_size)()

傳回硬體中可用的批次大小 (以 FlpLocation 物件數量為單位)。請注意，不同硬體實作可能有不同的取樣大小。這項作業會傳回以 FlpLocation 格式定義的取樣數。上層會使用這個值，決定批次處理間隔，以及是否應喚醒 AP。

定義位於檔案 fused_location.h 的 343 行。

void(* get_batched_location)(int last_n_locations)

取得已批次處理的整合式位置。flp_location_callback 會用來傳回位置。只有在緩衝區已滿時，系統才會從緩衝區中捨棄位置物件。請勿僅因已使用回呼傳回而從緩衝區中移除。換句話說，如果沒有新的位置物件，兩次呼叫 get_batched_location(1) 應會傳回相同的位置物件。參數：last_n_locations - 要取得的地點數量。可以是單一或多個。如果 last_n_locations 為 1，您會取得硬體所知的最新位置。

定義位於檔案 fused_location.h 的 412 行。

const void*(* get_extension)(const char *name)

取得擴充資料資訊的指標。

定義位於檔案 fused_location.h 的 427 行。

int(* init)( FlpClientCallbacks *callbacks)

開啟介面，並為此介面的實作提供回呼例程。接到呼叫後，您應呼叫 FlpCallbacks 中的 flp_capabilities_callback 來回應，指定實作項目支援的功能。

定義位於檔案 fused_location.h 的 333 行。

int(* inject_location)( FlplLocation *location)

從其他位置提供者插入目前位置，經緯度以度為單位，預期精確度以公尺為單位 參數：位置 - 要插入的位置物件。傳回值：FLP_RESULT_SUCCESS 或 FLP_RESULT_ERROR。

定義位於檔案 fused_location.h 的 422 行。

size_t size

設為 sizeof(FlpLocationInterface)

定義位於檔案 fused_location.h 的 325 行。

int(* start_batching)(int id, FlpBatchOptions *options)

開始批次處理地點。這個 API 主要用於 AP 處於休眠狀態，且裝置可在硬體中批次處理位置資訊的情況。flp_location_callback 用於傳回位置資訊。當緩衝區已滿且使用 FLP_BATCH_WAKEUP_ON_FIFO_FULL 時，AP 就會喚醒。當緩衝區已滿，且未設定 FLP_BATCH_WAKEUP_ON_FIFO_FULL 時，系統會捨棄最舊的位置物件。在這種情況下，AP 不會喚醒。上層會使用 get_batched_location API 明確要求位置資訊。如果設定了 FLP_BATCH_CALLBACK_ON_LOCATION_FIX，實作項目就會在每次有位置修正時呼叫 flp_location_callback。這會覆寫 FLP_BATCH_WAKEUP_ON_FIFO_FULL 標記設定。如果上層 (呼叫端) 知道 AP 可能會進入休眠狀態，則有責任將其關閉。當系統處於高耗電量模式時，這項做法對於導覽應用程式相當實用。參數：id - 要求的 ID。options - 請參閱 FlpBatchOptions 結構定義。傳回值：成功時為 FLP_RESULT_SUCCESS，失敗時為 FLP_RESULT_INSUFFICIENT_MEMORY、FLP_RESULT_ID_EXISTS 或 FLP_RESULT_ERROR。

定義位於檔案 fused_location.h 的 367 行。

int(* stop_batching)(int id)

停止批次處理。參數：id - 要求的 ID。傳回值：成功時為 FLP_RESULT_SUCCESS，失敗時為 FLP_RESULT_ID_UNKNOWN 或 FLP_RESULT_ERROR。

定義位於檔案 fused_location.h 的 392 行。

int(* update_batching_options)(int id, FlpIBatchOptions *new_options)

更新與批次要求相關聯的 FlpBatchOptions 。當批次作業正在進行，且需要更新批次選項 (例如 FLP_BATCH_WAKEUP_ON_FIFO_FULL) 時，系統就會使用這個 API。例如，當 AP 處於喚醒狀態且使用地圖應用程式時，就可能發生這種情況。參數：id - 現有批次要求的 ID。new_options - 已更新的 FlpBatchOptions 傳回值：成功時為 FLP_RESULT_SUCCESS，失敗時為 FLP_RESULT_ID_UNKNOWN，錯誤時為 FLP_RESULT_ERROR。

定義位於檔案 fused_location.h 的 382 行。

這個結構體的說明文件是由下列檔案產生：