Bagikan melalui

Kelas ASACloudSpatialAnchorSession

  • Artikel

Deklarasi

@interface ASACloudSpatialAnchorSession : NSObject;

Deskripsi

Gunakan kelas ini untuk membuat, menemukan, dan mengelola jangkar spasial.

Metode

init

Menginisialisasi instans baru dengan konfigurasi default.

-(instancetype)init;

Membuang

Menghentikan sesi ini dan merilis semua sumber daya terkait.

-(void)dispose;

getAccessTokenWithAuthenticationToken

Mendapatkan token akses Azure Spatial Anchors dari token autentikasi.

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

Parameter

  • authenticationToken - Token autentikasi.
  • completionHandler - String token akses.

Mengembalikan

  • void

getAccessTokenWithAccountKey

Mendapatkan token akses Azure Spatial Anchors dari kunci akun.

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

Parameter

  • accountKey - Kunci akun.
  • completionHandler - String token akses.

Mengembalikan

  • void

createAnchor

Membuat jangkar spasial baru yang bertahan dari jangkar lokal dan properti string yang ditentukan.

Jangkar lokal yang diteruskan ke metode ini harus memiliki transformasi yang valid. Perhatikan beberapa platform yang didukung oleh Azure Spatial Anchors seperti iOS memungkinkan transformasi dengan komponen skala != 1.0. Azure Spatial Anchors SDK tidak mendukung transformasi tersebut dan akan gagal membuat jangkar spasial dengan kode kesalahan InvalidAnchorTransformRigidity. Setiap penanganan skala untuk jangkar harus dilakukan di tingkat aplikasi.

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

Parameter

  • anchor - Jangkar yang harus dipertahankan.
  • completionHandler - Tugas yang mewakili operasi pembuatan asinkron.

Mengembalikan

  • void

createWatcher

Membuat objek baru yang mengawasi jangkar yang memenuhi kriteria yang ditentukan.

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

Parameter

  • criteria - Kriteria jangkar untuk diawasi.

Mengembalikan

  • ASACloudSpatialAnchorWatcher * - Objek pengamat baru yang terus mencari jangkar sampai kriteria sepenuhnya terpenuhi atau pengamat dihentikan. Hanya ada satu pengamat aktif pada satu waktu.

getAnchorProperties

Mendapatkan jangkar spasial cloud untuk pengidentifikasi yang diberikan, meskipun belum ditemukan.

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

Parameter

  • identifier - Pengidentifikasi yang harus dicari.
  • completionHandler - Tugas yang mewakili operasi pengambilan asinkron. Jangkar yang diambil akan memiliki nilai properti tetapi mungkin tidak memiliki jangkar lokal yang tersedia.

Mengembalikan

  • void

getNearbyAnchorIds

Mendapatkan daftar semua id jangkar spasial cloud terdekat yang sesuai dengan kriteria tertentu.

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

Parameter

  • criteria - Kriteria pencarian.
  • completionHandler - Tugas yang mewakili operasi pengambilan asinkron.

Mengembalikan

  • void

getActiveWatchers

Mendapatkan daftar pengamat aktif.

-(NSArray<ASACloudSpatialAnchorWatcher *> *)getActiveWatchers;

Mengembalikan

  • NSArray<ASACloudSpatialAnchorWatcher *> * - Daftar pengamat aktif.

refreshAnchorProperties

Menyegarkan properti untuk jangkar spasial yang ditentukan.

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

Parameter

  • anchor - Jangkar untuk menyegarkan.
  • completionHandler - Tugas yang mewakili operasi refresh asinkron.

Mengembalikan

  • void

updateAnchorProperties

Updates jangkar spasial yang ditentukan.

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

Parameter

  • anchor - Jangkar yang akan diperbarui.
  • completionHandler - Tugas yang mewakili operasi pembaruan asinkron.

Mengembalikan

  • void

deleteAnchor

Menghapus jangkar spasial yang bertahan.

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

Parameter

  • anchor - Jangkar yang akan dihapus.
  • completionHandler - Tugas yang mewakili operasi penghapusan asinkron.

Mengembalikan

  • void

processFrame

Aplikasi harus memanggil metode ini pada platform di mana pemrosesan per bingkai diperlukan.

Metode ini tidak tersedia di platform HoloLens.

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

Parameter

  • frame - Bingkai AR untuk diproses.

getSessionStatus

Mendapatkan objek yang menjelaskan status sesi.

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

Parameter

  • completionHandler - Tugas yang mewakili pengambilan status sesi.

Mengembalikan

  • void

mulai

Mulai menangkap data lingkungan untuk sesi tersebut.

-(void)start;

stop

Berhenti menangkap data lingkungan untuk sesi dan membatalkan operasi penemuan yang luar biasa. Data lingkungan dipertahankan.

-(void)stop;

mengatur ulang

Mengatur ulang data lingkungan yang telah diambil dalam sesi ini; aplikasi harus memanggil metode ini saat pelacakan hilang.

Pada platform apa pun, memanggil metode akan membersihkan semua status cache internal.

-(void)reset;

Properti

delegasi

Objek yang Anda berikan untuk menerima peristiwa dari instans ASACloudSpatialAnchorSession ini.

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

konfigurasi

Informasi konfigurasi untuk sesi.

Pengaturan konfigurasi berlaku saat sesi dimulai.

@property (retain, readonly) ASASessionConfiguration * configuration;

diagnostik

Pengaturan diagnostik untuk sesi, yang dapat digunakan untuk mengumpulkan dan mengirimkan data untuk pemecahan masalah dan penyempurnaan.

@property (retain, readonly) ASACloudSpatialAnchorSessionDiagnostics * diagnostics;

logLevel

Tingkat pengelogan untuk peristiwa log sesi.

@property ASASessionLogLevel logLevel;

sesi

Sesi pelacakan yang digunakan untuk membantu menemukan jangkar.

Properti ini tidak tersedia di platform HoloLens.

@property (retain) ARSession * session;

telemetryEnabled

API ini dapat digunakan untuk mengaktifkan atau menonaktifkan telemetri Azure Spatial Anchors SDK. Telemetri ASA SDK diaktifkan secara default. Jika dinonaktifkan, ASA SDK tidak akan mencatat peristiwa telemetri apa pun untuk sesi ini. Aplikasi yang perlu menonaktifkan telemetri ASA SDK sepenuhnya dapat menggunakan API ini sebelum memanggil CloudSpatialAnchorSession::Start, yang akan mengakibatkan tidak ada peristiwa telemetri yang dikirim untuk instans CloudSpatialAnchorSession tersebut.

@property BOOL telemetryEnabled;

locationProvider

Penyedia lokasi yang digunakan untuk membuat dan menemukan jangkar menggunakan Relokasi Kasar.

@property (retain) ASAPlatformLocationProvider * locationProvider;

sessionId

Pengidentifikasi unik untuk sesi tersebut.

@property (retain, readonly) NSString * sessionId;