启用 AR 可在您的新应用或现有应用中使用增强现实功能。
将应用配置为“需要 AR”或“可选 AR”
为了节省各个设备上的空间,所有 AR 功能都存储在一个名为面向 AR 的 Google Play 服务的应用中,该应用由 Play 商店单独更新。使用 AR 功能的 Android 应用会通过 ARCore SDK 与“面向 AR 的 Google Play 服务”通信。支持 AR 功能的应用可以通过两种方式进行配置:AR 必需和 AR 可选。此指定项决定了应用与“面向 AR 的 Google Play 服务”应用的互动方式。
需要 AR 的应用在没有 ARCore 的情况下无法运行。它需要支持 ARCore 的设备,并且该设备已安装“面向 AR 的 Google Play 服务”。
- Google Play 商店只会让支持 ARCore 的设备能够使用 AR 必需应用。
- 当用户安装 AR 必需应用时,Google Play 商店会自动在其设备上安装“面向 AR 的 Google Play 服务”。不过,您的应用仍必须执行额外的运行时检查,以防面向 AR 的 Google Play 服务过时或已被手动卸载。
AR 可选应用使用 ARCore 来增强现有功能。它具有可选的 AR 功能,这些功能仅在安装了“面向 AR 的 Google Play 服务”且支持 ARCore 的设备上激活。
- AR 可选应用可以在不支持 ARCore 的设备上安装和运行。
- 当用户安装 AR 可选应用时,Google Play 商店将不会在设备上自动安装面向 AR 的 Google Play 服务。
| 需要 AR | AR 可选 | |
|---|---|---|
| AR 功能使用情况 | 您的应用需要 ARCore 才能实现基本功能。 | ARCore 可增强应用的功能。您的应用可以在不支持 ARCore 的情况下运行。 |
| Play 商店曝光度 | 您的应用仅在支持 ARCore 的设备上的 Play 商店中上架。 | 您的应用遵循正常的商品详情流程。 |
| “面向 AR 的 Google Play 服务”安装方法 | Play 商店会与您的应用一起安装“面向 AR 的 Google Play 服务”。 | 您的应用使用
ArCoreApk.requestInstall()
下载并安装 ARCore。 |
Android minSdkVersion 要求 |
Android 7.0(API 级别 24) | Android 4.4(API 级别 19),但运行任何 AR 功能至少需要 Android 7.0(API 级别 24) |
必须使用 ArCoreApk_checkAvailability() 或 ArCoreApk_checkAvailabilityAsync() 来检查 ARCore 支持情况和安装状态
|
||
必须使用
ArCoreApk.requestInstall()
来安装“面向 AR 的 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
}
}
添加 build 依赖项
请确保项目的
build.gradle文件包含 Google 的 Maven 制品库。allprojects { repositories { google() … } }向模块的
build.gradle文件添加自定义任务,以从 ARCore AAR 文件中提取包含的原生库。这样,便可在 C 或 C++ 项目中直接引用它们。在
app/build目录中,定义一个变量,用于指定原生库将提取到的目录。创建 Gradle 配置以保存数据和提取任务。
/* The ARCore AAR library contains native shared libraries that are extracted before building to a temporary directory. */ def arcore_libpath = "${buildDir}/arcore-native" // Create a configuration to mark which aars to extract .so files from configurations { natives }创建一个任务,用于从 AAR 文件复制原生库,并将其添加到 build 依赖项中。
// Extracts the shared libraries from AARs in the native configuration // so that NDK builds can access these libraries. task extractNativeLibraries() { // Extract every time. outputs.upToDateWhen { false } doFirst { configurations.natives.files.each { f -> copy { from zipTree(f) into arcore_libpath include "jni/**/*" } } } } tasks.whenTaskAdded { task-> if (task.name.contains("external") && !task.name.contains("Clean")) { task.dependsOn(extractNativeLibraries) } }配置原生 build 标志,以将位置信息传递给外部 build 工具。
// From the sample app. externalNativeBuild { cmake { cppFlags "-std=c++11", "-Wall" arguments "-DANDROID_STL=c++_static", "-DARCORE_LIBPATH=${arcore_libpath}/jni", "-DARCORE_INCLUDE=${project.rootDir}/../../libraries/include" } }添加 Java 库和原生库的依赖项。
dependencies { ... // Add Java and native dependencies to the ARCore library. implementation 'com.google.ar:core:1.33.0' natives 'com.google.ar:core:1.33.0' ... }在
CMakeLists.txt中引用原生库。# Import the ARCore library. add_library(arcore SHARED IMPORTED) set_target_properties(arcore PROPERTIES IMPORTED_LOCATION ${ARCORE_LIBPATH}/${ANDROID_ABI}/libarcore_sdk_c.so INTERFACE_INCLUDE_DIRECTORIES ${ARCORE_INCLUDE} )
执行运行时检查
在运行时,请执行以下操作,确保应用中的 AR 功能顺畅运行。
检查是否支持 ARCore
AR 必需应用和 AR 可选应用都应使用ArCoreApk_checkAvailability() 或 ArCoreApk_checkAvailabilityAsync() 来确定当前设备是否支持 ARCore。在不支持 ARCore 的设备上,应用应停用与 AR 相关的功能并隐藏关联的界面元素。
Android NDK 应用可以使用 Java ArCoreApk 类来检查兼容性,并在原生 C ARCore 会话 API 中管理安装。由于涉及大量错误处理和界面互动,因此与使用 ArCoreApk_ 函数相比,这可能更简单。
void maybeEnableArButton(JNIEnv env, jobject context) {
// Likely called from Activity.onCreate() of an activity with AR buttons.
ArAvailability availability
ArCoreApk_checkAvailability(env, context, &availability);
if (availability == AR_AVAILABILITY_UNKNOWN_CHECKING) {
// Set a timer to call maybeEnableArButton() again after about 200ms.
}
if (availability == AR_AVAILABILITY_SUPPORTED_NOT_INSTALLED ||
availability == AR_AVAILABILITY_SUPPORTED_APK_TOO_OLD ||
availability == AR_AVAILABILITY_SUPPORTED_INSTALLED) {
// Show or enable the AR button.
} else {
// Hide or disable the AR button.
}
}
ArCoreApk_checkAvailability() 或 ArCoreApk_checkAvailabilityAsync() 检查 ARCore 支持情况可确保获得一致的体验。
ArCoreApk_checkAvailability() 可能需要查询网络资源,以确定设备是否支持 ARCore。在此期间,它将返回 AR_AVAILABILITY_UNKNOWN_CHECKING。为了减少感知到的延迟和弹出,应用应在其生命周期的早期调用 ArCoreApk_checkAvailability() 一次以启动查询,并忽略返回的值。这样,当可能显示 AR 进入界面元素时,系统会立即提供缓存的结果。
检查是否已安装“面向 AR 的 Google Play 服务”
AR 必需应用和 AR 可选应用都必须在创建 ARCore 会话之前使用
ArCoreApk.requestInstall()
检查是否已安装(或仍已安装)兼容版本的“面向 AR 的 Google Play 服务”,并确保已下载所有必需的 ARCore 设备配置文件数据。
// Tracks if an installation request has already been triggered.
bool install_requested_;
void nativeOnCreate() {
// Do other setup here.
install_requested_ = false;
}
void nativeOnResume(JNIEnv env, jobject activity) {
if (ar_session_ == null) {
bool user_requested_install = !install_requested_;
ArInstallStatus install_status;
// Ensure that Google Play Services for AR and ARCore device profile data are
// installed and up to date.
ArStatus error = ArCoreApk_requestInstall(
env, activity, user_requested_install, &install_status);
if (error != AR_SUCCESS) {
// Inform user of error.
return;
}
switch (install_status) {
case AR_INSTALL_STATUS_INSTALLED:
break;
case AR_INSTALL_STATUS_INSTALL_REQUESTED:
// When this method returns AR_INSTALL_STATUS_INSTALL_REQUESTED:
// 1. This activity will be paused.
// 2. The user is prompted 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. This activity is resumed. The next invocation of
// ArCoreApk_requestInstall() will either return
// AR_INSTALL_STATUS_INSTALLED or throw an exception if the
// installation or update did not succeed.
install_requested_ = true;
return;
}
// Request camera permissions.
error = ArSession_create(env, context, &ar_session_);
if (error != AR_SUCCESS) {
// Inform user of error.
return;
}
// Configure the ARCore session.
}
// Normal onResume behavior.
}
遵守用户隐私权要求
如要在 Play 商店中发布应用,请确保应用符合 ARCore 的用户隐私权要求。
后续步骤
- 了解如何配置 ARCore 会话。