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

แอป Android NDK อาจใช้คลาส Java ArCoreApk เพื่อตรวจสอบความเข้ากันได้และจัดการการติดตั้งใน ARCore Session API ของ C ดั้งเดิม การดำเนินการนี้อาจง่ายกว่าการใช้ฟังก์ชัน 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 หรือไม่ ในระหว่างนี้ ระบบจะแสดงผล AR_AVAILABILITY_UNKNOWN_CHECKING ทั้งนี้เพื่อลดเวลาในการตอบสนองที่รู้สึกได้และป๊อปอิน แอปควรเรียกใช้ ArCoreApk_checkAvailability() 1 ครั้งในช่วงต้นของวงจรเพื่อเริ่มการค้นหา โดยไม่คำนึงถึงค่าที่แสดงผล วิธีนี้จะทำให้ผลลัพธ์ที่แคชไว้พร้อมใช้งานทันทีเมื่ออาจมีการแสดงองค์ประกอบ UI ที่ป้อน AR

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

ทั้งแอปที่ต้องใช้ AR และแอปทางเลือก AR ต้องใช้ 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