在 Android 應用程式中啟用 AR

啟用 AR 即可在新的或現有應用程式中使用擴增實境功能。

將應用程式設為需要 AR 或 AR 選用

為了節省個別裝置的空間，所有 AR 功能都會儲存在名為「Google Play 服務 - AR 適用」的應用程式中，該應用程式會由 Play 商店分別更新。採用 AR 功能的 Android 應用程式會使用 ARCore SDK 與 Google Play 服務 - AR 通訊。你可以透過以下兩種方式設定支援 AR 功能的應用程式：需要擴增實境 (AR) 和選用 AR (選用)。這項標示可決定應用程式如何與 Google Play 服務 - AR 應用程式互動。

需要 AR 必要的應用程式無法在沒有 ARCore 的情況下運作。必須使用支援 ARCore 的裝置，並且安裝「Google Play 服務 - AR 適用」。

Google Play 商店只會在支援 ARCore 的裝置上提供必要的 AR 應用程式。
當使用者安裝「需要 AR 規定」應用程式後，Google Play 商店就會自動在裝置上安裝「Google Play 服務 - AR 適用」服務。不過，假如 Google Play 服務 - AR 版本過舊或手動解除安裝，應用程式仍須執行額外的執行階段檢查。

AR 選用應用程式會利用 ARCore 強化現有功能。它具有選用的 AR 功能，只有在已安裝 Google Play 服務 - AR 支援的裝置上才支援 ARCore。

您可以在不支援 ARCore 的裝置上安裝及執行 AR 選用應用程式。
使用者安裝 AR 選用應用程式時，Google Play 商店不會自動在裝置上安裝 Google Play 服務 - AR 適用服務。

	需要 AR	AR (選用)
AR 功能使用情形	您的應用程式需要有 ARCore 才能使用基本功能。	ARCore 可強化應用程式的功能。您的應用程式可以在不支援 ARCore 的情況下執行。
Play 商店顯示設定	您的應用程式只會在支援 ARCore 的裝置上的 Play 商店上架。	您的應用程式符合正常商店資訊程序。
「Google Play 服務 - AR 適用」安裝方法	Play 商店會為您的應用程式一併安裝 Google Play 服務 - AR 適用服務。	您的應用程式會使用 `ArCoreApk.requestInstall()` 下載並安裝 ARCore。
Android `minSdkVersion` 需求條件	Android 7.0 (API 級別 24)	Android 7.0 (API 級別 24)
必須使用 `ArCoreApk.checkAvailability()` 或 `ArCoreApk.checkAvailabilityAsync()` 查看 ARCore 支援和安裝狀態
請務必使用 `ArCoreApk.requestInstall()` 安裝 Google Play 服務 - AR 適用

如要讓應用程式成為必要或選用 AR 功能，請更新 AndroidManifest.xml 加入下列項目：

需要 AR

<uses-permission android:name="android.permission.CAMERA" />

