ARCore चालू करें

इस पेज पर, आपके Android Studio प्रोजेक्ट में ARCore फ़ंक्शन को चालू करने का तरीका बताया गया है. ऐसा करने के लिए, ये गतिविधियां ज़रूरी हैं:

  1. अपने ऐप्लिकेशन के लिए एआर (ऑगमेंटेड रिएलिटी) और एआर (ऑगमेंटेड रिएलिटी) के बीच विकल्प चुनना
  2. अपने ऐप्लिकेशन के मेनिफ़ेस्ट में एआर (ऑगमेंटेड रिएलिटी) या एआर (ऑगमेंटेड रिएलिटी) की ज़रूरी एंट्री जोड़ना
  3. अपने प्रोजेक्ट में बिल्ड डिपेंडेंसी जोड़ना
  4. रनटाइम में जांच करें और पक्का करें कि:
    • डिवाइस ARCore के साथ काम करता है,
    • Google Play Services for AR उन पर इंस्टॉल किया जाता है,
    • कैमरे की अनुमति दे दी गई है.
  5. पक्का करें कि आपका ऐप्लिकेशन ARCore'उपयोगकर्ता की निजता से जुड़ी ज़रूरी शर्तों का पालन करता हो

एआर (ऑगमेंटेड रिएलिटी) ज़रूरी है या एआर (ऑगमेंटेड रिएलिटी) का विकल्प चुनना ज़रूरी नहीं है

एआर (ऑगमेंटेड रिएलिटी) सुविधाओं के साथ काम करने वाले ऐप्लिकेशन को दो तरीकों से कॉन्फ़िगर किया जा सकता है: एआर (ऑगमेंटेड रिएलिटी) और एआर (ऑगमेंटेड रिएलिटी) ज़रूरी नहीं.

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

  • Google Play Store, AR ज़रूरी ऐप्लिकेशन को सिर्फ़ ARCore की सुविधा वाले डिवाइसों पर उपलब्ध कराता है.

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

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

  • AR वैकल्पिक ऐप्लिकेशन इंस्टॉल किए जा सकते हैं और ऐसे डिवाइस पर चलाए जा सकते हैं जिन पर ARCore काम नहीं करता.

  • जब उपयोगकर्ता किसी एआर (ऑगमेंटेड रिएलिटी) ऐप्लिकेशन को इंस्टॉल करते हैं, तो Google Play स्टोर, उस ऐप्लिकेशन से Google Play Services for AR को अपने-आप इंस्टॉल नहीं करता.

एआर (ऑगमेंटेड रिएलिटी) ज़रूरी हैएआर (ऑगमेंटेड रिएलिटी) ज़रूरी नहीं है
एआर (ऑगमेंटेड रिएलिटी) सुविधा का इस्तेमाल बुनियादी फ़ंक्शन के लिए आपके ऐप्लिकेशन को ARCore की ज़रूरत है. ARCore आपके ऐप्लिकेशन की सुविधा को बेहतर बनाता है. आपका ऐप्लिकेशन ARCore सहायता के बिना चल सकता है.
'Play Store' पर किसको दिखाई दे आपका ऐप्लिकेशन सिर्फ़ ARCore की सुविधा वाले डिवाइसों पर 'Play स्टोर' में मौजूद है. आपका ऐप्लिकेशन, लिस्टिंग की सामान्य प्रक्रियाओं का पालन करता है.
एआर (ऑगमेंटेड रिएलिटी) के लिए Google Play सेवाएं इंस्टॉल करने का तरीका Play Store, आपके ऐप्लिकेशन के साथ-साथ एआर (ऑगमेंटेड रिएलिटी) के लिए Google Play सेवाएं इंस्टॉल करता है. आपका ऐप्लिकेशन ARCore डाउनलोड और इंस्टॉल करने के लिए ArCoreApk.requestInstall() का इस्तेमाल करता है.
Android की minSdkVersion ज़रूरी शर्तें Android 7.0 (एपीआई लेवल 24) Android 4.0 (एपीआई लेवल 14)
ARCore की सहायता और इंस्टॉल की स्थिति देखने के लिए, ArCoreApk.checkAvailability() का इस्तेमाल करना चाहिए
एआर (ऑगमेंटेड रिएलिटी) के लिए Google Play सेवाएं इंस्टॉल करने के लिए ArCoreApk.requestInstall() का इस्तेमाल करना ज़रूरी है

ज़्यादा जानकारी के लिए, Google Play Store में 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>

इसके बाद, पक्का करें कि आपके ऐप्लिकेशन में आपके app's build.gradle में कम से कम ज़रूरी minSdkVersion हो:

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

android {
    defaultConfig {
        …
        minSdkVersion 24
    }
}

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

