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

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

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

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

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

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

כדי להוסיף את 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 נתמכת

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

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

בדיקה אם Google Play Services למציאות רבודה מותקן

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

מה השלב הבא?

• איך מגדירים סשן של ARCore