Before using any class from the ARDK, the first step is to call the function GiPStechAR.init. This function requires the GiPStech development key, which is linked to the package name (Android) and/or the bundle identifier (iOS) of the app. To obtain a development key, please contact GiPStech (opens in a new tab). On Android, this function also requires a valid Android Context.
Activation
Section titled “Activation”The ARDK operates without requiring an internet connection, allowing the location system to function even when the device is offline.
However, internet access is necessary to activate the library. The activation is typically valid for one month and is automatically renewed whenever an internet connection is available.
Check AR availability
Section titled “Check AR availability”On Android, call GiPStechAR.checkAvailability before initializing the ARDK or enabling AR features, passing a valid Android Context, such as context.applicationContext. The method is suspending, so call it from a coroutine or another suspending function:
val availability = GiPStechAR.checkAvailability(context.applicationContext)Use availability.isAvailable() to determine whether the AR runtime is ready to use. availability.isSupported() alone is not sufficient: a supported Android device may still need Google Play Services for AR to be installed or updated. Handle unavailable or unknown results before proceeding; the check does not install or update Google Play Services for AR.
Make sure the Android app’s manifest includes the ARCore metadata described in the installation guide.
On iOS, this check is optional: all iPhone models compatible with the ARDK’s minimum supported iOS version (iOS 15) support ARKit. The method is also available on iOS and can be called without a context:
val availability = GiPStechAR.checkAvailability()The current iOS implementation returns Availability.ARKIT_SUPPORTED. This status does not verify support for individual ARKit features or camera permissions.
App version
Section titled “App version”You can optionally send your app version to the GiPStech server using GiPStechRI.setAppVersion. This call must be made before initialization.
This enables GiPStech to identify the version of the app in use and, if necessary, revoke the license for outdated versions when misuse or security issues are detected.
Using this function is highly recommended.
Releasing resources
Section titled “Releasing resources”To free all resources, call the function GiPStechAR.shutdown. This should be done when the application is closing or when GiPStech services are no longer needed.
Best Practice
Section titled “Best Practice”On Android, check AR availability before initialization. Once AR is available, call GiPStechAR.init when the application starts and GiPStechAR.shutdown just before the application is destroyed.