Setup Guide
1. Build Android Development Environment
2. Generate LIcense Key
3. Install MAXST AR SDK for Android
3.1 AddMaxstARSDK on Android Studio
3.2 Gradle Configuration
3.3 Add permission to AndroidManifest
4. Apply MAXST AR SDK
1. Build Android Development Environment
Requirements
- ‘MAXST AR SDK' supports ‘Android OS 8.0, API Level 26' or later.
- Prerequisite knowledge of Android development is required to use MAXST AR SDK for Android
In order to build development environment, download the following:
2. Generate License Key
License key is generated with its own unique code based on the title of the app's package.
When receiving a new license key, or to change an app's package, you need to receive a new license key for the specific package.
Receive the license key at License Manager
※ When the license key is generated, ID generated on License Manager and the Android project title of the package needs to be identical
3. Install MAXST AR SDK for Android
‘MAXST AR SDK for Android' is distributed as a ZIP file.
Installation process
Extract the SDK zip file to the desired path. (e.g. C:\Workspace\MaxstARSDKAndroid)
3.1 AddMaxstARSDK on Android Studio
Created based on Android Studio Electric Eel
- Copy MaxstAR.aar file on a desired location (ex app/MaxstAR)
3.2 Gradle Configuration
Edit build.gradle on a new project
Edit dependency
- Add implementation files("MaxstAR/MaxstAR.aar")
- Add implementation 'com.google.ar:core:1.16.0'
Set to minSdkVersion 26 from defaultConfig
3.3 Add permission to AndroidManifest
MaxsARSDK asks for a permission to access camera, internet and storage.
android.permission.CAMERA android.permission.INTERNET android.permission.WRITE_EXTERNAL_STORAGE
4. Apply MAXST AR SDK
Operate tracker from the selected tutorial after combining MaxstAR to LifeCycle of the Activity that you wish to operate.
※ Correct license key must be entered to Maxst.init() function to activate properly.
Refer to API Reference for each functions' guideline.
※ When incorrect license key is entered, Invalid Signature will appear as watermark, and target tracking and AR contents rendering will fail to operate.
@Override protected void onCreate(Bundle savedInstanceState) { MaxstAR.init(getApplicationContext(), "your license key"); MaxstAR.setScreenOrientation(getResources().getConfiguration().orientation); } @Override protected void onResume() { MaxstAR.onResume() } @Override protected void onResume() { MaxstAR.onPause() } @Override protected void onDestroy() { MaxstAR.deinit() } @Override public void onConfigurationChanged(Configuration newConfig) { MaxstAR.setScreenOrientation(newConfig.orientation); }
SurfaceView Renderer의 onSurfaceChanged함수에 아래와 같이 추가합니다.
@Override public void onSurfaceChanged(GL10 unused, int width, int height) { MaxstAR.onSurfaceChanged(width, height); }
5. 샘플 앱 이슈
Issue 1 :
The project is using an incompatible version (AGP x.x.x) of the Android Gradle plugin. Latest supported version is AGP x.x.x
Reason:
Android Gradle plugin and Android Studio compatibility issue
Checklist:
1-1. On the File > Project Structure > Project tab, modify the Android Gradle Plugin Version and Gradle Version supported by the installed Android Studio.