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

כדי שהאפליקציה תהיה חובה או AR אופציונלית, צריך לעדכן את AndroidManifest.xml כך שיכלול את הערכים הבאים:

<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

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

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
    }
  }
}

@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);
    }
  });
}

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

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

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

// 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.
  }
  …
}

// 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.

override fun onResume() {
  super.onResume()

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

  …
}

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

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

  …
}

עליכם להטמיע גם את onRequestPermissionsResult() בפעילות ה-AR.

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()
  }
}

@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