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

מפעילים את ה-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>

אופציונלי ל-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

כדי להוסיף ARCore לפרויקט ב-Android Studio:

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

    allprojects {
    repositories {
        google()
        …
    }
}

  2. מוסיפים את ספריית ARCore העדכנית כתלות בקובץ build.gradle של האפליקציה.

    dependencies {
    …
    implementation 'com.google.ar:core:1.33.0'
}

ביצוע בדיקות בזמן ריצה

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

איך בודקים אם יש תמיכה ב-ARCore

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

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {
  super.onCreate(savedInstanceState)

  // Enable AR-related functionality on ARCore supported devices only.
  maybeEnableArButton()
  …
}

fun maybeEnableArButton() {
  ArCoreApk.getInstance().checkAvailabilityAsync(this) { availability ->
    if (availability.isSupported) {
      mArButton.visibility = View.VISIBLE
      mArButton.isEnabled = true
    } else { // The device is unsupported or unknown.
      mArButton.visibility = View.INVISIBLE
      mArButton.isEnabled = false
    }
  }
}

Java

@Override
protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);

  // Enable AR-related functionality on ARCore supported devices only.
  maybeEnableArButton();
  …
}

void maybeEnableArButton() {
  ArCoreApk.getInstance().checkAvailabilityAsync(this, availability -> {
    if (availability.isSupported()) {
      mArButton.setVisibility(View.VISIBLE);
      mArButton.setEnabled(true);
    } else { // The device is unsupported or unknown.
      mArButton.setVisibility(View.INVISIBLE);
      mArButton.setEnabled(false);
    }
  });
}
למרות ש-Google Play Services למציאות רבודה מותקנים לצד האפליקציה שנדרשת למציאות רבודה, משתמשים עם מכשירים שלא נתמכים עשויים להתקין אותם ממקור חיצוני. כדי להבטיח חוויה עקבית, מומלץ להשתמש ב-ArCoreApk.checkAvailability() או ב-ArCoreApk.checkAvailabilityAsync() כדי לבדוק אם יש תמיכה ב-ARCore.

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

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

גם אפליקציות שנדרשת בהן מציאות רבודה וגם אפליקציות שאפשר להשתמש בהן במציאות רבודה חייבות להשתמש ב- ArCoreApk.requestInstall() לפני יצירת סשן ARCore, כדי לבדוק אם גרסה תואמת של שירותי Google Play למציאות רבודה מותקנת (עדיין) וכדי לוודא שכל נתוני פרופיל המכשיר הנדרשים של ARCore הורדו.

Kotlin

// requestInstall(Activity, true) will triggers installation of
// Google Play Services for AR if necessary.
var mUserRequestedInstall = true

override fun onResume() {
  super.onResume()

  // Check camera permission.
  …

  // Ensure that Google Play Services for AR and ARCore device profile data are
  // installed and up to date.
  try {
    if (mSession == null) {
      when (ArCoreApk.getInstance().requestInstall(this, mUserRequestedInstall)) {
        ArCoreApk.InstallStatus.INSTALLED -> {
          // Success: Safe to create the AR session.
          mSession = Session(this)
        }
        ArCoreApk.InstallStatus.INSTALL_REQUESTED -> {
          // When this method returns `INSTALL_REQUESTED`:
          // 1. ARCore pauses this activity.
          // 2. ARCore prompts the user 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. ARCore resumes this activity. The next invocation of
          //    requestInstall() will either return `INSTALLED` or throw an
          //    exception if the installation or update did not succeed.
          mUserRequestedInstall = false
          return
        }
      }
    }
  } catch (e: UnavailableUserDeclinedInstallationException) {
    // Display an appropriate message to the user and return gracefully.
    Toast.makeText(this, "TODO: handle exception " + e, Toast.LENGTH_LONG)
        .show()
    return
  } catch (…) {
    …
    return  // mSession remains null, since session creation has failed.
  }
  …
}

Java

// requestInstall(Activity, true) will trigger installation of
// Google Play Services for AR if necessary.
private boolean mUserRequestedInstall = true;

@Override
protected void onResume() {
  super.onResume();

  // Check camera permission.
  …

  // Ensure that Google Play Services for AR and ARCore device profile data are
  // installed and up to date.
  try {
    if (mSession == null) {
      switch (ArCoreApk.getInstance().requestInstall(this, mUserRequestedInstall)) {
        case INSTALLED:
          // Success: Safe to create the AR session.
          mSession = new Session(this);
          break;
        case INSTALL_REQUESTED:
          // When this method returns `INSTALL_REQUESTED`:
          // 1. ARCore pauses this activity.
          // 2. ARCore prompts the user 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. ARCore resumes this activity. The next invocation of
          //    requestInstall() will either return `INSTALLED` or throw an
          //    exception if the installation or update did not succeed.
          mUserRequestedInstall = false;
          return;
      }
    }
  } catch (UnavailableUserDeclinedInstallationException e) {
    // Display an appropriate message to the user and return gracefully.
    Toast.makeText(this, "TODO: handle exception " + e, Toast.LENGTH_LONG)
        .show();
    return;
  } catch (…) {
    …
    return;  // mSession remains null, since session creation has failed.
  }
  …
}

שליחת בקשה לקבלת הרשאת גישה למצלמה

באפליקציות מסוג AR Optional ו-AR Required, צריך לוודא שההרשאה לגישה למצלמה ניתנה לפני שיוצרים סשן AR.

Kotlin

override fun onResume() {
  super.onResume()

  // ARCore requires camera permission to operate.
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    CameraPermissionHelper.requestCameraPermission(this)
    return
  }

  …
}

Java

@Override
protected void onResume() {
  super.onResume();

  // ARCore requires camera permission to operate.
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    CameraPermissionHelper.requestCameraPermission(this);
    return;
  }

  …
}

בנוסף, הפעילות שלכם ב-AR צריכה להשתמש ב-onRequestPermissionsResult().

Kotlin

override fun onRequestPermissionsResult(
  requestCode: Int,
  permissions: Array<String>,
  results: IntArray
) {
  super.onRequestPermissionsResult(requestCode, permissions, results)
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    Toast.makeText(this, "Camera permission is needed to run this application", Toast.LENGTH_LONG)
      .show()
    if (!CameraPermissionHelper.shouldShowRequestPermissionRationale(this)) {
      // Permission denied with checking "Do not ask again".
      CameraPermissionHelper.launchPermissionSettings(this)
    }
    finish()
  }
}

Java

@Override
public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] results) {
  super.onRequestPermissionsResult(requestCode, permissions, results);
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    Toast.makeText(this, "Camera permission is needed to run this application", Toast.LENGTH_LONG)
        .show();
    if (!CameraPermissionHelper.shouldShowRequestPermissionRationale(this)) {
      // Permission denied with checking "Do not ask again".
      CameraPermissionHelper.launchPermissionSettings(this);
    }
    finish();
  }
}

עמידה בדרישות בנושא פרטיות המשתמשים

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

השלב הבא