<!-- Limits app visibility in the Google Play Store to ARCore supported devices
     (https://developers.google.com/ar/devices). -->
<uses-feature android:name="android.hardware.camera.ar" />

<application …>
    …

    <!-- "AR Required" app, requires "Google Play Services for AR" (ARCore)
         to be installed, as the app does not include any non-AR features. -->
    <meta-data android:name="com.google.ar.core" android:value="required" />
</application>

AR (選用)

<uses-permission android:name="android.permission.CAMERA" />

<!-- If your app was previously AR Required, don't forget to remove the
     `<uses-feature android:name="android.hardware.camera.ar" />` entry, as
     this would limit app visibility in the Google Play Store to only
     ARCore supported devices. -->

<application …>
    …

    <!-- "AR Optional" app, contains non-AR features that can be used when
         "Google Play Services for AR" (ARCore) is not available. -->
    <meta-data android:name="com.google.ar.core" android:value="optional" />
</application>

接著，修改應用程式的 build.gradle，指定至少 24 的 minSdkVersion：

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

新增建構依附元件

如要在 Android Studio 專案中加入 ARCore，請按照下列步驟操作：

請確認專案的 build.gradle 檔案包含 Google 的 Maven 存放區。
```
allprojects {
    repositories {
        google()
        …
    }
}
```
將最新的 ARCore 程式庫新增為應用程式 build.gradle 檔案中的依附元件。
```
dependencies {
    …
    implementation 'com.google.ar:core:1.33.0'
}
```

執行執行階段檢查

在執行階段中執行下列動作，確保應用程式的 AR 功能順暢運作。

確認是否支援 ARCore

必要的 AR 和 AR 選用應用程式都應使用 ArCoreApk.checkAvailability() 或 ArCoreApk.checkAvailabilityAsync()，判斷目前裝置是否支援 ARCore。在不支援 ARCore 的裝置上，應用程式應停用 AR 相關功能並隱藏相關聯的 UI 元素。

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {
  super.onCreate(savedInstanceState)

  // Enable AR-related functionality on ARCore supported devices only.
  maybeEnableArButton()
  …
}

fun maybeEnableArButton() {
  ArCoreApk.getInstance().checkAvailabilityAsync(this) { availability ->
    if (availability.isSupported) {
      mArButton.visibility = View.VISIBLE
      mArButton.isEnabled = true
    } else { // The device is unsupported or unknown.
      mArButton.visibility = View.INVISIBLE
      mArButton.isEnabled = false
    }
  }
}

Java

@Override
protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);

  // Enable AR-related functionality on ARCore supported devices only.
  maybeEnableArButton();
  …
}

void maybeEnableArButton() {
  ArCoreApk.getInstance().checkAvailabilityAsync(this, availability -> {
    if (availability.isSupported()) {
      mArButton.setVisibility(View.VISIBLE);
      mArButton.setEnabled(true);
    } else { // The device is unsupported or unknown.
      mArButton.setVisibility(View.INVISIBLE);
      mArButton.setEnabled(false);
    }
  });
}

雖然「Google Play 服務 - AR 適用」會與「需要 AR 規定」應用程式一併安裝，但是如果裝置不受支援，使用者仍可能從外部來源安裝該應用程式。使用 ArCoreApk.checkAvailability() 或 ArCoreApk.checkAvailabilityAsync() 檢查 ARCore 支援，確保提供一致的體驗。

「ArCoreApk.checkAvailability()」可能需要查詢網路資源，才能判斷裝置是否支援 ARCore。在這段期間內，會傳回 UNKNOWN_CHECKING。為了減少感知的延遲時間和彈出的情況，應用程式應在生命週期內提前呼叫 ArCoreApk.checkAvailability() 以啟動查詢，並忽略傳回的值。這樣一來，系統可能會在顯示 AR 進入 UI 元素時，立即顯示快取結果。

檢查是否已安裝 Google Play 服務 - AR 服務

必要和 AR 選用應用程式都必須呼叫 ArCoreApk.requestInstall()，才能建立 ARCore 工作階段，檢查是否已安裝相容版本的 Google Play 服務 - AR 服務，並確認已下載所有必要的 ARCore 裝置設定檔資料。

Kotlin

// requestInstall(Activity, true) will triggers installation of
// Google Play Services for AR if necessary.
var mUserRequestedInstall = true

