Partager via

Classe ASACloudSpatialAnchorSession

  • Article

Déclaration

@interface ASACloudSpatialAnchorSession : NSObject;

Description

Utilisez cette classe pour créer, localiser et gérer des ancres spatiales.

Méthodes

init

Initialise une nouvelle instance avec une configuration par défaut.

-(instancetype)init;

Disposer

Arrête cette session et libère toutes les ressources associées.

-(void)dispose;

getAccessTokenWithAuthenticationToken

Obtient le jeton d’accès Azure Spatial Anchors à partir du jeton d’authentification.

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

Paramètres

  • authenticationToken - Jeton d’authentification.
  • completionHandler - Chaîne de jeton d’accès.

Retours

  • void

getAccessTokenWithAccountKey

Obtient le jeton d’accès Azure Spatial Anchors à partir de la clé de compte.

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

Paramètres

  • accountKey - Clé de compte.
  • completionHandler - Chaîne de jeton d’accès.

Retours

  • void

createAnchor

Crée une ancre spatiale persistante à partir des propriétés d’ancre et de chaîne locales spécifiées.

L’ancre locale passée dans cette méthode doit avoir une transformation valide. Notez que certaines plateformes prises en charge par Azure Spatial Anchors, comme iOS, autorisent les transformations avec le composant d’échelle != 1.0. Le Kit de développement logiciel (SDK) Azure Spatial Anchors ne prend pas en charge ces transformations et ne parvient pas à créer l’ancre spatiale avec le code d’erreur InvalidAnchorTransformRigidity. Toute gestion de la mise à l’échelle pour les ancres doit être effectuée au niveau de l’application.

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

Paramètres

  • anchor - Ancre à conserver.
  • completionHandler - Tâche qui représente l’opération de création asynchrone.

Retours

  • void

createWatcher

Crée un objet qui surveille les ancres qui répondent aux critères spécifiés.

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

Paramètres

  • criteria - Critères pour les ancres à surveiller.

Retours

  • ASACloudSpatialAnchorWatcher * - Nouvel objet observateur qui recherche continuellement des ancres jusqu’à ce que les critères sont entièrement satisfaits ou que l’observateur soit arrêté. Il ne peut y avoir qu’un seul observateur actif à la fois.

getAnchorProperties

Obtient une ancre spatiale cloud pour l’identificateur donné, même si elle n’a pas encore été localisée.

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

Paramètres

  • identifier - Identificateur à rechercher.
  • completionHandler - Tâche qui représente l’opération de récupération asynchrone. L’ancre récupérée aura des valeurs de propriété, mais n’aura peut-être pas d’ancre locale disponible.

Retours

  • void

getNearbyAnchorIds

Obtient une liste de tous les ID d’ancre spatiale cloud à proximité correspondant à un critère donné.

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

Paramètres

  • criteria - Critères de recherche.
  • completionHandler - Tâche qui représente l’opération de récupération asynchrone.

Retours

  • void

getActiveWatchers

Obtient la liste des observateurs actifs.

-(NSArray<ASACloudSpatialAnchorWatcher *> *)getActiveWatchers;

Retours

  • NSArray<ASACloudSpatialAnchorWatcher *> * - Liste des observateurs actifs.

refreshAnchorProperties

Actualise les propriétés de l’ancre spatiale spécifiée.

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

Paramètres

  • anchor - Ancre à actualiser.
  • completionHandler - Tâche qui représente l’opération d’actualisation asynchrone.

Retours

  • void

updateAnchorProperties

Mises à jour l’ancre spatiale spécifiée.

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

Paramètres

  • anchor - Ancre à mettre à jour.
  • completionHandler - Tâche qui représente l’opération de mise à jour asynchrone.

Retours

  • void

deleteAnchor

Supprime une ancre spatiale persistante.

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

Paramètres

  • anchor - Ancre à supprimer.
  • completionHandler - Tâche qui représente l’opération de suppression asynchrone.

Retours

  • void

processFrame

Les applications doivent appeler cette méthode sur les plateformes où le traitement par image est requis.

Cette méthode n’est pas disponible sur la plateforme HoloLens.

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

Paramètres

  • frame - Trame AR à traiter.

getSessionStatus

Obtient un objet décrivant l’état de la session.

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

Paramètres

  • completionHandler - Tâche qui représente la récupération de l’état de la session.

Retours

  • void

start

Commence la capture des données d’environnement pour la session.

-(void)start;

stop

Arrête la capture des données d’environnement pour la session et annule toutes les opérations de localisation en attente. Les données d’environnement sont conservées.

-(void)stop;

reset

Réinitialise les données d’environnement qui ont été capturées dans cette session ; les applications doivent appeler cette méthode lorsque le suivi est perdu.

Sur n’importe quelle plateforme, l’appel de la méthode nettoie tout l’état interne mis en cache.

-(void)reset;

Propriétés

délégué

Objet que vous fournissez pour recevoir des événements de cette instance ASACloudSpatialAnchorSession.

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

configuration

Informations de configuration pour la session.

Les paramètres de configuration prennent effet au démarrage de la session.

@property (retain, readonly) ASASessionConfiguration * configuration;

diagnostics

Paramètres de diagnostic de la session, qui peuvent être utilisés pour collecter et envoyer des données à des fins de résolution des problèmes et d’améliorations.

@property (retain, readonly) ASACloudSpatialAnchorSessionDiagnostics * diagnostics;

logLevel

Niveau de journalisation pour les événements du journal de session.

@property ASASessionLogLevel logLevel;

session

Session de suivi utilisée pour aider à localiser les ancres.

Cette propriété n’est pas disponible sur la plateforme HoloLens.

@property (retain) ARSession * session;

telemetryEnabled

Cette API peut être utilisée pour activer ou désactiver les données de télémétrie du Kit de développement logiciel (SDK) Azure Spatial Anchors. La télémétrie du SDK ASA est activée par défaut. S’il est désactivé, le Kit de développement logiciel (SDK) ASA ne journalisera aucun événement de télémétrie pour cette session. Les applications qui doivent désactiver complètement la télémétrie du SDK ASA peuvent utiliser cette API avant d’appeler CloudSpatialAnchorSession::Start, ce qui entraînerait l’envoi d’aucun événement de télémétrie pour cette instance CloudSpatialAnchorSession.

@property BOOL telemetryEnabled;

locationProvider

Fournisseur d’emplacement utilisé pour créer et localiser des ancres à l’aide de la relocalisation grossière.

@property (retain) ASAPlatformLocationProvider * locationProvider;

sessionID

Identificateur unique de la session.

@property (retain, readonly) NSString * sessionId;