Поделиться через

Класс ASACloudSpatialAnchorSession

  • Статья

Объявление

@interface ASACloudSpatialAnchorSession : NSObject;

Описание

Используйте этот класс для создания пространственных привязок, поиска и управления ими.

Методы

init

Инициализирует новый экземпляр с конфигурацией по умолчанию.

-(instancetype)init;

Распоряжаться

Останавливает этот сеанс и освобождает все связанные ресурсы.

-(void)dispose;

getAccessTokenWithAuthenticationToken

Получает маркер доступа пространственных привязок Azure из маркера проверки подлинности.

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

Параметры

  • authenticationToken — маркер проверки подлинности.
  • completionHandler — строка маркера доступа.

Возвращаемое значение

  • void

getAccessTokenWithAccountKey

Получает маркер доступа Пространственных привязок Azure из ключа учетной записи.

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

Параметры

  • accountKey — Ключ учетной записи.
  • completionHandler — строка маркера доступа.

Возвращаемое значение

  • void

createAnchor

Создает новую сохраненную пространственную привязку на основе указанных свойств локальной привязки и строки.

Локальная привязка, передаваемая в этот метод, должна иметь допустимое преобразование. Обратите внимание, что некоторые платформы, поддерживаемые пространственными привязками Azure, например iOS, позволяют выполнять преобразования с помощью компонента масштабирования != 1.0. Пакет SDK для пространственных привязок Azure не поддерживает такие преобразования и не сможет создать пространственную привязку с кодом ошибки InvalidAnchorTransformRigidity. Любая обработка масштабирования привязок должна выполняться на уровне приложения.

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

Параметры

  • anchor — привязка, сохраняемая.
  • completionHandler — задача, представляющая асинхронную операцию создания.

Возвращаемое значение

  • void

CreateWatcher

Создает новый объект , который отслеживает привязки, соответствующие заданным критериям.

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

Параметры

  • criteria — Критерии для привязок, за которыми следует следить.

Возвращаемое значение

  • ASACloudSpatialAnchorWatcher * — новый объект наблюдателя, который постоянно ищет привязки до тех пор, пока критерии не будут полностью удовлетворены или наблюдатель не остановлен. Одновременно может быть только один активный наблюдатель.

getAnchorProperties

Возвращает облачную пространственную привязку для заданного идентификатора, даже если он еще не найден.

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

Параметры

  • identifier — идентификатор для поиска.
  • completionHandler — задача, представляющая асинхронную операцию извлечения. Полученная привязка будет иметь значения свойств, но может не иметь доступной локальной привязки.

Возвращаемое значение

  • void

getNearbyAnchorIds

Возвращает список всех идентификаторов пространственных привязок, расположенных поблизости от облака, соответствующих заданным критериям.

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

Параметры

  • criteria — Критерии поиска.
  • completionHandler — задача, представляющая асинхронную операцию извлечения.

Возвращаемое значение

  • void

getActiveWatchers

Возвращает список активных наблюдателей.

-(NSArray<ASACloudSpatialAnchorWatcher *> *)getActiveWatchers;

Возвращаемое значение

  • NSArray<ASACloudSpatialAnchorWatcher *> * - Список активных наблюдателей.

refreshAnchorProperties

Обновляет свойства указанной пространственной привязки.

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

Параметры

  • anchor — привязка для обновления.
  • completionHandler — задача, представляющая асинхронную операцию обновления.

Возвращаемое значение

  • void

updateAnchorProperties

Обновления указанной пространственной привязки.

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

Параметры

  • anchor — обновляемая привязка.
  • completionHandler — задача, представляющая асинхронную операцию обновления.

Возвращаемое значение

  • void

deleteAnchor

Удаляет сохраненную пространственную привязку.

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

Параметры

  • anchor — удаляемая привязка.
  • completionHandler — задача, представляющая асинхронную операцию удаления.

Возвращаемое значение

  • void

processFrame

Приложения должны вызывать этот метод на платформах, где требуется обработка по кадрам.

Этот метод недоступен на платформе HoloLens.

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

Параметры

  • frame — кадр ar для обработки.

getSessionStatus

Возвращает объект , описывающий состояние сеанса.

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

Параметры

  • completionHandler — задача, представляющая получение состояния сеанса.

Возвращаемое значение

  • void

start

Начинает сбор данных среды для сеанса.

-(void)start;

stop

Прекращает сбор данных среды для сеанса и отменяет все невыполненные операции обнаружения. Данные среды поддерживаются.

-(void)stop;

сброс

Сбрасывает данные среды, которые были записаны в этом сеансе; приложения должны вызывать этот метод при потере отслеживания.

На любой платформе вызов метода очистит все внутреннее кэшированное состояние.

-(void)reset;

Свойства

delegate

Объект, предоставляемый для получения событий из этого экземпляра ASACloudSpatialAnchorSession.

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

настройка

Сведения о конфигурации для сеанса.

Параметры конфигурации вступают в силу при запуске сеанса.

@property (retain, readonly) ASASessionConfiguration * configuration;

диагностика

Параметры диагностики для сеанса, которые можно использовать для сбора и отправки данных для устранения неполадок и улучшения.

@property (retain, readonly) ASACloudSpatialAnchorSessionDiagnostics * diagnostics;

LogLevel

Уровень ведения журнала для событий журнала сеансов.

@property ASASessionLogLevel logLevel;

сессия

Сеанс отслеживания, используемый для поиска привязок.

Это свойство недоступно на платформе HoloLens.

@property (retain) ARSession * session;

telemetryEnabled

Этот API можно использовать для включения или отключения телеметрии пакета SDK для пространственных привязок Azure. Телеметрия пакета SDK ASA включена по умолчанию. Если этот параметр отключен, пакет SDK ASA не будет записывать в журнал события телеметрии для этого сеанса. Приложения, которым необходимо полностью отключить телеметрию пакета SDK ASA, могут использовать этот API перед вызовом CloudSpatialAnchorSession::Start, что приведет к тому, что для этого экземпляра CloudSpatialAnchorSession не будут отправляться события телеметрии.

@property BOOL telemetryEnabled;

locationProvider

Поставщик расположения, используемый для создания и поиска привязок с помощью грубой повторной локализации.

@property (retain) ASAPlatformLocationProvider * locationProvider;

sessionID

Уникальный идентификатор сеанса.

@property (retain, readonly) NSString * sessionId;