Dela via

Klass ASACloudSpatialAnchorSession

  • Artikel

Förklaring

@interface ASACloudSpatialAnchorSession : NSObject;

Description

Använd den här klassen för att skapa, hitta och hantera spatiala fästpunkter.

Metoder

init

Initierar en ny instans med en standardkonfiguration.

-(instancetype)init;

ta bort

Stoppar den här sessionen och släpper alla associerade resurser.

-(void)dispose;

getAccessTokenWithAuthenticationToken

Hämtar Åtkomsttoken för Azure Spatial Anchors från autentiseringstoken.

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

Parametrar

  • authenticationToken – Autentiseringstoken.
  • completionHandler – Åtkomsttokensträngen.

Returer

  • void

getAccessTokenWithAccountKey

Hämtar Åtkomsttoken för Azure Spatial Anchors från kontonyckeln.

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

Parametrar

  • accountKey - Kontonyckel.
  • completionHandler – Åtkomsttokensträngen.

Returer

  • void

createAnchor

Skapar en ny beständig spatial fästpunkt från de angivna lokala fästpunkts- och strängegenskaperna.

Den lokala fästpunkten som skickas till den här metoden måste ha en giltig transformering. Observera att vissa plattformar som stöds av Azure Spatial Anchors, till exempel iOS, tillåter transformeringar med skalningskomponenten != 1.0. Azure Spatial Anchors SDK stöder inte sådana transformeringar och det går inte att skapa den rumsliga fästpunkten med felkoden InvalidAnchorTransformRigidity. All skalningshantering för fästpunkter måste göras på appnivå.

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

Parametrar

  • anchor - Fästpunkt som ska bevaras.
  • completionHandler – En uppgift som representerar den asynkrona skapandeåtgärden.

Returer

  • void

createWatcher

Skapar ett nytt objekt som söker efter fästpunkter som uppfyller de angivna kriterierna.

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

Parametrar

  • criteria - Kriterier för ankare att hålla utkik efter.

Returer

  • ASACloudSpatialAnchorWatcher * - Ett nytt bevakarobjekt som kontinuerligt söker efter fästpunkter tills kriterierna är helt uppfyllda eller bevakaren stoppas. Det kan bara finnas en aktiv bevakare i taget.

getAnchorProperties

Hämtar en molnbaserad fästpunkt för den angivna identifieraren, även om den inte har hittats ännu.

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

Parametrar

  • identifier – Identifieraren som ska sökas efter.
  • completionHandler – En uppgift som representerar den asynkrona hämtningsåtgärden. Fästpunkten som hämtas har egenskapsvärden men kanske inte har någon lokal fästpunkt tillgänglig.

Returer

  • void

getNearbyAnchorIds

Hämtar en lista över alla rumsliga molnankar-ID:ar som motsvarar ett visst villkor.

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

Parametrar

  • criteria - Sökvillkoren.
  • completionHandler – En uppgift som representerar den asynkrona hämtningsåtgärden.

Returer

  • void

getActiveWatchers

Hämtar en lista över aktiva tittare.

-(NSArray<ASACloudSpatialAnchorWatcher *> *)getActiveWatchers;

Returer

  • NSArray<ASACloudSpatialAnchorWatcher *> * - En lista över aktiva tittare.

refreshAnchorProperties

Uppdaterar egenskaper för den angivna spatiala fästpunkten.

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

Parametrar

  • anchor - Ankaret som ska uppdateras.
  • completionHandler – En uppgift som representerar den asynkrona uppdateringsåtgärden.

Returer

  • void

updateAnchorProperties

Uppdateringar den angivna rumsliga fästpunkten.

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

Parametrar

  • anchor - Ankaret som ska uppdateras.
  • completionHandler – En uppgift som representerar den asynkrona uppdateringsåtgärden.

Returer

  • void

deleteAnchor

Tar bort en bestående spatial fästpunkt.

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

Parametrar

  • anchor – Fästpunkten som ska tas bort.
  • completionHandler – En uppgift som representerar den asynkrona borttagningsåtgärden.

Returer

  • void

processFrame

Program måste anropa den här metoden på plattformar där bearbetning per bildruta krävs.

Den här metoden är inte tillgänglig på HoloLens-plattformen.

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

Parametrar

  • frame - AR ram att bearbeta.

getSessionStatus

Hämtar ett objekt som beskriver status för sessionen.

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

Parametrar

  • completionHandler – En uppgift som representerar sessionsstatushämtningen.

Returer

  • void

start

Börjar samla in miljödata för sessionen.

-(void)start;

stoppa

Stoppar insamlingen av miljödata för sessionen och avbryter eventuella utestående åtgärder för att hitta. Miljödata underhålls.

-(void)stop;

reset

Återställer miljödata som har avbildats i den här sessionen. program måste anropa den här metoden när spårning går förlorad.

Om du anropar metoden på valfri plattform rensas allt internt cachelagrat tillstånd.

-(void)reset;

Egenskaper

Delegera

Ett objekt som du anger för att ta emot händelser från den här ASACloudSpatialAnchorSession-instansen.

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

konfiguration

Konfigurationsinformationen för sessionen.

Konfigurationsinställningarna börjar gälla när sessionen startas.

@property (retain, readonly) ASASessionConfiguration * configuration;

diagnostik

Diagnostikinställningarna för sessionen, som kan användas för att samla in och skicka data för felsökning och förbättringar.

@property (retain, readonly) ASACloudSpatialAnchorSessionDiagnostics * diagnostics;

logLevel

Loggningsnivå för sessionslogghändelserna.

@property ASASessionLogLevel logLevel;

session

Spårningssessionen som används för att hitta fästpunkter.

Den här egenskapen är inte tillgänglig på HoloLens-plattformen.

@property (retain) ARSession * session;

telemetryEnabled

Det här API:et kan användas för att aktivera eller inaktivera Azure Spatial Anchors SDK-telemetri. ASA SDK-telemetri är aktiverat som standard. Om det är inaktiverat loggar ASA SDK inte någon telemetrihändelse för den här sessionen. Program som behöver inaktivera ASA SDK-telemetri helt kan använda detta API innan de anropar CloudSpatialAnchorSession::Start, vilket skulle resultera i att ingen telemetrihändelse skickas för den CloudSpatialAnchorSession-instansen.

@property BOOL telemetryEnabled;

locationProvider

Platsprovider som används för att skapa och hitta fästpunkter med hjälp av grov omlokalisering.

@property (retain) ASAPlatformLocationProvider * locationProvider;

Sessionid

Den unika identifieraren för sessionen.

@property (retain, readonly) NSString * sessionId;