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

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

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

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

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

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

एआर (ऑगमेंटेड रिएलिटी) ज़रूरी है

<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. 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 काम करता है या नहीं

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

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

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

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

एआर (ऑगमेंटेड रिएलिटी) ज़रूरी और एआर (ऑगमेंटेड रिएलिटी) वैकल्पिक ऐप्लिकेशन को, 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 की उपयोगकर्ता की निजता से जुड़ी ज़रूरी शर्तों का पालन करता है.

आगे क्या होगा