override fun onResume() {
  super.onResume()

  // Check camera permission.
  …

  // Ensure that Google Play Services for AR and ARCore device profile data are
  // installed and up to date.
  try {
    if (mSession == null) {
      when (ArCoreApk.getInstance().requestInstall(this, mUserRequestedInstall)) {
        ArCoreApk.InstallStatus.INSTALLED -> {
          // Success: Safe to create the AR session.
          mSession = Session(this)
        }
        ArCoreApk.InstallStatus.INSTALL_REQUESTED -> {
          // When this method returns `INSTALL_REQUESTED`:
          // 1. ARCore pauses this activity.
          // 2. ARCore prompts the user to install or update Google Play
          //    Services for AR (market://details?id=com.google.ar.core).
          // 3. ARCore downloads the latest device profile data.
          // 4. ARCore resumes this activity. The next invocation of
          //    requestInstall() will either return `INSTALLED` or throw an
          //    exception if the installation or update did not succeed.
          mUserRequestedInstall = false
          return
        }
      }
    }
  } catch (e: UnavailableUserDeclinedInstallationException) {
    // Display an appropriate message to the user and return gracefully.
    Toast.makeText(this, "TODO: handle exception " + e, Toast.LENGTH_LONG)
        .show()
    return
  } catch (…) {
    …
    return  // mSession remains null, since session creation has failed.
  }
  …
}

Java

// requestInstall(Activity, true) will trigger installation of
// Google Play Services for AR if necessary.
private boolean mUserRequestedInstall = true;

@Override
protected void onResume() {
  super.onResume();

  // Check camera permission.
  …

  // Ensure that Google Play Services for AR and ARCore device profile data are
  // installed and up to date.
  try {
    if (mSession == null) {
      switch (ArCoreApk.getInstance().requestInstall(this, mUserRequestedInstall)) {
        case INSTALLED:
          // Success: Safe to create the AR session.
          mSession = new Session(this);
          break;
        case INSTALL_REQUESTED:
          // When this method returns `INSTALL_REQUESTED`:
          // 1. ARCore pauses this activity.
          // 2. ARCore prompts the user to install or update Google Play
          //    Services for AR (market://details?id=com.google.ar.core).
          // 3. ARCore downloads the latest device profile data.
          // 4. ARCore resumes this activity. The next invocation of
          //    requestInstall() will either return `INSTALLED` or throw an
          //    exception if the installation or update did not succeed.
          mUserRequestedInstall = false;
          return;
      }
    }
  } catch (UnavailableUserDeclinedInstallationException e) {
    // Display an appropriate message to the user and return gracefully.
    Toast.makeText(this, "TODO: handle exception " + e, Toast.LENGTH_LONG)
        .show();
    return;
  } catch (…) {
    …
    return;  // mSession remains null, since session creation has failed.
  }
  …
}

要求相機權限

AR 選用與支援 AR 的應用程式都必須確保已取得相機權限，才能建立 AR 工作階段。

Kotlin

override fun onResume() {
  super.onResume()

  // ARCore requires camera permission to operate.
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    CameraPermissionHelper.requestCameraPermission(this)
    return
  }

  …
}

Java

@Override
protected void onResume() {
  super.onResume();

  // ARCore requires camera permission to operate.
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    CameraPermissionHelper.requestCameraPermission(this);
    return;
  }

  …
}

您的 AR 活動也必須實作 onRequestPermissionsResult()。

Kotlin

override fun onRequestPermissionsResult(
  requestCode: Int,
  permissions: Array<String>,
  results: IntArray
) {
  super.onRequestPermissionsResult(requestCode, permissions, results)
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    Toast.makeText(this, "Camera permission is needed to run this application", Toast.LENGTH_LONG)
      .show()
    if (!CameraPermissionHelper.shouldShowRequestPermissionRationale(this)) {
      // Permission denied with checking "Do not ask again".
      CameraPermissionHelper.launchPermissionSettings(this)
    }
    finish()
  }
}

Java

@Override
public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] results) {
  super.onRequestPermissionsResult(requestCode, permissions, results);
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    Toast.makeText(this, "Camera permission is needed to run this application", Toast.LENGTH_LONG)
        .show();
    if (!CameraPermissionHelper.shouldShowRequestPermissionRationale(this)) {
      // Permission denied with checking "Do not ask again".
      CameraPermissionHelper.launchPermissionSettings(this);
    }
    finish();
  }
}

遵守使用者隱私規定

如要在 Play 商店中發布應用程式，請確認您的應用程式符合 ARCore 的「使用者隱私權規定」。

後續步驟

瞭解如何設定 ARCore 工作階段。