次の方法で共有

ASACloudSpatialAnchorSession クラス

  • [アーティクル]

宣言

@interface ASACloudSpatialAnchorSession : NSObject;

説明

このクラスを使用して、空間アンカーを作成、検索、および管理します。

メソッド

Init

既定の構成で新しいインスタンスを初期化します。

-(instancetype)init;

処分

このセッションを停止し、関連するすべてのリソースを解放します。

-(void)dispose;

getAccessTokenWithAuthenticationToken

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

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

パラメーター

  • authenticationToken - 認証トークン。
  • completionHandler - アクセス トークン文字列。

戻り値

  • void

getAccessTokenWithAccountKey

アカウント キーから Azure Spatial Anchors アクセス トークンを取得します。

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

パラメーター

  • accountKey - アカウント キー。
  • completionHandler - アクセス トークン文字列。

戻り値

  • void

createAnchor

指定したローカル アンカーおよび文字列プロパティから、新しい永続化された空間アンカーを作成します。

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

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

パラメーター

  • anchor - 永続化するアンカー。
  • completionHandler - 非同期作成操作を表すタスク。

戻り値

  • void

createWatcher

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

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

パラメーター

  • criteria - 監視するアンカーの条件。

戻り値

  • ASACloudSpatialAnchorWatcher * - 条件が完全に満たされるかウォッチャーが停止するまでアンカーを継続的に検索する新しいウォッチャー オブジェクト。 アクティブなウォッチャーは一度に 1 つだけ存在できます。

getAnchorProperties

特定の識別子がまだ見つからない場合でも、特定の識別子のクラウド空間アンカーを取得します。

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

パラメーター

  • identifier - 検索する識別子。
  • completionHandler - 非同期取得操作を表すタスク。 取得されたアンカーにはプロパティ値がありますが、ローカル アンカーを使用できない場合があります。

戻り値

  • void

getNearbyAnchorIds

特定の条件に対応するすべての近くのクラウド空間アンカー ID の一覧を取得します。

-(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;

reset

このセッションでキャプチャされた環境データをリセットします。追跡が失われた場合、アプリケーションはこのメソッドを呼び出す必要があります。

どのプラットフォームでも、 メソッドを呼び出すと、すべての内部キャッシュ状態が消去されます。

-(void)reset;

プロパティ

delegate

この ASACloudSpatialAnchorSession インスタンスからイベントを受信するために指定するオブジェクト。

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

configuration

セッションの構成情報。

構成設定は、セッションの開始時に有効になります。

@property (retain, readonly) ASASessionConfiguration * configuration;

診断

セッションの診断設定。これは、トラブルシューティングと改善のためにデータを収集して送信するために使用できます。

@property (retain, readonly) ASACloudSpatialAnchorSessionDiagnostics * diagnostics;

logLevel

セッション ログ イベントのログ レベル。

@property ASASessionLogLevel logLevel;

session

アンカーを見つけるのに役立つ追跡セッション。

このプロパティは、HoloLens プラットフォームでは使用できません。

@property (retain) ARSession * session;

telemetryEnabled

この API を使用して、Azure Spatial Anchors SDK テレメトリを有効または無効にすることができます。 ASA SDK テレメトリは既定で有効になっています。 無効にした場合、ASA SDK はこのセッションのテレメトリ イベントをログに記録しません。 ASA SDK テレメトリを完全に無効にする必要があるアプリケーションでは、CloudSpatialAnchorSession::Start を呼び出す前にこの API を使用できます。これにより、その CloudSpatialAnchorSession インスタンスに対してテレメトリ イベントが送信されなくなります。

@property BOOL telemetryEnabled;

locationProvider

粗い再局在化を使用してアンカーを作成および検索するために使用される場所プロバイダー。

@property (retain) ASAPlatformLocationProvider * locationProvider;

sessionID

セッションの一意識別子。

@property (retain, readonly) NSString * sessionId;