เปิดใช้ AR ในแอป NDK ของ Android

เปิดใช้ AR เพื่อใช้ฟีเจอร์ Augmented Reality ในแอปใหม่หรือแอปที่มีอยู่

กำหนดค่าแอปให้ใช้ AR หรือ AR ไม่บังคับ

เพื่อประหยัดพื้นที่ในอุปกรณ์แต่ละเครื่อง ฟีเจอร์ AR ทั้งหมดจะเก็บไว้ในแอปชื่อบริการ Google Play สำหรับ AR ซึ่งอัปเดตแยกต่างหากโดย Play Store แอป Android ที่ใช้ฟีเจอร์ AR จะสื่อสารกับบริการ Google Play สำหรับ AR โดยใช้ ARCore SDK คุณกำหนดค่าแอปที่รองรับฟีเจอร์ AR ได้ 2 วิธี ได้แก่ ต้องระบุ AR และไม่บังคับให้ใช้ AR การระบุนี้จะกำหนดวิธีที่แอปโต้ตอบกับบริการ Google Play สำหรับแอป AR

แอปที่ AR ต้องระบุ จะไม่ทำงานหากไม่มี ARCore ซึ่งต้องใช้อุปกรณ์ที่รองรับ ARCore ที่ติดตั้งบริการ Google Play สำหรับ AR

Google Play Store จะทําให้แอปต้องใช้ AR พร้อมใช้งานในอุปกรณ์ที่รองรับ ARCore เท่านั้น
เมื่อผู้ใช้ติดตั้งแอป AR ที่จำเป็น Google Play Store จะติดตั้งบริการ Google Play สำหรับ AR ในอุปกรณ์โดยอัตโนมัติ อย่างไรก็ตาม แอปยังต้องดำเนินการตรวจสอบรันไทม์เพิ่มเติมในกรณีที่บริการ Google Play สำหรับ AR ล้าสมัยหรือถูกถอนการติดตั้งด้วยตนเอง

แอป AR Optional ใช้ ARCore เพื่อเพิ่มประสิทธิภาพฟังก์ชันการทำงานที่มีอยู่ ซึ่งมีฟีเจอร์ AR ที่ไม่บังคับซึ่งเปิดใช้งานเฉพาะในอุปกรณ์ที่รองรับ ARCore ซึ่งได้ติดตั้งบริการ Google Play สำหรับ AR ไว้แล้ว

แอป AR Optional สามารถติดตั้งและทำงานในอุปกรณ์ที่ไม่รองรับ ARCore
เมื่อผู้ใช้ติดตั้งแอป AR Optional แล้ว Google Play Store จะไม่ติดตั้งบริการ Google Play สำหรับ AR ในอุปกรณ์โดยอัตโนมัติ

	ต้องใช้ AR	AR (ไม่บังคับ)
การใช้ฟีเจอร์ AR	แอปของคุณต้องใช้ ARCore สำหรับฟังก์ชันการทำงานพื้นฐาน	ARCore เสริมฟังก์ชันการทำงานของแอป แอปของคุณจะทำงานได้โดยไม่ต้องรองรับ ARCore
ระดับการเข้าถึง Play Store	แอปของคุณจะแสดงอยู่ใน Play Store ในอุปกรณ์ที่รองรับ ARCore เท่านั้น	แอปของคุณเป็นไปตามกระบวนการแสดงข้อมูลตามปกติ
วิธีการติดตั้งบริการ Google Play สำหรับ AR	Play Store จะติดตั้งบริการ Google Play สำหรับ AR ควบคู่ไปกับแอปของคุณ	แอปของคุณใช้ `ArCoreApk.requestInstall()` เพื่อดาวน์โหลดและติดตั้ง ARCore
ข้อกำหนดของ `minSdkVersion` สำหรับ Android	Android 7.0 (API ระดับ 24)	Android 4.4 (API ระดับ 19) แต่การใช้งานฟังก์ชัน AR ต้องใช้ Android 7.0 (API ระดับ 24) เป็นอย่างน้อย
ต้องใช้ `ArCoreApk_checkAvailability()` หรือ `ArCoreApk_checkAvailabilityAsync()` เพื่อตรวจสอบสถานะการรองรับและการติดตั้ง ARCore
ต้องใช้ `ArCoreApk.requestInstall()` เพื่อติดตั้งบริการ Google Play สำหรับ AR

