Share via

Classe ASACloudSpatialAnchorSession

  • Artigo

Declaração

@interface ASACloudSpatialAnchorSession : NSObject;

Descrição

Use essa classe para criar, localizar e gerenciar âncoras espaciais.

Métodos

init

Inicializa uma nova instância com uma configuração padrão.

-(instancetype)init;

Dispose

Interrompe esta sessão e libera todos os recursos associados.

-(void)dispose;

getAccessTokenWithAuthenticationToken

Obtém o token de acesso das Âncoras Espaciais do Azure do token de autenticação.

-(void)getAccessTokenWithAuthenticationToken:(NSString *)authenticationToken withCompletionHandler:(void (^)(NSString * value, NSError *error))completionHandler;

Parâmetros

  • authenticationToken – Token de autenticação.
  • completionHandler - A cadeia de caracteres do token de acesso.

Retornos

  • void

getAccessTokenWithAccountKey

Obtém o token de acesso das Âncoras Espaciais do Azure da chave de conta.

-(void)getAccessTokenWithAccountKey:(NSString *)accountKey withCompletionHandler:(void (^)(NSString * value, NSError *error))completionHandler;

Parâmetros

  • accountKey - Chave de conta.
  • completionHandler - A cadeia de caracteres do token de acesso.

Retornos

  • void

createAnchor

Cria uma nova âncora espacial persistente com base nas propriedades de cadeia de caracteres e âncora local especificadas.

A âncora local passada para esse método deve ter uma transformação válida. Observe que algumas plataformas compatíveis com Âncoras Espaciais do Azure, como iOS, permitem transformações com o componente de escala != 1.0. O SDK de Âncoras Espaciais do Azure não dá suporte a essas transformações e não criará a âncora espacial com o código de erro InvalidAnchorTransformRigidity. Qualquer manipulação de escala para âncoras deve ser feita no nível do aplicativo.

-(void)createAnchor:(ASACloudSpatialAnchor *)anchor withCompletionHandler:(void (^)(NSError *error))completionHandler;

Parâmetros

  • anchor - Âncora a ser persistida.
  • completionHandler – Uma tarefa que representa a operação de criação assíncrona.

Retornos

  • void

createWatcher

Cria um novo objeto que observa âncoras que atendem aos critérios especificados.

-(ASACloudSpatialAnchorWatcher *)createWatcher:(ASAAnchorLocateCriteria *)criteria;

Parâmetros

  • criteria - Critérios para as âncoras observarem.

Retornos

  • ASACloudSpatialAnchorWatcher * - Um novo objeto de observador que procura continuamente âncoras até que os critérios sejam totalmente atendidos ou que o observador seja interrompido. Só pode haver um observador ativo por vez.

getAnchorProperties

Obtém uma âncora espacial de nuvem para o identificador especificado, mesmo que ele ainda não tenha sido localizado.

-(void)getAnchorProperties:(NSString *)identifier withCompletionHandler:(void (^)(ASACloudSpatialAnchor * value, NSError *error))completionHandler;

Parâmetros

  • identifier - O identificador a ser buscado.
  • completionHandler – Uma tarefa que representa a operação de recuperação assíncrona. A âncora recuperada terá valores de propriedade, mas pode não ter uma âncora local disponível.

Retornos

  • void

getNearbyAnchorIds

Obtém uma lista de todas as IDs de âncora espacial de nuvem próximas correspondentes a um determinado critério.

-(void)getNearbyAnchorIds:(ASANearDeviceCriteria *)criteria withCompletionHandler:(void (^)(NSArray * value, NSError *error))completionHandler;

Parâmetros

  • criteria - Os critérios de pesquisa.
  • completionHandler – Uma tarefa que representa a operação de recuperação assíncrona.

Retornos

  • void

getActiveWatchers

Obtém uma lista de observadores ativos.

-(NSArray<ASACloudSpatialAnchorWatcher *> *)getActiveWatchers;

Retornos

  • NSArray<ASACloudSpatialAnchorWatcher *> * - Uma lista de observadores ativos.

