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

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

अपने ऐप्लिकेशन को एआर की सुविधा के साथ काम करने वाला या एआर की सुविधा के बिना काम करने वाला ऐप्लिकेशन के तौर पर कॉन्फ़िगर करना

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

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

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

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

  • AR Optional ऐप्लिकेशन को उन डिवाइसों पर इंस्टॉल और चलाया जा सकता है जिन पर ARCore काम नहीं करता.
  • जब उपयोगकर्ता, एआर की सुविधा वाला कोई ऐप्लिकेशन इंस्टॉल करते हैं, तो Google Play Store, डिवाइस पर Google Play Services for AR को अपने-आप इंस्टॉल नहीं करेगा.
AR Requiredएआर की सुविधा ज़रूरी नहीं है
एआर की सुविधा का इस्तेमाल आपके ऐप्लिकेशन को बुनियादी सुविधाओं के लिए ARCore की ज़रूरत है. ARCore, आपके ऐप्लिकेशन की सुविधाओं को बेहतर बनाता है. ARCore की सुविधा के बिना भी आपका ऐप्लिकेशन काम कर सकता है.
Play Store पर दिखने के हिसाब से फ़िल्टर करें आपका ऐप्लिकेशन, Play Store में सिर्फ़ ARCore के साथ काम करने वाले डिवाइसों पर दिखता है. आपका ऐप्लिकेशन, सामान्य लिस्टिंग की प्रक्रियाओं का पालन करता हो.
Google Play Services for AR को इंस्टॉल करने का तरीका Play Store, आपके ऐप्लिकेशन के साथ-साथ Google Play Services for AR को भी इंस्टॉल करता है. आपका ऐप्लिकेशन, ARCore को डाउनलोड और इंस्टॉल करने के लिए ArCoreApk.requestInstall() का इस्तेमाल करता है.
Android minSdkVersion के लिए ज़रूरी शर्तें Android 7.0 (एपीआई लेवल 24) Android 4.4 (एपीआई लेवल 19). हालांकि, एआर की किसी भी सुविधा को चलाने के लिए, कम से कम Android 7.0 (एपीआई लेवल 24) की ज़रूरत होती है
ARCore की सुविधा काम करती है या नहीं और इंस्टॉल करने का स्टेटस देखने के लिए, ArCoreApk_checkAvailability() या ArCoreApk_checkAvailabilityAsync() का इस्तेमाल करना ज़रूरी है
Google Play Services for AR इंस्टॉल करने के लिए, ArCoreApk.requestInstall() का इस्तेमाल करना ज़रूरी है

अपने ऐप्लिकेशन को एआर की सुविधा ज़रूरी है या एआर की सुविधा वैकल्पिक है के तौर पर सेट करने के लिए, AndroidManifest.xml को अपडेट करें. इसमें ये एंट्री शामिल करें:

AR Required

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

    // 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 की सुविधा उपलब्ध है या नहीं

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

Android NDK ऐप्लिकेशन, Java ArCoreApk क्लास का इस्तेमाल करके, यह देख सकता है कि वह ARCore Session API के नेटिव C वर्शन के साथ काम करता है या नहीं. साथ ही, वह इसे इंस्टॉल करने की प्रोसेस को मैनेज कर सकता है. आपके ऐप्लिकेशन के स्ट्रक्चर के हिसाब से, 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.
  }
}
Google Play Services for AR, एआर की सुविधा वाले ऐप्लिकेशन के साथ इंस्टॉल होता है. हालांकि, जिन उपयोगकर्ताओं के डिवाइस पर यह सुविधा काम नहीं करती वे इसे किसी बाहरी सोर्स से इंस्टॉल कर सकते हैं. ARCore की सुविधा की जांच करने के लिए, ArCoreApk_checkAvailability() या ArCoreApk_checkAvailabilityAsync() का इस्तेमाल करने से, एक जैसा अनुभव मिलता है.

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

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

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

अब क्या होगा