デバイスの現在地での VPS の提供状況を確認する

Geospatial API は、VPS データと GPS データを組み合わせて、高精度の地理空間ポーズを生成します。この API は、デバイスが現在地を特定できる場所であればどこでも使用できます。

  • 屋内空間や密集した都市環境など、GPS の精度が低いエリアでは、API は VPS の受信可能範囲を利用して、高精度のポーズを生成します。
  • 頭上の障害物がほとんどないか、まったくない屋外環境では、Geospatial API は利用可能な GPS 位置情報を使用して、地理空間のポーズを高精度で生成できる場合があります。

AR セッションの開始前に特定の水平位置での VPS の可用性を判断し、それを使用してより具体的なエクスペリエンスを創出できます。たとえば、VPS が使用可能な場合にのみ [AR を入力] ボタンを表示します。

ARCore API を有効にする

VPS が利用可能を確認するには、アプリで ARCore API を有効にする必要があります。

ARCore API を有効にすると、以下なしで VPS が利用可能かどうかを確認できます。

アプリで VPS の提供状況を確認する

Geospatial API は、デバイスが位置を特定できる場所であればどこでも使用できます。AR エクスペリエンスが VPS の受信可能範囲に左右される場合は、Session.checkVpsAvailabilityAsync() を使用して VpsAvailabilityFuture（特定の水平位置での VPS の可用性を確認する非同期タスク）を取得できます。 VpsAvailabilityFuture を取得すると、ポーリングまたはコールバックによって結果を取得できます。

結果をポーリングする

Future.getState() を使用して Future の状態を取得します。次の 3 つの状態があります。

  • PENDING: オペレーションはまだ完了していないため、結果は不明です。
  • CANCELLED: オペレーションは Future.cancel() によってキャンセルされました。登録済みのコールバックが呼び出されることはありません。
  • DONE: オペレーションが完了しました。VpsAvailabilityFuture.getResult() を使用して結果を取得します。

タスクが完了するまで、引き続き Future.getState() をチェックしてください。

Java

// Obtain a VpsAvailabilityFuture and store it somewhere.
VpsAvailabilityFuture future = session.checkVpsAvailabilityAsync(latitude, longitude, null);

// Poll VpsAvailabilityFuture later, for example, in a render loop.
if (future.getState() == FutureState.DONE) {
  switch (future.getResult()) {
    case AVAILABLE:
      // VPS is available at this location.
      break;
    case UNAVAILABLE:
      // VPS is unavailable at this location.
      break;
    case ERROR_NETWORK_CONNECTION:
      // The external service could not be reached due to a network connection error.
      break;

      // Handle other error states, e.g. ERROR_RESOURCE_EXHAUSTED, ERROR_INTERNAL, ...
  }
}

Kotlin

// Obtain a VpsAvailabilityFuture and store it somewhere.
val future = session.checkVpsAvailabilityAsync(latitude, longitude, null)

// Poll VpsAvailabilityFuture later, for example, in a render loop.
if (future.state == FutureState.DONE) {
  when (future.result) {
    VpsAvailability.AVAILABLE -> {
      // VPS is available at this location.
    }
    VpsAvailability.UNAVAILABLE -> {
      // VPS is unavailable at this location.
    }
    VpsAvailability.ERROR_NETWORK_CONNECTION -> {
      // The external service could not be reached due to a network connection error.
    }
    else -> {
      TODO("Handle other error states, e.g. ERROR_RESOURCE_EXHAUSTED, ERROR_INTERNAL, ...")
    }
  }
}

コールバックで結果を取得する

コールバックを介して Future の結果を取得することもできます。Session.checkVpsAvailabilityAsync() を使用して、callback を指定します。この callback は、Future の状態が DONE になった直後にメインスレッドで呼び出されます。

Java

session.checkVpsAvailabilityAsync(
    latitude,
    longitude,
    result -> {
      // Callback is called on the Main thread.
      switch (result) {
          // Handle the VpsAvailability result as shown above.
          // For example, show UI that enables your AR view.
      }
    });

Kotlin

session.checkVpsAvailabilityAsync(latitude, longitude) { result ->
  // Callback is called on the Main thread.

  // Handle the VpsAvailability result as shown above.
  // For example, show UI that enables your AR view.
  TODO("Handle VpsAvailability " + result)
}

Future をキャンセルする

Future.cancel() を使用して Future のキャンセルを試みます。スレッドの並列処理が原因で、キャンセルが成功しない場合があります。 Future.cancel() は、この試行が成功した場合は true を、失敗した場合は false を返します。

VPS カバレッジなしで Geospatial API を使用する

Geospatial API は、VPS がカバーされていない地域でも使用可能です。頭上の障害物がほとんどないか、まったくない屋外環境では、GPS で十分な精度のポーズを生成できます。

次のステップ