ในการทำให้แอปต้องใช้ 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 ของแอปเพื่อระบุ minSdkVersion อย่างน้อย 24 ดังนี้

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

เพิ่มการพึ่งพิงบิวด์

ตรวจสอบว่าไฟล์ build.gradle ของโปรเจ็กต์มีที่เก็บ Maven ของ Google
```
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 และเพิ่มงานไปยังทรัพยากร Dependency ของบิลด์

// 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)
    }
}

กำหนดค่าแฟล็กบิลด์เนทีฟเพื่อส่งตำแหน่งไปยังเครื่องมือสร้างภายนอก

// 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"
    }
}

เพิ่มทรัพยากร Dependency สำหรับทั้ง 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 Optional ควรใช้ ArCoreApk_checkAvailability() หรือ ArCoreApk_checkAvailabilityAsync() เพื่อระบุว่าอุปกรณ์ปัจจุบันรองรับ ARCore หรือไม่ ในอุปกรณ์ที่ไม่รองรับ ARCore แอปควรปิดใช้ฟังก์ชันการทำงานที่เกี่ยวข้องกับ AR และซ่อนองค์ประกอบของ UI ที่เกี่ยวข้อง

แอป Android NDK อาจใช้คลาส Java ArCoreApk เพื่อตรวจสอบความเข้ากันได้และจัดการการติดตั้งใน C ARCore Session 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.
  }
}

แม้ว่าจะติดตั้งบริการ Google Play สำหรับ AR ควบคู่ไปกับแอปที่จำเป็นโดย AR แต่ผู้ใช้ที่มีอุปกรณ์ที่ไม่รองรับก็อาจติดตั้งจากแหล่งที่มาภายนอกได้ การใช้ ArCoreApk_checkAvailability() หรือ ArCoreApk_checkAvailabilityAsync() เพื่อตรวจสอบการสนับสนุนของ ARCore ช่วยให้ได้รับประสบการณ์การใช้งานที่สอดคล้องกัน

ArCoreApk_checkAvailability() อาจต้องค้นหาทรัพยากรของเครือข่ายเพื่อพิจารณาว่าอุปกรณ์รองรับ ARCore หรือไม่ ซึ่งในระหว่างนี้ URL ดังกล่าวจะแสดงผล AR_AVAILABILITY_UNKNOWN_CHECKING เพื่อลดเวลาในการตอบสนองที่รับรู้ได้และป๊อปอิน แอปควรเรียกใช้ ArCoreApk_checkAvailability() ตั้งแต่ช่วงต้นของวงจรเพื่อเริ่มการค้นหาโดยไม่ต้องสนใจค่าที่แสดงผล ด้วยวิธีนี้ ผลการค้นหาที่แคชไว้จะแสดงทันทีที่องค์ประกอบ UI ที่ใช้การป้อน AR แสดงขึ้น

ตรวจสอบว่ามีการติดตั้งบริการ Google Play สำหรับ AR หรือไม่

ทั้งแอป AR ที่จำเป็นและ AR Optional ต้องใช้ ArCoreApk.requestInstall() ก่อนสร้างเซสชัน ARCore เพื่อตรวจสอบว่ามีการติดตั้งบริการ Google Play สำหรับ AR เวอร์ชันที่เข้ากันได้หรือไม่ และตรวจสอบว่าได้ดาวน์โหลดข้อมูลโปรไฟล์ของอุปกรณ์ 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 Store โปรดตรวจสอบว่าแอปเป็นไปตามข้อกำหนดด้านความเป็นส่วนตัวของผู้ใช้ของ ARCore

สิ่งที่จะเกิดขึ้นหลังจากนี้

ดูวิธีกำหนดค่าเซสชัน ARCore