Referência da estrutura FlpLocationInterface

Campos de dados
Referência da estrutura FlpLocationInterface

#include < fused_location.h >

Campos de dados

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

Descrição detalhada

Representa a interface padrão do FLP.

Definição na linha 321 do arquivo fused_location.h .

Documentação do campo

void(* cleanup)()

Fecha a interface. Se houver operações em lote em andamento, elas precisam ser interrompidas.

Definição na linha 398 do arquivo fused_location.h .

void(* flush_batched_locations)()

Extraia todos os locais em lote armazenados e limpe o buffer. O flp_location_callback PRECISA ser chamado em resposta, mesmo que não haja locais para limpar. Nesse caso, o num_locations precisa ser 0. As chamadas subsequentes para get_batched_location ou flush_batched_locations não devem retornar nenhum dos locais retornados nesta chamada.

Definição na linha 436 do arquivo fused_location.h .

int(* get_batch_size)()

Retorna o tamanho do lote (no número de objetos FlpLocation disponíveis no hardware). Diferentes implementações de hardware podem ter tamanhos de amostra diferentes. Isso vai retornar o número de amostras definidas no formato FlpLocation . Isso será usado pela camada superior para decidir o intervalo de lote e se o AP precisa ser ativado ou não.

Definição na linha 343 do arquivo fused_location.h .

void(* get_batched_location)(int last_n_locations)

Receba a localização combinada que foi agrupada. O flp_location_callback é usado para retornar a localização. O objeto de local é removido do buffer somente quando ele está cheio. Não remova o buffer apenas porque ele foi retornado usando o callback. Em outras palavras, quando não há um novo objeto de local, duas chamadas para get_batched_location(1) precisam retornar o mesmo objeto. Parâmetros: last_n_locations: número de locais a serem recebidos. Pode ser um ou vários. Se o last_n_locations for 1, você vai receber o último local conhecido pelo hardware.

Definição na linha 412 do arquivo fused_location.h .

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

Receber um ponteiro para informações da extensão.

Definição na linha 427 do arquivo fused_location.h .

int(* init)( FlpCallbacks *callbacks)

Abre a interface e fornece as rotinas de callback para a implementação dela. Depois de ser chamada, responda chamando o flp_capabilities_callback em FlpCallbacks para especificar os recursos compatíveis com a implementação.

Definição na linha 333 do arquivo fused_location.h .

int(* inject_location)( FlpLocation *location)

Injeta a localização atual de outro provedor de localização. A latitude e a longitude são medidas em graus, e a precisão esperada é medida em metros. Parâmetros: location: o objeto de localização que está sendo injetado. Valor de retorno: FLP_RESULT_SUCCESS ou FLP_RESULT_ERROR.

Definição na linha 422 do arquivo fused_location.h .

tamanho_t size

definido como sizeof(FlpLocationInterface)

Definição na linha 325 do arquivo fused_location.h .

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

Comece a agrupar locais. Essa API é usada principalmente quando o AP está em suspensão e o dispositivo pode agrupar locais no hardware. O flp_location_callback é usado para retornar os locais. Quando o buffer está cheio e FLP_BATCH_WAKEUP_ON_FIFO_FULL é usado, o AP é ativado. Quando o buffer está cheio e FLP_BATCH_WAKEUP_ON_FIFO_FULL não está definido, o objeto de local mais antigo é descartado. Nesse caso, o AP não será ativado. A camada superior vai usar a API get_batched_location para solicitar explicitamente o local. Se FLP_BATCH_CALLBACK_ON_LOCATION_FIX estiver definido, a implementação vai chamar flp_location_callback sempre que houver uma correção de localização. Isso substitui a configuração da flag FLP_BATCH_WAKEUP_ON_FIFO_FULL. É responsabilidade das camadas superiores (chamada) desativá-lo, se souberem que o AP pode entrar em suspensão. Isso é útil para aplicativos de navegação quando o sistema está no modo de alta potência. Parâmetros: id: ID da solicitação. options: consulte a definição do struct FlpBatchOptions . Valor de retorno: FLP_RESULT_SUCCESS em caso de sucesso, FLP_RESULT_INSUFFICIENT_MEMORY, FLP_RESULT_ID_EXISTS, FLP_RESULT_ERROR em caso de falha.

Definição na linha 367 do arquivo fused_location.h .

int(* stop_batching)(int id)

Interrompa a execução em lote. Parâmetros: id: o ID da solicitação. Valor de retorno: FLP_RESULT_SUCCESS em caso de sucesso, FLP_RESULT_ID_UNKNOWN ou FLP_RESULT_ERROR em caso de falha.

Definição na linha 392 do arquivo fused_location.h .

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

Atualize FlpBatchOptions associado a uma solicitação de lote. Quando uma operação de lote estiver em andamento e uma opção de lote, como FLP_BATCH_WAKEUP_ON_FIFO_FULL, precisar ser atualizada, essa API será usada. Isso pode acontecer quando o AP está ativo e o aplicativo Maps está sendo usado. Parâmetros: id: ID de uma solicitação de lote existente. new_options: FlpBatchOptions atualizado. O valor de retorno é FLP_RESULT_SUCCESS em caso de sucesso, FLP_RESULT_ID_UNKNOWN ou FLP_RESULT_ERROR em caso de erro.

Definição na linha 382 do arquivo fused_location.h .

A documentação desse struct foi gerada com base no seguinte arquivo: