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

現在保存されているバッチ処理されたロケーションをすべて取得し、バッファをクリアします。フラッシュするロケーションがない場合でも、レスポンスで flp_location_callback を呼び出す必要があります（この場合、num_locations は 0 にする必要があります）。その後の get_batched_location または flush_batched_locations の呼び出しでは、この呼び出しで返された位置情報を返さないでください。

ファイル fused_location.h の 436 行の定義。

int(* get_batch_size)()

ハードウェアで使用可能なバッチサイズ（ FlpLocation オブジェクトの数 ）を返します。なお、HW の実装によってサンプルサイズが異なる場合があります。これにより、 FlpLocation の形式で定義されたサンプル数が返されます。これは、バッチ処理間隔と AP を復帰させるかどうかを決定するために上位レイヤで使用されます。

ファイル fused_location.h の 343 行の定義。

void(* get_batched_location)(int last_n_locations)

バッチ処理された融合位置情報を取得します。flp_location_callback を使用して位置情報を返します。位置情報オブジェクトがバッファから削除されるのは、バッファがいっぱいになった場合のみです。コールバックを使用して返されたからといって、バッファから削除しないでください。つまり、新しい位置情報オブジェクトがない場合、get_batched_location(1) を 2 回呼び出すと、同じ位置情報オブジェクトが返されます。パラメータ: last_n_locations - 取得する場所の数。1 つ以上指定できます。last_n_locations が 1 の場合、ハードウェアで確認された最新の位置情報が取得されます。

ファイル fused_location.h の 412 行の定義。

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

拡張機能情報へのポインタを取得します。

ファイル fused_location.h の 427 行の定義。

int(* init)( FlpCallbacks *callbacks)

インターフェースを開き、このインターフェースの実装にコールバック ルーティンを提供します。呼び出された場合は、 FlpCallbacks で flp_capabilities_callback を呼び出して、実装がサポートする機能を指定することで応答する必要があります。

ファイル fused_location.h の 333 行の定義。

int(* inject_location)( FlpLocation *location)

別の位置情報プロバイダから現在の位置情報を挿入します。緯度と経度は度単位で測定され、想定される精度はメートル単位で測定されます。パラメータ: 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, 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 行 の定義。

この構造体のドキュメントは、次のファイルから生成されました。