הפעלת 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 Services למציאות רבודה.

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

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

  • אפשר להתקין ולהפעיל אפליקציות אופציונליות של AR במכשירים שלא תומכים ב-ARCore.
  • כשמשתמשים מתקינים אפליקציה ל-AR, חנות Google Play לא תתקין במכשיר באופן אוטומטי את Google Play Services למציאות רבודה.
נדרש 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 4.4 (רמת API 19), אבל הפעלה כלשהי של פונקציונליות AR מחייבת Android 7.0 (רמת API 24) לפחות
צריך להשתמש ב-ArCoreApk_checkAvailability() או ב-ArCoreApk_checkAvailabilityAsync() כדי לבדוק את התמיכה ב-ARCore ואת סטטוס ההתקנה
עליך להשתמש ב- ArCoreApk.requestInstall() כדי להתקין את Google Play Services למציאות רבודה

כדי שהאפליקציה תהיה חובה או 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 נתמך

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

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

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

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

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

מה השלב הבא?