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

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

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

अलग-अलग डिवाइसों पर जगह बचाने के लिए, सभी एआर (ऑगमेंटेड रिएलिटी) सुविधाएं 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 को अपने-आप इंस्टॉल नहीं करेगा.

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

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

अपने Android Studio प्रोजेक्ट में ARCore जोड़ने के लिए, यह तरीका अपनाएं:

पक्का करें कि आपके प्रोजेक्ट की build.gradle फ़ाइल में, Google की Maven रिपॉज़िटरी शामिल हो.
```
allprojects {
    repositories {
        google()
        …
    }
}
```
अपने ऐप्लिकेशन की build.gradle फ़ाइल में, डिपेंडेंसी के तौर पर नई ARCore लाइब्रेरी को जोड़ें.
```
dependencies {
    …
    implementation 'com.google.ar:core:1.33.0'
}
```

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

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

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

एआर (ऑगमेंटेड रिएलिटी) ज़रूरी है और एआर (ऑगमेंटेड रिएलिटी) (एआर) वैकल्पिक ऐप्लिकेशन, ArCoreApk.checkAvailability() या ArCoreApk.checkAvailabilityAsync(), दोनों का इस्तेमाल करेंगे, ताकि यह पता लगाया जा सके कि मौजूदा डिवाइस पर ARCore काम करता है या नहीं. 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 for AR, आपके ज़रूरी एआर (ऑगमेंटेड रिएलिटी) ऐप्लिकेशन के साथ-साथ इंस्टॉल है, लेकिन जिन लोगों के डिवाइस पर यह ऐप्लिकेशन काम नहीं करता वे इसे किसी बाहरी सोर्स से इंस्टॉल कर सकते हैं. ARCore की सुविधा के बारे में पता करने के लिए, ArCoreApk.checkAvailability() या ArCoreApk.checkAvailabilityAsync() का इस्तेमाल करने पर, आपको लगातार एक जैसा अनुभव मिलेगा.

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

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

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

कैमरा ऐक्सेस करने की अनुमति के लिए अनुरोध करना

एआर (ऑगमेंटेड रिएलिटी) वैकल्पिक और एआर (ऑगमेंटेड रिएलिटी) ज़रूरी ऐप्लिकेशन, दोनों को यह पक्का करना होगा कि एआर सेशन बनाने से पहले कैमरा इस्तेमाल करने की अनुमति दी गई है.

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() लागू होना चाहिए.

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 Store पर पब्लिश करने के लिए, यह पक्का करें कि आपका ऐप्लिकेशन, ARCore की उपयोगकर्ता की निजता से जुड़ी ज़रूरी शर्तों का पालन करता हो.

आगे क्या होगा

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