Sdílet prostřednictvím

Třída ASACloudSpatialAnchorSession

  • Článek

Deklarace

@interface ASACloudSpatialAnchorSession : NSObject;

Description

Pomocí této třídy můžete vytvářet, vyhledávat a spravovat prostorové kotvy.

Metody

init

Inicializuje novou instanci s výchozí konfigurací.

-(instancetype)init;

Dispose

Zastaví tuto relaci a uvolní všechny přidružené prostředky.

-(void)dispose;

getAccessTokenWithAuthenticationToken

Získá přístupový token Azure Spatial Anchors z ověřovacího tokenu.

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

Parametry

  • authenticationToken – Ověřovací token.
  • completionHandler – Řetězec přístupového tokenu.

Návraty

  • void

getAccessTokenWithAccountKey

Získá přístupový token Azure Spatial Anchors z klíče účtu.

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

Parametry

  • accountKey - Klíč účtu.
  • completionHandler – Řetězec přístupového tokenu.

Návraty

  • void

createAnchor

Vytvoří nové trvalé prostorové ukotvení ze zadaných místních ukotvení a vlastností řetězce.

Místní ukotvení předané do této metody musí mít platnou transformaci. Všimněte si, že některé platformy podporované službou Azure Spatial Anchors, jako je iOS, umožňují transformace se škálovací komponentou != 1.0. Sada Azure Spatial Anchors SDK takové transformace nepodporuje a vytvoření prostorového ukotvení se nezdaří s kódem chyby InvalidAnchorTransformRigidity. Veškeré zpracování škálování ukotvení se musí provádět na úrovni aplikace.

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

Parametry

  • anchor - Kotva se má zachovat.
  • completionHandler – Úloha, která představuje operaci asynchronního vytváření.

Návraty

  • void

createWatcher

Vytvoří nový objekt, který sleduje ukotvení, která splňují zadaná kritéria.

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

Parametry

  • criteria - Kritéria pro kotvy, na které je třeba dávat pozor.

Návraty

  • ASACloudSpatialAnchorWatcher * – Nový objekt sledovacího procesu, který nepřetržitě hledá kotvy, dokud není plně splněna kritéria nebo sledovací proces není zastaven. V jednu chvíli může být aktivní sledovací proces pouze jeden.

getAnchorProperties

Získá prostorové ukotvení cloudu pro daný identifikátor, i když ještě nebyl umístěn.

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

Parametry

  • identifier - Identifikátor, který se má hledat.
  • completionHandler – Úloha, která představuje operaci asynchronního načítání. Načtené ukotvení bude mít hodnoty vlastností, ale nemusí mít k dispozici místní ukotvení.

Návraty

  • void

getNearbyAnchorIds

Získá seznam všech ID prostorového ukotvení blízkého cloudu odpovídajících zadaným kritériím.

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

Parametry

  • criteria - Kritéria hledání.
  • completionHandler – Úloha, která představuje operaci asynchronního načítání.

Návraty

  • void

getActiveWatchers

Získá seznam aktivních sledovacích procesů.

-(NSArray<ASACloudSpatialAnchorWatcher *> *)getActiveWatchers;

Návraty

  • NSArray<ASACloudSpatialAnchorWatcher *> * - Seznam aktivních sledujících.

refreshAnchorVlastnosti

Aktualizuje vlastnosti zadaného prostorového ukotvení.

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

Parametry

  • anchor - Kotva, která se má aktualizovat.
  • completionHandler – Úloha, která představuje operaci asynchronní aktualizace.

Návraty

  • void

updateAnchorVlastnosti

Aktualizace zadané prostorové ukotvení.

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

Parametry

  • anchor - Kotva, která se má aktualizovat.
  • completionHandler – Úloha, která představuje asynchronní operaci aktualizace.

Návraty

  • void

deleteAnchor

Odstraní trvalé prostorové ukotvení.

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

Parametry

  • anchor - Kotva, která se má odstranit.
  • completionHandler – Úloha, která představuje asynchronní operaci odstranění.

Návraty

  • void

processFrame

Aplikace musí tuto metodu volat na platformách, kde se vyžaduje zpracování jednotlivých snímků.

Tato metoda není k dispozici na platformě HoloLens.

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

Parametry

  • frame - Rámec AR ke zpracování.

getSessionStatus

Získá objekt popisující stav relace.

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

Parametry

  • completionHandler – Úloha, která představuje načtení stavu relace.

Návraty

  • void

start

Začne zaznamenávat data prostředí pro relaci.

-(void)start;

Zastavit

Zastaví zachytávání dat prostředí pro relaci a zruší všechny nevyřešené operace hledání. Data prostředí se uchovávají.

-(void)stop;

resetování

Resetuje data prostředí, která byla zaznamenána v této relaci; aplikace musí tuto metodu volat při ztrátě sledování.

Volání metody na libovolné platformě vyčistí veškerý interní stav v mezipaměti.

-(void)reset;

Vlastnosti

delegát

Objekt, který poskytnete pro příjem událostí z této instance ASACloudSpatialAnchorSession.

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

konfigurace

Informace o konfiguraci relace.

Nastavení konfigurace se projeví po spuštění relace.

@property (retain, readonly) ASASessionConfiguration * configuration;

Diagnostika

Nastavení diagnostiky pro relaci, která se dají použít ke shromažďování a odesílání dat pro účely řešení potíží a vylepšení.

@property (retain, readonly) ASACloudSpatialAnchorSessionDiagnostics * diagnostics;

Loglevel

Úroveň protokolování událostí protokolu relací

@property ASASessionLogLevel logLevel;

relace

Relace sledování, která pomáhá najít kotvy.

Tato vlastnost není k dispozici na platformě HoloLens.

@property (retain) ARSession * session;

telemetryEnabled

Toto rozhraní API je možné použít k povolení nebo zakázání telemetrie sady Azure Spatial Anchors SDK. Telemetrie sady ASA SDK je ve výchozím nastavení povolená. Pokud je tato možnost zakázaná, sada ASA SDK nebude pro tuto relaci protokolovat žádnou událost telemetrie. Aplikace, které potřebují úplně zakázat telemetrii sady ASA SDK, můžou toto rozhraní API použít před voláním CloudSpatialAnchorSession::Start, což by vedlo k odesílání žádné telemetrické události pro tuto instanci CloudSpatialAnchorSession.

@property BOOL telemetryEnabled;

locationProvider

Zprostředkovatel umístění používaný k vytvoření a vyhledání ukotvení pomocí hrubého přemísťování

@property (retain) ASAPlatformLocationProvider * locationProvider;

Sessionid

Jedinečný identifikátor relace.

@property (retain, readonly) NSString * sessionId;