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

הפעלת 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

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

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

  …
}

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

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 בנושא פרטיות המשתמשים.

מה השלב הבא?