Udostępnij przez

Klasa ASACloudSpatialAnchorSession

  • Artykuł

Deklaracji

@interface ASACloudSpatialAnchorSession : NSObject;

Opis

Ta klasa służy do tworzenia kotwic przestrzennych i zarządzania nimi.

Metody

init

Inicjuje nowe wystąpienie z konfiguracją domyślną.

-(instancetype)init;

Dispose

Zatrzymuje tę sesję i zwalnia wszystkie skojarzone zasoby.

-(void)dispose;

getAccessTokenWithAuthenticationToken

Pobiera token dostępu usługi Azure Spatial Anchors z tokenu uwierzytelniania.

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

Parametry

  • authenticationToken - Token uwierzytelniania.
  • completionHandler - Ciąg tokenu dostępu.

Zwraca

  • void

getAccessTokenWithAccountKey

Pobiera token dostępu usługi Azure Spatial Anchors z klucza konta.

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

Parametry

  • accountKey - Klucz konta.
  • completionHandler - Ciąg tokenu dostępu.

Zwraca

  • void

createAnchor

Tworzy nową utrwalonej kotwicy przestrzennej na podstawie określonych lokalnych właściwości kotwicy i ciągu.

Kotwica lokalna przekazana do tej metody musi mieć prawidłową transformację. Zwróć uwagę na niektóre platformy obsługiwane przez usługę Azure Spatial Anchors, takie jak iOS, umożliwiają transformacje ze składnikiem skalowania != 1.0. Zestaw SDK usługi Azure Spatial Anchors nie obsługuje takich przekształceń i nie będzie można utworzyć kotwicy przestrzennej z kodem błędu InvalidAnchorTransformRigidity. Każda obsługa skalowania kotwic musi być wykonywana na poziomie aplikacji.

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

Parametry

  • anchor — Kotwica do utrwalonego.
  • completionHandler — Zadanie reprezentujące operację tworzenia asynchronicznego.

Zwraca

  • void

createWatcher

Tworzy nowy obiekt, który wyszukuje kotwice spełniające określone kryteria.

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

Parametry

  • criteria - Kryteria dla kotwic do śledzenia.

Zwraca

  • ASACloudSpatialAnchorWatcher * - Nowy obiekt obserwatora, który stale szuka kotwic, dopóki kryteria nie zostanie w pełni spełnione lub obserwator zostanie zatrzymany. W danym momencie może być tylko jeden aktywny obserwator.

getAnchorProperties

Pobiera kotwicę przestrzenną chmury dla danego identyfikatora, nawet jeśli jeszcze go nie ma.

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

Parametry

  • identifier - Identyfikator do wyszukania.
  • completionHandler — Zadanie reprezentujące operację pobierania asynchronicznego. Pobrana kotwica będzie mieć wartości właściwości, ale może nie mieć dostępnej lokalnej kotwicy.

Zwraca

  • void

getNearbyAnchorIds

Pobiera listę wszystkich identyfikatorów kotwicy przestrzennej chmury w pobliżu odpowiadających danym kryteriom.

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

Parametry

  • criteria - Kryteria wyszukiwania.
  • completionHandler — Zadanie reprezentujące operację pobierania asynchronicznego.

Zwraca

  • void

getActiveWatchers

Pobiera listę aktywnych obserwatorów.

-(NSArray<ASACloudSpatialAnchorWatcher *> *)getActiveWatchers;

Zwraca

  • NSArray<ASACloudSpatialAnchorWatcher *> * - Lista aktywnych obserwatorów.

refreshAnchorProperties

Odświeża właściwości określonej kotwicy przestrzennej.

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

Parametry

  • anchor — Kotwica do odświeżenia.
  • completionHandler — Zadanie reprezentujące operację odświeżania asynchronicznego.

Zwraca

  • void

updateAnchorProperties

Aktualizacje określonej kotwicy przestrzennej.

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

Parametry

  • anchor - Kotwica do zaktualizowania.
  • completionHandler — zadanie reprezentujące operację aktualizacji asynchronicznej.

Zwraca

  • void

deleteAnchor

Usuwa utrwalone zakotwiczenie przestrzenne.

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

Parametry

  • anchor - Kotwica do usunięcia.
  • completionHandler — zadanie reprezentujące operację usuwania asynchronicznego.

Zwraca

  • void

processFrame

Aplikacje muszą wywoływać tę metodę na platformach, na których wymagane jest przetwarzanie poszczególnych ramek.

Ta metoda nie jest dostępna na platformie HoloLens.

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

Parametry

  • frame - Ramka AR do przetworzenia.

getSessionStatus

Pobiera obiekt opisujący stan sesji.

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

Parametry

  • completionHandler — Zadanie reprezentujące pobieranie stanu sesji.

Zwraca

  • void

start

Rozpoczyna przechwytywanie danych środowiska dla sesji.

-(void)start;

zatrzymanie

Zatrzymuje przechwytywanie danych środowiska dla sesji i anuluje wszystkie zaległe operacje lokalizowania. Dane środowiska są zachowywane.

-(void)stop;

resetowanie

Resetuje dane środowiska, które zostały przechwycone w tej sesji; aplikacje muszą wywoływać tę metodę, gdy śledzenie zostanie utracone.

Na dowolnej platformie wywołanie metody spowoduje wyczyszczenie całego wewnętrznego stanu pamięci podręcznej.

-(void)reset;

Właściwości

delegate

Obiekt, który udostępniasz w celu odbierania zdarzeń z tego wystąpienia ASACloudSpatialAnchorSession.

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

konfiguracja

Informacje o konfiguracji sesji.

Ustawienia konfiguracji zaczynają obowiązywać po rozpoczęciu sesji.

@property (retain, readonly) ASASessionConfiguration * configuration;

Diagnostyka

Ustawienia diagnostyczne sesji, które mogą służyć do zbierania i przesyłania danych na potrzeby rozwiązywania problemów i ulepszeń.

@property (retain, readonly) ASACloudSpatialAnchorSessionDiagnostics * diagnostics;

Loglevel

Poziom rejestrowania zdarzeń dziennika sesji.

@property ASASessionLogLevel logLevel;

sesja

Sesja śledzenia używana do lokalizowania kotwic.

Ta właściwość nie jest dostępna na platformie HoloLens.

@property (retain) ARSession * session;

telemetriaEnabled

Ten interfejs API może służyć do włączania lub wyłączania telemetrii zestawu SDK usługi Azure Spatial Anchors. Telemetria zestawu ASA SDK jest domyślnie włączona. Jeśli to ustawienie jest wyłączone, zestaw ASA SDK nie będzie rejestrować żadnego zdarzenia telemetrii dla tej sesji. Aplikacje, które muszą całkowicie wyłączyć telemetrię zestawu ASA SDK, mogą używać tego interfejsu API przed wywołaniem klasy CloudSpatialAnchorSession::Start, co spowodowałoby, że dla tego wystąpienia cloudSpatialAnchorSession nie są wysyłane żadne zdarzenie telemetrii.

@property BOOL telemetryEnabled;

locationProvider

Dostawca lokalizacji używany do tworzenia i lokalizowania kotwic przy użyciu kolokalizacji.

@property (retain) ASAPlatformLocationProvider * locationProvider;

Sessionid

Unikatowy identyfikator sesji.

@property (retain, readonly) NSString * sessionId;