android {
    defaultConfig {
        …
        minSdkVersion 14
    }
}

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

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

  • पक्का करें कि आपके Project's build.gradle फ़ाइल में Google's Maven डेटा संग्रह स्थान शामिल है:

    allprojects {
        repositories {
            google()
            …
        }
    }
    
  • अपनी app's build.gradle फ़ाइल में, डिपेंडेंसी के तौर पर नई ARCore लाइब्रेरी जोड़ें:

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

रनटाइम के दौरान जांच करें

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

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

Java

@Override
protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);

  // Enable AR-related functionality on ARCore supported devices only.
  maybeEnableArButton();
  …
}

void maybeEnableArButton() {
  ArCoreApk.Availability availability = ArCoreApk.getInstance().checkAvailability(this);
  if (availability.isTransient()) {
    // Continue to query availability at 5Hz while compatibility is checked in the background.
    new Handler().postDelayed(new Runnable() {
      @Override
      public void run() {
        maybeEnableArButton();
      }
    }, 200);
  }
  if (availability.isSupported()) {
    mArButton.setVisibility(View.VISIBLE);
    mArButton.setEnabled(true);
  } else { // The device is unsupported or unknown.
    mArButton.setVisibility(View.INVISIBLE);
    mArButton.setEnabled(false);
  }
}

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {
  super.onCreate(savedInstanceState)

  // Enable AR-related functionality on ARCore supported devices only.
  maybeEnableArButton()
  …
}

fun maybeEnableArButton() {
  val availability = ArCoreApk.getInstance().checkAvailability(this)
  if (availability.isTransient) {
    // Continue to query availability at 5Hz while compatibility is checked in the background.
    Handler().postDelayed({
      maybeEnableArButton()
    }, 200)
  }
  if (availability.isSupported) {
    mArButton.visibility = View.VISIBLE
    mArButton.isEnabled = true
  } else { // The device is unsupported or unknown.
    mArButton.visibility = View.INVISIBLE
    mArButton.isEnabled = false
  }
}

हालांकि, AR के लिए Google Play सेवाएं आपके AR ज़रूरी ऐप्लिकेशन के साथ इंस्टॉल है, लेकिन इसके साथ काम न करने वाले डिवाइस वाले उपयोगकर्ता इसे बाहरी स्रोत से इंस्टॉल कर सकते हैं. ARCore की सहायता की जांच करने के लिए, checkAvailability() का इस्तेमाल करने से यह पक्का होता है कि उपयोगकर्ता को एक जैसा अनुभव मिलेगा.

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

कैमरा इस्तेमाल करने की अनुमति मांगें

AR वैकल्पिक और AR ज़रूरी है ऐप्लिकेशन को यह पक्का करना होगा कि एआर (ऑगमेंटेड रिएलिटी) सेशन बनाने से पहले कैमरे की अनुमति मिल गई है. hello_ar_java के नमूने में एक CameraPermissionHelper क्लास शामिल है, जिसे आपके प्रोजेक्ट में कॉपी किया जा सकता है. साथ ही, इसे आपके एआर (ऑगमेंटेड रिएलिटी) गतिविधि से #39; onResume() तरीके से कॉल किया जा सकता है:

Java

@Override
protected void onResume() {
  super.onResume();

  // ARCore requires camera permission to operate.
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    CameraPermissionHelper.requestCameraPermission(this);
    return;
  }

  …
}

Kotlin

override fun onResume() {
  super.onResume()

  // ARCore requires camera permission to operate.
  if (!CameraPermissionHelper.hasCameraPermission(this)) {
    CameraPermissionHelper.requestCameraPermission(this)
    return
  }

  …
}

आपकी एआर गतिविधि को onRequestPermissionsResult() भी लागू करना होगा, जैसा कि HelloArActivity में देखा गया है:

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();
  }
}

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

देखें कि एआर (ऑगमेंटेड रिएलिटी) के लिए Google Play सेवाएं इंस्टॉल हैं या नहीं

यह देखने के लिए कि ARCore के लिए 'Google Play सेवाएं' का वर्शन (अब भी) इंस्टॉल है या नहीं. साथ ही, यह भी पक्का करें कि ARCore डिवाइस प्रोफ़ाइल का डेटा डाउनलोड हो गया है या नहीं, ARCore और एआर (ऑगमेंटेड रिएलिटी) ऐप्लिकेशन, दोनों को ARCore सेशन बनाने से पहले ArCoreApk.requestInstall() को कॉल करना चाहिए. इससे उपयोगकर्ता को ज़रूरत पड़ने पर ARCore इंस्टॉल या अपडेट करने की सूचना मिलती है. साथ ही, यह भी पक्का होता है कि ARCore डिवाइस प्रोफ़ाइल का डेटा डाउनलोड किया जा चुका है.

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

// 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.
  }
  …
}

उपयोगकर्ता की निजता से जुड़ी ज़रूरी शर्तों का पालन करना

पक्का करें कि आपका ऐप्लिकेशन ARCore' उपयोगकर्ता की निजता से जुड़ी ज़रूरी शर्तों का पालन करता हो.

अगले चरण