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 进行转换。 Azure 空间定位点 SDK 不支持此类转换，并且将无法创建带有错误代码 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) 获取与给定条件对应的所有附近的云空间定位点 ID 的列表。
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 进行转换。 Azure 空间定位点 SDK 不支持此类转换，并且将无法创建带有错误代码 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)

获取与给定条件对应的所有附近的云空间定位点 ID 的列表。

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 - 要更新的定位点。