הפעלת AR באפליקציית Android NDK

מפעילים את ה-AR כדי להשתמש בתכונות של מציאות רבודה באפליקציה חדשה או קיימת.

הגדרת האפליקציה כנדרשת ל-AR או כאופציונלית ל-AR

כדי לחסוך מקום במכשירים ספציפיים, כל תכונות ה-AR מאוחסנות באפליקציה שנקראת Google Play Services למציאות רבודה, שמתעדכנת בנפרד דרך חנות Play. אפליקציות ל-Android שמשתמשות בתכונות AR מתקשרות עם Google Play Services למציאות רבודה באמצעות ARCore SDK. אפשר להגדיר אפליקציה שתומכת בתכונות AR בשתי דרכים: נדרש AR ואופציונלי AR. הייעוד הזה קובע את אופן האינטראקציה של האפליקציה עם האפליקציה של שירותי Google Play למציאות רבודה.

אפליקציה עם התווית נדרשת תמיכה ב-AR לא יכולה לפעול בלי ARCore. כדי להשתמש בה, צריך מכשיר שתומך ב-ARCore ושמותקנים בו שירותי Google Play למציאות רבודה.

  • אפליקציות שנדרש AR כדי להשתמש בהן יהיו זמינות בחנות Google Play רק במכשירים שתומכים ב-ARCore.
  • כשהמשתמשים מתקינים אפליקציה שנדרשת לה מציאות רבודה, חנות Google Play מתקינה אוטומטית במכשיר שלהם את שירותי Google Play ל-AR. עם זאת, האפליקציה שלכם עדיין צריכה לבצע בדיקות נוספות בזמן הריצה למקרה ש-Google Play Services למציאות רבודה לא מעודכן או שהוסר באופן ידני.

אפליקציית AR אופציונלי משתמשת ב-ARCore כדי לשפר את הפונקציונליות הקיימת. יש לה תכונות AR אופציונליות שמופעלות רק במכשירים שנתמכים על ידי ARCore ושמותקנים בהם שירותי Google Play למציאות רבודה.

  • אפשר להתקין ולהפעיל אפליקציות AR אופציונליות במכשירים שלא תומכים ב-ARCore.
  • כשמשתמשים מתקינים אפליקציה עם AR אופציונלי, חנות Google Play לא תתקין אוטומטית את Google Play Services למציאות רבודה במכשיר.
נדרש ARאופציונלי ל-AR
שימוש בתכונות AR האפליקציה שלך דורשת ARCore כדי לפעול בצורה בסיסית. ‫ARCore מרחיב את הפונקציונליות של האפליקציה. האפליקציה יכולה לפעול בלי תמיכה ב-ARCore.
גלוי בחנות Play האפליקציה שלכם מופיעה בחנות Play רק במכשירים שתומכים ב-ARCore. האפליקציה שלך עומדת בדרישות של תהליכי הפרסום הרגילים.
שיטת ההתקנה של Google Play Services למציאות רבודה חנות Play מתקינה את Google Play Services למציאות רבודה לצד האפליקציה. האפליקציה שלך משתמשת ב- 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 Services למציאות רבודה

כדי להגדיר את האפליקציה כנדרשת ל-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>

אופציונלי

<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

  1. מוודאים שקובץ build.gradle של הפרויקט כולל את מאגר ה-Maven של Google.

    allprojects {
        repositories {
            google()
            …
        }
    }
    
  2. מוסיפים משימה בהתאמה אישית לקובץ build.gradle של המודול כדי לחלץ ספריות מקומיות כלולות מקובץ ה-AAR של ARCore. כך אפשר להפנות אליהם ישירות בפרויקט C או C++.

  3. בספרייה app/build, מגדירים משתנה לספרייה שאליה יישלפו הספריות המקוריות.

  4. יוצרים הגדרת 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 }
    
  5. יוצרים משימה להעתקת הספריות המקוריות מקובץ ה-AAR, ומוסיפים אותה לתלות של הפרויקט בספריות.

    // 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)
        }
    }
    
  6. מגדירים את דגלי ה-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"
        }
    }
    
  7. מוסיפים את התלויות גם בספריות 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'
         ...
    }
    
  8. הפניה לספריות מקוריות ב-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 class כדי לבדוק תאימות ולנהל את ההתקנה ב-API של סשן ARCore ב-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 למציאות רבודה מותקנים לצד האפליקציה שנדרשת למציאות רבודה, משתמשים עם מכשירים לא נתמכים עשויים להתקין אותה ממקור חיצוני. כדי להבטיח חוויה עקבית, מומלץ להשתמש ב-ArCoreApk_checkAvailability() או ב-ArCoreApk_checkAvailabilityAsync() כדי לבדוק אם יש תמיכה ב-ARCore.

יכול להיות ש-ArCoreApk_checkAvailability() יצטרך לשלוח שאילתות למשאבי רשת כדי לקבוע אם המכשיר תומך ב-ARCore. במהלך הזמן הזה, הפונקציה תחזיר AR_AVAILABILITY_UNKNOWN_CHECKING. כדי לצמצם את זמן האחזור ואת התופעה של הופעת אובייקטים פתאומיים, האפליקציות צריכות לקרוא ל-ArCoreApk_checkAvailability() פעם אחת בשלב מוקדם במחזור החיים שלהן כדי להפעיל את השאילתה, ולהתעלם מהערך שמוחזר. כך, תוצאה שנשמרה במטמון תהיה זמינה באופן מיידי כשאלמנט ממשק משתמש של כניסה למציאות רבודה עשוי להיות מוצג.

איך בודקים אם שירותי Google Play למציאות רבודה מותקנים

גם אפליקציות שנדרשת בהן מציאות רבודה וגם אפליקציות שאפשר להשתמש בהן במציאות רבודה חייבות להשתמש ב- ArCoreApk.requestInstall() לפני יצירת סשן ARCore, כדי לבדוק אם גרסה תואמת של שירותי 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 בנושא פרטיות המשתמשים.

השלב הבא