अपने Android NDK ऐप्लिकेशन में एआर की सुविधा चालू करें

अपने नए या मौजूदा ऐप्लिकेशन में ऑगमेंटेड रिएलिटी (एआर) की सुविधाओं का इस्तेमाल करने के लिए, एआर (ऑगमेंटेड रिएलिटी) की सुविधा चालू करें.

अपने ऐप्लिकेशन को एआर (ऑगमेंटेड रिएलिटी) ज़रूरी है या एआर (ऑगमेंटेड रिएलिटी) वैकल्पिक के तौर पर कॉन्फ़िगर करें

अलग-अलग डिवाइसों पर जगह बचाने के लिए, सभी एआर (ऑगमेंटेड रिएलिटी) सुविधाएं Google Play Services for AR ऐप्लिकेशन में सेव की जाती हैं. इस ऐप्लिकेशन को Play Store अलग से अपडेट करता है. एआर की सुविधाओं का इस्तेमाल करने वाले Android ऐप्लिकेशन, ARCore SDK टूल की मदद से Google Play Services for AR से संपर्क करते हैं. एआर की सुविधाओं के साथ काम करने वाले ऐप्लिकेशन को दो तरीकों से कॉन्फ़िगर किया जा सकता है: एआर (ऑगमेंटेड रिएलिटी) ज़रूरी है और एआर (ऑगमेंटेड रिएलिटी) वैकल्पिक. इस कैटगरी के आधार पर तय किया जाता है कि ऐप्लिकेशन, Google Play Services for AR ऐप्लिकेशन के साथ कैसे इंटरैक्ट करता है.

AR ज़रूरी ऐप्लिकेशन ARCore के बिना काम नहीं कर सकता है. इसके लिए ऐसे डिवाइस की ज़रूरत होती है जिस पर ARCore काम करता हो, जिस पर Google Play Services for AR इंस्टॉल किया गया हो.

• Google Play Store सिर्फ़ उन डिवाइस पर एआर के लिए ज़रूरी ऐप्लिकेशन उपलब्ध कराएगा जिन पर ARCore काम करता है.
• जब उपयोगकर्ता एआर के लिए ज़रूरी ऐप्लिकेशन इंस्टॉल करते हैं, तो Google Play Store उनके डिवाइस पर Google Play Services for AR अपने-आप इंस्टॉल कर देगा. हालांकि, अगर Google Play Services for AR पुराना हो गया है या उसे मैन्युअल तरीके से अनइंस्टॉल कर दिया गया है, तो आपके ऐप्लिकेशन को अब भी रनटाइम की अतिरिक्त जांच करनी होगी.

एआर (ऑगमेंटेड रिएलिटी) वैकल्पिक ऐप्लिकेशन, मौजूदा सुविधाओं को बेहतर बनाने के लिए ARCore का इस्तेमाल करता है. इसमें एआर (ऑगमेंटेड रिएलिटी) की वैकल्पिक सुविधाएं शामिल हैं. ये सुविधाएं सिर्फ़ उन डिवाइसों पर चालू होती हैं जिन पर ARCore काम करता है और उन पर Google Play Services for AR इंस्टॉल किया गया है.

• एआर (ऑगमेंटेड रिएलिटी) वाले वैकल्पिक ऐप्लिकेशन, उन डिवाइसों पर इंस्टॉल और चलाए जा सकते हैं जिन पर ARCore काम नहीं करता है.
• जब उपयोगकर्ता एआर (ऑगमेंटेड रिएलिटी) का कोई वैकल्पिक ऐप्लिकेशन इंस्टॉल करते हैं, तो Google Play Store आपके डिवाइस पर Google Play Services for 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 में बदलाव करें, ताकि कम से कम 24 का minSdkVersion तय किया जा सके:

 android {
     defaultConfig {
         …
         minSdkVersion 24
     }
 }

बिल्ड डिपेंडेंसी जोड़ें

1. पक्का करें कि आपके प्रोजेक्ट की build.gradle फ़ाइल में, Google की Maven रिपॉज़िटरी शामिल हो.

   allprojects {
       repositories {
           google()
           …
       }
   }
   

2. ARCore AAR फ़ाइल से शामिल की गई नेटिव लाइब्रेरी एक्सट्रैक्ट करने के लिए, अपने मॉड्यूल की build.gradle फ़ाइल में पसंद के मुताबिक कोई टास्क जोड़ें. इस तरह, उनका रेफ़रंस सीधे 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. एएआर फ़ाइल से नेटिव लाइब्रेरी कॉपी करने के लिए, कोई टास्क बनाएं और उसे बिल्ड डिपेंडेंसी में जोड़ें.

   // 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. लोकेशन को बाहरी बिल्ड टूल में भेजने के लिए, नेटिव बिल्ड फ़्लैग कॉन्फ़िगर करें.

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

रनटाइम की जांच करें

रनटाइम के दौरान, यह पक्का करें कि आपके ऐप्लिकेशन पर एआर (ऑगमेंटेड रिएलिटी) सुविधाएं ठीक से काम करें.

देखें कि ARCore काम करता है या नहीं

Android एनडीके ऐप्लिकेशन, Java ArCoreApk क्लास का इस्तेमाल कर सकता है, ताकि यह पता लगाया जा सके कि वह नेटिव C ARCore Session एपीआई के साथ काम करता है या नहीं. साथ ही, वह इसके साथ इंस्टॉलेशन को भी मैनेज कर सकता है या नहीं. आपके ऐप्लिकेशन के स्ट्रक्चर के आधार पर, यह 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.
  }
}

ArCoreApk_checkAvailability() को नेटवर्क संसाधनों से क्वेरी करनी पड़ सकती है, ताकि यह पता लगाया जा सके कि डिवाइस पर ARCore काम करता है या नहीं. इस दौरान, यह AR_AVAILABILITY_UNKNOWN_CHECKING दिखाएगा. इंतज़ार के समय और पॉप-इन को कम करने के लिए, ऐप्लिकेशन को लाइफ़ साइकल के शुरुआती दौर में एक बार ArCoreApk_checkAvailability() को कॉल करना चाहिए, ताकि क्वेरी शुरू की जा सके. इसमें, दी गई वैल्यू को अनदेखा किया जाता है. इस तरह, जब कोई एआर-एंटरिंग यूज़र इंटरफ़ेस (यूआई) एलिमेंट दिखता है, तो कैश मेमोरी में सेव किया गया नतीजा तुरंत उपलब्ध हो जाता है.

यह देखना कि Google Play Services for AR इंस्टॉल है या नहीं

एआर (ऑगमेंटेड रिएलिटी) ज़रूरी है और एआर (ऑगमेंटेड रिएलिटी) वैकल्पिक ऐप्लिकेशन, दोनों को ARCore सेशन बनाने से पहले ArCoreApk_requestInstall() को कॉल करना होगा. इससे यह जांच की जा सकेगी कि 'एआर के लिए Google Play Services' का वर्शन, उसके साथ काम करने वाला वर्शन (अब भी) इंस्टॉल है या नहीं. साथ ही, यह भी पक्का किया जाता है कि 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 Store पर पब्लिश करने के लिए, यह पक्का करें कि आपका ऐप्लिकेशन, ARCore की उपयोगकर्ता की निजता से जुड़ी ज़रूरी शर्तों का पालन करता हो.

आगे क्या होगा

• ARCore सेशन को कॉन्फ़िगर करने का तरीका जानें.