refreshAnchorProperties

Atualiza as propriedades da âncora espacial especificada.

-(void)refreshAnchorProperties:(ASACloudSpatialAnchor *)anchor withCompletionHandler:(void (^)(NSError *error))completionHandler;

Parâmetros

  • anchor - A âncora a ser atualizada.
  • completionHandler – Uma tarefa que representa a operação de atualização assíncrona.

Retornos

  • void

updateAnchorProperties

Atualizações a âncora espacial especificada.

-(void)updateAnchorProperties:(ASACloudSpatialAnchor *)anchor withCompletionHandler:(void (^)(NSError *error))completionHandler;

Parâmetros

  • anchor - A âncora a ser atualizada.
  • completionHandler – Uma tarefa que representa a operação de atualização assíncrona.

Retornos

  • void

deleteAnchor

Exclui uma âncora espacial persistente.

-(void)deleteAnchor:(ASACloudSpatialAnchor *)anchor withCompletionHandler:(void (^)(NSError *error))completionHandler;

Parâmetros

  • anchor - A âncora a ser excluída.
  • completionHandler – Uma tarefa que representa a operação de exclusão assíncrona.

Retornos

  • void

processFrame

Os aplicativos devem chamar esse método em plataformas em que o processamento por quadro é necessário.

Esse método não está disponível na plataforma HoloLens.

-(void)processFrame:(ARFrame *)frame;

Parâmetros

  • frame - Quadro AR a ser processado.

getSessionStatus

Obtém um objeto que descreve o status da sessão.

-(void)getSessionStatusWithCompletionHandler:(void (^)(ASASessionStatus * value, NSError *error))completionHandler;

Parâmetros

  • completionHandler - Uma tarefa que representa a recuperação de status da sessão.

Retornos

  • void

iniciar

Começa a capturar dados de ambiente para a sessão.

-(void)start;

parar

Interrompe a captura de dados de ambiente para a sessão e cancela todas as operações de localização pendentes. Os dados do ambiente são mantidos.

-(void)stop;

reset

Redefine os dados de ambiente que foram capturados nesta sessão; os aplicativos devem chamar esse método quando o rastreamento é perdido.

Em qualquer plataforma, chamar o método limpará todo o estado armazenado em cache interno.

-(void)reset;

Propriedades

delegado

Um objeto que você fornece para receber eventos dessa instância do ASACloudSpatialAnchorSession.

@property(nonatomic, assign) id<ASACloudSpatialAnchorSessionDelegate> delegate;

configuração

As informações de configuração da sessão.

As definições de configuração entrarão em vigor quando a sessão for iniciada.

@property (retain, readonly) ASASessionConfiguration * configuration;

diagnóstico

As configurações de diagnóstico para a sessão, que podem ser usadas para coletar e enviar dados para solução de problemas e melhorias.

@property (retain, readonly) ASACloudSpatialAnchorSessionDiagnostics * diagnostics;

logLevel

Nível de log para os eventos de log de sessão.

@property ASASessionLogLevel logLevel;

sessão

A sessão de acompanhamento usada para ajudar a localizar âncoras.

Essa propriedade não está disponível na plataforma HoloLens.

@property (retain) ARSession * session;

telemetryEnabled

Essa API pode ser usada para habilitar ou desabilitar a telemetria do SDK das Âncoras Espaciais do Azure. A telemetria do SDK do ASA está habilitada por padrão. Se desabilitado, o SDK do ASA não registrará nenhum evento de telemetria para esta sessão. Os aplicativos que precisam desabilitar completamente a telemetria do SDK do ASA podem usar essa API antes de chamar CloudSpatialAnchorSession::Start, o que resultaria em nenhum evento de telemetria sendo enviado para essa instância cloudSpatialAnchorSession.

@property BOOL telemetryEnabled;

locationProvider

Provedor de localização usado para criar e localizar âncoras usando a Relocalização Grosseira.

@property (retain) ASAPlatformLocationProvider * locationProvider;

sessionID

O identificador exclusivo da sessão.

@property (retain, readonly) NSString * sessionId;