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)

指定したローカル アンカーおよび文字列プロパティから、新しい永続化された空間アンカーを作成します。 このメソッドに渡されるローカル アンカーには、有効な変換が必要です。 iOS などの Azure Spatial Anchors でサポートされている一部のプラットフォームでは、スケール コンポーネント != 1.0 を使用した変換が許可されていることに注意してください。 Azure Spatial Anchors SDK はこのような変換をサポートしていないため、エラー コード InvalidAnchorTransformRigidity を使用して空間アンカーを作成できません。 アンカーのスケール処理は、アプリ レベルで行う必要があります。
CloudSpatialAnchorWatcher createWatcher(AnchorLocateCriteria criteria)

指定した条件を満たすアンカーを監視する新しいオブジェクトを作成します。
Future deleteAnchorAsync(final CloudSpatialAnchor anchor)

永続化された空間アンカーを削除します。
void finalize()

オブジェクトへの参照がなくなったとガベージ コレクションが判断したときに、オブジェクトのガベージ コレクターによって呼び出されます。

Future<String> getAccessTokenWithAccountKeyAsync(final String accountKey)

アカウント キーから Azure Spatial Anchors アクセス トークンを取得します。
Future<String> getAccessTokenWithAuthenticationTokenAsync(final String authenticationToken)

認証トークンから Azure Spatial Anchors アクセス トークンを取得します。
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)

指定したローカル アンカーおよび文字列プロパティから、新しい永続化された空間アンカーを作成します。 このメソッドに渡されるローカル アンカーには、有効な変換が必要です。 iOS などの Azure Spatial Anchors でサポートされている一部のプラットフォームでは、スケール コンポーネント != 1.0 を使用した変換が許可されていることに注意してください。 Azure Spatial Anchors 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 Spatial Anchors アクセス トークンを取得します。

Parameters:

accountKey - アカウント キー。

getAccessTokenWithAuthenticationTokenAsync

public Future getAccessTokenWithAuthenticationTokenAsync(final String authenticationToken)

認証トークンから Azure Spatial Anchors アクセス トークンを取得します。

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 - 更新するアンカー。

適用対象