Clase ASACloudSpatialAnchorSession

  • Artículo

Declaración

@interface ASACloudSpatialAnchorSession : NSObject;

Descripción

Use esta clase para crear, localizar y administrar anclajes espaciales.

Métodos

init

Inicializa una nueva instancia con una configuración predeterminada.

-(instancetype)init;

Disponer

Detiene esta sesión y libera todos los recursos asociados.

-(void)dispose;

getAccessTokenWithAuthenticationToken

Obtiene el token de acceso de Azure Spatial Anchors del token de autenticación.

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

Parámetros

  • authenticationToken - Token de autenticación.
  • completionHandler : la cadena del token de acceso.

Devoluciones

  • void

getAccessTokenWithAccountKey

Obtiene el token de acceso de Azure Spatial Anchors de la clave de cuenta.

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

Parámetros

  • accountKey - Clave de cuenta.
  • completionHandler : la cadena del token de acceso.

Devoluciones

  • void

createAnchor

Crea un nuevo delimitador espacial persistente a partir del delimitador local y las propiedades de cadena especificados.

El delimitador local pasado a este método debe tener una transformación válida. Tenga en cuenta que algunas plataformas compatibles con Azure Spatial Anchors, como iOS, permiten transformaciones con el componente de escalado != 1.0. El SDK de Azure Spatial Anchors no admite estas transformaciones y no podrá crear el delimitador espacial con el código de error InvalidAnchorTransformRigidity. Cualquier control de escala para los delimitadores debe realizarse en el nivel de aplicación.

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

Parámetros

  • anchor : delimitador que se va a conservar.
  • completionHandler - Tarea que representa la operación de creación asincrónica.

Devoluciones

  • void

createWatcher

Crea un nuevo objeto que busca anclajes que cumplan los criterios especificados.

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

Parámetros

  • criteria - Criterios para los anclajes que se van a observar.

Devoluciones

  • ASACloudSpatialAnchorWatcher * - Un nuevo objeto de monitor que busca continuamente anclajes hasta que los criterios se cumplan completamente o se detenga el monitor. Solo puede haber un monitor activo a la vez.

getAnchorProperties

Obtiene un delimitador espacial en la nube para el identificador especificado, incluso si aún no se ha localizado.

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

Parámetros

  • identifier : identificador que se va a buscar.
  • completionHandler - Tarea que representa la operación de recuperación asincrónica. El delimitador recuperado tendrá valores de propiedad, pero es posible que no tenga disponible un delimitador local.

Devoluciones

  • void

getNearbyAnchorIds

Obtiene una lista de todos los identificadores de anclaje espacial en la nube cercanos correspondientes a un criterio determinado.

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

Parámetros

  • criteria - Los criterios de búsqueda.
  • completionHandler - Tarea que representa la operación de recuperación asincrónica.

Devoluciones

  • void

getActiveWatchers

Obtiene una lista de monitores activos.

-(NSArray<ASACloudSpatialAnchorWatcher *> *)getActiveWatchers;

Devoluciones

  • NSArray<ASACloudSpatialAnchorWatcher *> * - Una lista de monitores activos.

refreshAnchorProperties

Actualiza las propiedades del delimitador espacial especificado.

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

Parámetros

  • anchor : el delimitador que se va a actualizar.
  • completionHandler - Tarea que representa la operación de actualización asincrónica.

Devoluciones

  • void

updateAnchorProperties

Novedades el delimitador espacial especificado.

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

Parámetros

  • anchor : el delimitador que se va a actualizar.
  • completionHandler - Tarea que representa la operación de actualización asincrónica.

Devoluciones

  • void

deleteAnchor

Elimina un delimitador espacial persistente.

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

Parámetros

  • anchor : el delimitador que se va a eliminar.
  • completionHandler - Tarea que representa la operación de eliminación asincrónica.

Devoluciones

  • void

processFrame

Las aplicaciones deben llamar a este método en plataformas en las que se requiere el procesamiento por fotograma.

Este método no está disponible en la plataforma HoloLens.

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

Parámetros

  • frame - Marco ar que se va a procesar.

getSessionStatus

Obtiene un objeto que describe el estado de la sesión.

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

Parámetros

  • completionHandler - Tarea que representa la recuperación del estado de sesión.

Devoluciones

  • void

start

Comienza a capturar datos de entorno para la sesión.

-(void)start;

stop

Detiene la captura de datos del entorno para la sesión y cancela las operaciones de localización pendientes. Se mantienen los datos del entorno.

-(void)stop;

reset

Restablece los datos de entorno capturados en esta sesión; Las aplicaciones deben llamar a este método cuando se pierde el seguimiento.

En cualquier plataforma, al llamar al método se limpiará todo el estado almacenado en caché interno.

-(void)reset;

Propiedades

delegado

Objeto que se proporciona para recibir eventos de esta instancia de ASACloudSpatialAnchorSession.

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

configuración

Información de configuración de la sesión.

Las opciones de configuración surten efecto cuando se inicia la sesión.

@property (retain, readonly) ASASessionConfiguration * configuration;

diagnóstico

La configuración de diagnóstico de la sesión, que se puede usar para recopilar y enviar datos para solucionar problemas y mejoras.

@property (retain, readonly) ASACloudSpatialAnchorSessionDiagnostics * diagnostics;

logLevel

Nivel de registro para los eventos de registro de sesión.

@property ASASessionLogLevel logLevel;

hora de sesión

La sesión de seguimiento que se usa para ayudar a localizar anclajes.

Esta propiedad no está disponible en la plataforma HoloLens.

@property (retain) ARSession * session;

telemetryEnabled

Esta API se puede usar para habilitar o deshabilitar la telemetría del SDK de Azure Spatial Anchors. La telemetría del SDK de ASA está habilitada de forma predeterminada. Si está deshabilitado, el SDK de ASA no registrará ningún evento de telemetría para esta sesión. Las aplicaciones que necesitan deshabilitar completamente la telemetría del SDK de ASA pueden usar esta API antes de llamar a CloudSpatialAnchorSession::Start, lo que provocaría que no se envíe ningún evento de telemetría para esa instancia de CloudSpatialAnchorSession.

@property BOOL telemetryEnabled;

locationProvider

Proveedor de ubicación usado para crear y localizar anclajes mediante relocalización general.

@property (retain) ASAPlatformLocationProvider * locationProvider;

sessionID

Identificador único de la sesión.

@property (retain, readonly) NSString * sessionId;