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

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

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

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

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

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

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

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

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

אפליקציית NDK ל-Android עשויה להשתמש במחלקה ArCoreApk של Java כדי לבדוק את התאימות ולנהל את ההתקנה ב-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 Services ל-AR מותקנת לצד אפליקציית ה-AR שחובה להתקין, משתמשים עם מכשירים שאינם נתמכים עשויים להתקין אותה ממקור חיצוני. השימוש ב-ArCoreApk_checkAvailability() או ב-ArCoreApk_checkAvailabilityAsync() לבדיקת תמיכה ב-ARCore מבטיח חוויה עקבית.

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

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

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

מה השלב הבא?