CloudSpatialAnchorSession Класс

Пакет:

com.microsoft.azure.spatialanchors

• java.lang.Object
• • java.lang.AutoCloseable
  • • com.microsoft.azure.spatialanchors.CloudSpatialAnchorSession

public class CloudSpatialAnchorSession

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

Сводка по конструктору

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

Сводка по методу

Модификатор и тип	Метод и описание
void	addAnchorLocatedListener(AnchorLocatedListener listener) Добавляет указанный прослушиватель для получения событий AnchorLocated. Происходит при определении расположения привязки.
void	addErrorListener(SessionErrorListener listener) Добавляет указанный прослушиватель для получения событий Error. Происходит, когда сеанс не может продолжить обработку.
void	addLocateAnchorsCompletedListener(LocateAnchorsCompletedListener listener) Добавляет указанный прослушиватель для получения событий LocateAnchorsCompleted. Происходит при обработке всех результатов от наблюдателя, который определяет привязки.
void	addOnLogDebugListener(OnLogDebugListener listener) Добавляет указанный прослушиватель для получения событий OnLogDebug. Происходит при создании сообщения журнала отладки.
void	addSessionUpdatedListener(SessionUpdatedListener listener) Добавляет указанный прослушиватель для получения событий SessionUpdated. Происходит при обновлении всего состояния сеанса.
void	addTokenRequiredListener(TokenRequiredListener listener) Добавляет указанный прослушиватель для получения событий TokenRequired. Происходит, когда сеансу требуется обновленный маркер доступа или маркер проверки подлинности.
void	addUpdatedSensorFingerprintRequiredListener(UpdatedSensorFingerprintRequiredListener listener) Добавляет указанный прослушиватель для получения событий UpdatedSensorFingerprintRequired. Происходит, когда сеанс запрашивает обновленный отпечаток датчика из приложения.
void	close() Закрывает этот ресурс.
Future	createAnchorAsync(final CloudSpatialAnchor anchor) Создает новую сохраненную пространственную привязку на основе указанных свойств локальной привязки и строки. Локальная привязка, передаваемая в этот метод, должна иметь допустимое преобразование. Обратите внимание, что некоторые платформы, поддерживаемые пространственными привязками Azure, например iOS, позволяют выполнять преобразования с помощью компонента масштабирования != 1.0. Пакет SDK для пространственных привязок Azure не поддерживает такие преобразования и не сможет создать пространственную привязку с кодом ошибки InvalidAnchorTransformRigidity. Любая обработка масштабирования привязок должна выполняться на уровне приложения.
CloudSpatialAnchorWatcher	createWatcher(AnchorLocateCriteria criteria) Создает новый объект , который отслеживает привязки, соответствующие заданным критериям.
Future	deleteAnchorAsync(final CloudSpatialAnchor anchor) Удаляет сохраненную пространственную привязку.
void	finalize() Вызывается сборщиком мусора для объекта , когда сборка мусора определяет, что больше нет ссылок на объект .
Future<String>	getAccessTokenWithAccountKeyAsync(final String accountKey) Получает маркер доступа Пространственных привязок Azure из ключа учетной записи.
Future<String>	getAccessTokenWithAuthenticationTokenAsync(final String authenticationToken) Получает маркер доступа пространственных привязок Azure из маркера проверки подлинности.
List<CloudSpatialAnchorWatcher>	getActiveWatchers() Возвращает список активных наблюдателей.
Future<CloudSpatialAnchor>	getAnchorPropertiesAsync(final String identifier) Возвращает облачную пространственную привязку для заданного идентификатора, даже если он еще не найден.
SessionConfiguration	getConfiguration() Возвращает сведения о конфигурации для сеанса. Параметры конфигурации вступают в силу при запуске сеанса.
CloudSpatialAnchorSessionDiagnostics	getDiagnostics() Возвращает параметры диагностики для сеанса, которые можно использовать для сбора и отправки данных для устранения неполадок и улучшения.
PlatformLocationProvider	getLocationProvider() Поставщик расположения, используемый для создания и поиска привязок с помощью [Грубой перелокализации](https://aka.ms/CoarseRelocalization).
SessionLogLevel	getLogLevel() Уровень ведения журнала для событий журнала сеансов.
Future<List<String>>	getNearbyAnchorIdsAsync(final NearDeviceCriteria criteria) Возвращает список всех идентификаторов пространственных привязок, расположенных поблизости от облака, соответствующих заданным критериям.
Session	getSession() Возвращает сеанс отслеживания, используемый для поиска привязок. Это свойство недоступно на платформе HoloLens.
String	getSessionId() Возвращает уникальный идентификатор сеанса.
Future<SessionStatus>	getSessionStatusAsync() Возвращает объект , описывающий состояние сеанса.
boolean	getTelemetryEnabled()
void	processFrame(Frame frame) Приложения должны вызывать этот метод на платформах, где требуется обработка по кадрам. Этот метод недоступен на платформе HoloLens.
Future	refreshAnchorPropertiesAsync(final CloudSpatialAnchor anchor) Обновляет свойства указанной пространственной привязки.
void	removeAnchorLocatedListener(AnchorLocatedListener listener) Удаляет указанный прослушиватель для получения событий AnchorLocated. Происходит при определении расположения привязки.
void	removeErrorListener(SessionErrorListener listener) Удаляет указанный прослушиватель для получения событий error. Происходит, когда сеанс не может продолжить обработку.
void	removeLocateAnchorsCompletedListener(LocateAnchorsCompletedListener listener) Удаляет указанный прослушиватель для получения событий LocateAnchorsCompleted. Происходит при обработке всех результатов от наблюдателя, который определяет привязки.
void	removeOnLogDebugListener(OnLogDebugListener listener) Удаляет указанный прослушиватель для получения событий OnLogDebug. Происходит при создании сообщения журнала отладки.
void	removeSessionUpdatedListener(SessionUpdatedListener listener) Удаляет указанный прослушиватель для получения событий SessionUpdated. Происходит при обновлении всего состояния сеанса.
void	removeTokenRequiredListener(TokenRequiredListener listener) Удаляет указанный прослушиватель для получения событий TokenRequired. Происходит, когда сеансу требуется обновленный маркер доступа или маркер проверки подлинности.
void	removeUpdatedSensorFingerprintRequiredListener(UpdatedSensorFingerprintRequiredListener listener) Удаляет указанный прослушиватель для получения событий UpdatedSensorFingerprintRequired. Происходит, когда сеанс запрашивает обновленный отпечаток датчика из приложения.
void	reset() Сбрасывает данные среды, которые были записаны в этом сеансе; приложения должны вызывать этот метод при потере отслеживания. На любой платформе вызов метода очистит все внутреннее кэшированное состояние.
void	setLocationProvider(PlatformLocationProvider value) Поставщик расположения, используемый для создания и поиска привязок с помощью [Грубой перелокализации](https://aka.ms/CoarseRelocalization).
void	setLogLevel(SessionLogLevel value) Уровень ведения журнала для событий журнала сеансов.
void	setSession(Session value) Задает сеанс отслеживания, используемый для поиска привязок. Это свойство недоступно на платформе HoloLens.
void	setTelemetryEnabled(boolean value)
void	start() Начинает сбор данных среды для сеанса.
void	stop() Прекращает сбор данных среды для сеанса и отменяет все невыполненные операции обнаружения. Данные среды поддерживаются.
Future	updateAnchorPropertiesAsync(final CloudSpatialAnchor anchor) Обновления указанной пространственной привязки.

Сведения о конструкторе

CloudSpatialAnchorSession

public CloudSpatialAnchorSession()

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

Сведения о методе

addAnchorLocatedListener

public void addAnchorLocatedListener(AnchorLocatedListener listener)

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

Parameters:

listener

addErrorListener

public void addErrorListener(SessionErrorListener listener)

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

Parameters:

listener

addLocateAnchorsCompletedListener

public void addLocateAnchorsCompletedListener(LocateAnchorsCompletedListener listener)

Добавляет указанный прослушиватель для получения событий LocateAnchorsCompleted. Происходит при обработке всех результатов от наблюдателя, который определяет привязки.

Parameters:

listener

addOnLogDebugListener

public void addOnLogDebugListener(OnLogDebugListener listener)

Добавляет указанный прослушиватель для получения событий OnLogDebug. Происходит при создании сообщения журнала отладки.

Parameters:

listener

addSessionUpdatedListener

public void addSessionUpdatedListener(SessionUpdatedListener listener)

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

Parameters:

listener

addTokenRequiredListener

public void addTokenRequiredListener(TokenRequiredListener listener)

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

Parameters:

listener

addUpdatedSensorFingerprintRequiredListener

public void addUpdatedSensorFingerprintRequiredListener(UpdatedSensorFingerprintRequiredListener listener)

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

Parameters:

listener

close

public void close()

Закрывает этот ресурс.

createAnchorAsync

public Future createAnchorAsync(final CloudSpatialAnchor anchor)

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

Parameters:

anchor - Привязка, сохраняемая.

createWatcher

public CloudSpatialAnchorWatcher createWatcher(AnchorLocateCriteria criteria)

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

Parameters:

criteria - Критерии для привязок для отслеживания.

deleteAnchorAsync

public Future deleteAnchorAsync(final CloudSpatialAnchor anchor)

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

Parameters:

anchor - Удаляемая привязка.

finalize

protected void finalize()

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

getAccessTokenWithAccountKeyAsync

public Future getAccessTokenWithAccountKeyAsync(final String accountKey)

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

Parameters:

accountKey - Ключ учетной записи.

getAccessTokenWithAuthenticationTokenAsync

public Future getAccessTokenWithAuthenticationTokenAsync(final String authenticationToken)

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

Parameters:

authenticationToken - Маркер проверки подлинности.

getActiveWatchers

public List getActiveWatchers()

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

getAnchorPropertiesAsync

public Future getAnchorPropertiesAsync(final String identifier)

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

Parameters:

identifier - Идентификатор для поиска.

getConfiguration

public SessionConfiguration getConfiguration()

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

getDiagnostics

public CloudSpatialAnchorSessionDiagnostics getDiagnostics()

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

getLocationProvider

public PlatformLocationProvider getLocationProvider()

Поставщик расположения, используемый для создания и поиска привязок с помощью [Грубой перелокализации](https://aka.ms/CoarseRelocalization).

getLogLevel

public SessionLogLevel getLogLevel()

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

getNearbyAnchorIdsAsync

public Future> getNearbyAnchorIdsAsync(final NearDeviceCriteria criteria)

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

Parameters:

criteria - Условие поиска.

getSession

public Session getSession()

Возвращает сеанс отслеживания, используемый для поиска привязок. Это свойство недоступно на платформе HoloLens.

getSessionId

public String getSessionId()

Возвращает уникальный идентификатор сеанса.

getSessionStatusAsync

public Future getSessionStatusAsync()

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

getTelemetryEnabled

public boolean getTelemetryEnabled()

processFrame

public void processFrame(Frame frame)

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

Parameters:

frame - Кадр AR для обработки.

refreshAnchorPropertiesAsync

public Future refreshAnchorPropertiesAsync(final CloudSpatialAnchor anchor)

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

Parameters:

anchor - Привязка для обновления.

removeAnchorLocatedListener

public void removeAnchorLocatedListener(AnchorLocatedListener listener)

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

Parameters:

listener

removeErrorListener

public void removeErrorListener(SessionErrorListener listener)

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

Parameters:

listener

removeLocateAnchorsCompletedListener

public void removeLocateAnchorsCompletedListener(LocateAnchorsCompletedListener listener)

Удаляет указанный прослушиватель для получения событий LocateAnchorsCompleted. Происходит при обработке всех результатов от наблюдателя, который определяет привязки.

Parameters:

listener

removeOnLogDebugListener

public void removeOnLogDebugListener(OnLogDebugListener listener)

Удаляет указанный прослушиватель для получения событий OnLogDebug. Происходит при создании сообщения журнала отладки.

Parameters:

listener

removeSessionUpdatedListener

public void removeSessionUpdatedListener(SessionUpdatedListener listener)

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

Parameters:

listener

removeTokenRequiredListener

public void removeTokenRequiredListener(TokenRequiredListener listener)

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

Parameters:

listener

removeUpdatedSensorFingerprintRequiredListener

public void removeUpdatedSensorFingerprintRequiredListener(UpdatedSensorFingerprintRequiredListener listener)

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

Parameters:

listener

reset

public void reset()

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

setLocationProvider

public void setLocationProvider(PlatformLocationProvider value)

Поставщик расположения, используемый для создания и поиска привязок с помощью [Грубой перелокализации](https://aka.ms/CoarseRelocalization).

Parameters:

value - Новое значение.

setLogLevel

public void setLogLevel(SessionLogLevel value)

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

Parameters:

value - Новое значение.

setSession

public void setSession(Session value)

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

Parameters:

value - Новое значение.

setTelemetryEnabled

public void setTelemetryEnabled(boolean value)

Parameters:

value

start

public void start()

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

stop

public void stop()

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

updateAnchorPropertiesAsync

public Future updateAnchorPropertiesAsync(final CloudSpatialAnchor anchor)

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

Parameters:

anchor - Обновляемая привязка.