FlpLocationInterface 結構參考

資料欄位
FlpLocationInterface 結構參考

#include < fused_location.h >

資料欄位

尺寸_t尺寸
整數（*初始化)( FlpCallbacks *回呼)
整數（*取得批次大小）（）
整數（* start_batching ）（int id， FlpBatchOptions *選項）
整數（* update_batching_options )(int id, FlpBatchOptions *new_options)
整數（* stop_batching ）（int id）
空白（*清理）（）
空白（* get_batched_location ）（int last_n_locations）
整數（*注入位置)( FlpLocation *位置)
常量無效 *(* get_extension )(const char *name)
空白（*刷新批次位置)()

詳細說明

代表標準 FLP 介面。

檔案fused_location.h第321行的定義。

現場文檔

無效（*清理）（）

關閉介面。如果正在進行任何批次操作，則應停止它們。

檔案fused_location.h第398行的定義。

void(*flush_batched_locations)()

檢索目前儲存的所有批次位置並清除緩衝區。 flp_location_callback 必須在回應中調用，即使沒有要刷新的位置（在這種情況下 num_locations 應為 0）。對 get_batched_location 或lush_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)( FlpCallbacks *回呼)

開啟介面並為該介面的實作提供回調例程。一旦調用，您應該透過調用FlpCallbacks中的 flp_capability_callback 來回應，以指定您的實作支援的功能。

檔案fused_location.h第333行的定義。

int(* 注入位置)( FlpLocation *位置)

從另一個位置提供者註入目前位置 緯度和經度以度為單位測量 預期精度以米為單位 參數： location - 被注入的位置物件。傳回值：FLP_RESULT_SUCCESS 或 FLP_RESULT_ERROR。

文件fused_location.h第422行的定義。

size_t 尺寸

設定為 sizeof(FlpLocationInterface)

檔案fused_location.h第325行的定義。

int(* start_batching)(int id, FlpBatchOptions *選項)

開始配料地點。此 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, FlpBatchOptions *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行的定義。

該結構的文檔是從以下文件產生的：