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

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

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

अलग-अलग डिवाइसों में जगह बचाने के लिए, एआर की सभी सुविधाओं को 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 पुराना है या मैन्युअल तरीके से अनइंस्टॉल किया गया है, तो आपके ऐप्लिकेशन को रनटाइम के दौरान अन्य जांच करनी होंगी.

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

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

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

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

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

    allprojects {
    repositories {
        google()
        …
    }
}

  2. अपने ऐप्लिकेशन की build.gradle फ़ाइल में, डिपेंडेंसी के तौर पर ARCore की नई लाइब्रेरी जोड़ें.

    dependencies {
    …
    implementation 'com.google.ar:core:1.33.0'
}

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

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

देखें कि आपके डिवाइस पर ARCore काम करता है या नहीं

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

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 इंस्टॉल हो, लेकिन जिन डिवाइसों पर यह काम नहीं करता उन पर उपयोगकर्ता किसी बाहरी सोर्स से इसे इंस्टॉल कर सकते हैं. ArCoreApk.checkAvailability() या ArCoreApk.checkAvailabilityAsync() का इस्तेमाल करने पर, ARCore काम करता है या नहीं, यह पता करने से एक जैसा अनुभव मिलता है.

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

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

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

कैमरे की अनुमति का अनुरोध करना

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

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

अब क्या होगा