User Guide on Android (Java & Kotlin)

System Requirements:
- Supported OS: Android 5 or higher (Android 7 or higher recommended).
- Supported ABI: arm64-v8a/armeabi-v7a/x86/x86_64.

Installation

Download Dynamsoft Camera Enhancer to get dce-android-{version-number}.zip. Unzip the package to find DynamsoftCameraEnhancerAndroid.aar.
Create a new Android project in Android Studio.
Put the .aar file under the dictionary /app/libs in your project.

Add the following code into build.gradle(Module: app).

 repositories {
     flatDir {
         dirs 'libs'
     }
 }

Also in build.gradle(Module: app) add the reference in dependencies:

     implementation(name: 'DynamsoftCameraEnhancerAndroid', ext: 'aar')

Sync the project with Gradle, then, DynamsoftCameraEnhancerAndroid.aar is added to your project.

Create a Camera Module

This section is a guide on using Dynamsoft Camera Enhancer to create a simple camera app after installation.

Keep working on the project that you have installed DCE. In the project, create a CameraView section in activity_main.xml.

     <com.dynamsoft.dce.CameraView
         android:id="@+id/cameraView"
         android:layout_width="match_parent"
         android:layout_height="match_parent"
         tools:layout_editor_absoluteX="25dp"
         tools:layout_editor_absoluteY="0dp" />

Set up for your camera in the cameraView section. Please add the following code in your activity for the camera. The following code is an example of setting camera view in MainActivity

Java:

 import com.dynamsoft.dce.CameraEnhancer;
 import com.dynamsoft.dce.CameraState;
 import com.dynamsoft.dce.CameraView;
 public class MainActivity extends AppCompatActivity {
     CameraEnhancer mCameraEnhancer;
     CameraView cameraView;
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);    
         setContentView(R.layout.activity_main);
         cameraView = findViewById(R.id.cameraView);
         mCameraEnhancer = new CameraEnhancer(MainActivity.this);
         mCameraEnhancer.addCameraView(cameraView);
         //Initialize your license
         com.dynamsoft.dce.DMLTSConnectionParameters info = new com.dynamsoft.dce.DMLTSConnectionParameters();
         info.organizationID = "Put your organizationID here.";
         mCameraEnhancer.initLicenseFromLTS(info,new CameraLTSLicenseVerificationListener() {
             @Override
             public void LTSLicenseVerificationCallback(boolean isSuccess, Exception error) {
                 if(!isSuccess){
                     error.printStackTrace();
                 }
             }
         });
         //Turn on the camera
         mCameraEnhancer.setCameraDesiredState(CameraState.CAMERA_STATE_ON);
         //Start scanning
         mCameraEnhancer.startScanning();
     }
 }

Kotlin:

 import com.dynamsoft.dce.CameraEnhancer
 import com.dynamsoft.dce.CameraState
 import com.dynamsoft.dce.CameraView

 class MainActivity : AppCompatActivity() {
     var cameraView: CameraView? = null
     var mCameraEnhancer: CameraEnhancer? = null
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
         cameraView = findViewById(R.id.cameraView)
         mCameraEnhancer = CameraEnhancer(this@MainActivity)
         mCameraEnhancer!!.addCameraView(cameraView)
         //Initialize DCE from License Tracking Server
         val info = com.dynamsoft.dce.DMLTSConnectionParameters()
         info.organizationID = "Put your organizationID here."
         mCameraEnhancer!!.initLicenseFromLTS(info) { isSuccess, error ->
             if (!isSuccess) {
                 error.printStackTrace()
             }
         }
         mCameraEnhancer!!.setCameraDesiredState(CameraState.CAMERA_STATE_ON)
         mCameraEnhancer!!.startScanning()
     }
 }

Run the project. Now your camera module is running. If you have any questions about the program, you can view the samples we provided in the package you download to get a better understanding of how it works. Also, you can get help from our online customer service.

Extend the camera module with DCE functions

This is a template for users to add DCE camera settings into the newly built camera module.

Java:

import com.dynamsoft.dce.CameraEnhancer;
import com.dynamsoft.dce.CameraState;
import com.dynamsoft.dce.CameraView;
public class MainActivity extends AppCompatActivity {
    CameraEnhancer mCameraEnhancer;
    CameraView cameraView;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);    
        setContentView(R.layout.activity_main);
        cameraView = findViewById(R.id.cameraView);
        mCameraEnhancer = new CameraEnhancer(MainActivity.this);
        mCameraEnhancer.addCameraView(cameraView);
        com.dynamsoft.dce.DMLTSConnectionParameters info = new com.dynamsoft.dce.DMLTSConnectionParameters();
        info.organizationID = "Put your organizationID here.";
        mCameraEnhancer.initLicenseFromLTS(info,new CameraLTSLicenseVerificationListener() {
            @Override
            public void LTSLicenseVerificationCallback(boolean isSuccess, Exception error) {
                if(!isSuccess){
                    error.printStackTrace();
                }
            }
        });
        mCameraEnhancer.setCameraDesiredState(CameraState.CAMERA_STATE_ON);
        mCameraEnhancer.startScanning();
        //**************The Following parts are newly added*******************
        //Make device level evaluation on the current device
        //User can set parameters for device level evaluation via API `setAutoModeLevelParam`         
        int level = mCameraEnhancer.getDeviceLevel();
        boolean frame_filter = true;
        boolean auto_focus = true;
        if (level == 2) {
            //Disable both autofocus and frame filter on high-level device
            frame_filter = false;
            auto_focus = false;
        }else if (level == 1) {
            //Disable autofocus on mid-level devices
            auto_focus = false;
        }
        mCameraEnhancer.enableDCEAutoFocus(auto_focus);
        mCameraEnhancer.enableFrameFilter(frame_filter);
        //Enable sensor control & fast mode
        mCameraEnhancer.enableSensorControl(true);        
        mCameraEnhancer.enableFastMode(true);
    }
}

Kotlin:

import com.dynamsoft.dce.CameraEnhancer
import com.dynamsoft.dce.CameraState
import com.dynamsoft.dce.CameraView

class MainActivity : AppCompatActivity() {
    var cameraView: CameraView? = null
    var mCameraEnhancer: CameraEnhancer? = null
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        cameraView = findViewById(R.id.cameraView)
        mCameraEnhancer = CameraEnhancer(this@MainActivity)
        mCameraEnhancer!!.addCameraView(cameraView)
        //Initialize DCE from License Tracking Server
        val info = com.dynamsoft.dce.DMLTSConnectionParameters()
        info.organizationID = "Put your organizationID here."
        mCameraEnhancer!!.initLicenseFromLTS(info) { isSuccess, error ->
            if (!isSuccess) {
                error.printStackTrace()
            }
        }
        mCameraEnhancer!!.setCameraDesiredState(CameraState.CAMERA_STATE_ON)
        mCameraEnhancer!!.startScanning()
        //**************The Following parts are newly added*******************
        //Make device level evaluation on the current device
        //User can set parameters for device level evaluation via API `setAutoModeLevelParam` 
        val level = mCameraEnhancer!!.deviceLevel
        var frame_filter = true
        var auto_focus = true
        if (level == 2) {
            //Disable both autofocus and frame filter on high-level device
            frame_filter = false
            auto_focus = false
        } else if (level == 1) {
            //Disable autofocus on mid-level devices
            auto_focus = false
        }
        mCameraEnhancer!!.enableDCEAutoFocus(auto_focus)
        mCameraEnhancer!!.enableFrameFilter(frame_filter)
        //Enable sensor control & fast mode
        mCameraEnhancer!!.enableSensorControl(true)
        mCameraEnhancer!!.enableFastMode(true)
    }
}

Run the project. Now some DCE functions have been added to the camera module.

Add decoder to the camera module

This section is the guide for users to add a video stream decoder in the camera module. In this section, Dynamsoft Barcode Reader (DBR) will handle the decoding.

Remember to add DynamsoftBarcodeReaderAndroid.aar to your project. Put the aar file under the dictionary /app/libs and add the following code to the build.gradle(Module: app).
```
     implementation(name: 'DynamsoftCameraEnhancerAndroid', ext: 'aar')
```

Add a new text view for the camera module. In the text view, there will be decode results if the project is running successfully.

     <com.dynamsoft.dce.CameraView
     android:id="@+id/cameraView"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     tools:layout_editor_absoluteX="25dp"
     tools:layout_editor_absoluteY="0dp" />
     <!--Add this TextView-->
     <TextView
         android:id="@+id/tv_res"
         android:layout_width="match_parent"
         android:layout_height="200dp"
         android:layout_marginTop="430dp"
         android:textSize="16sp"
         android:gravity="center"
         android:scrollbars="vertical"
         android:textColor="@color/white"
         android:visibility="visible"/>
     <!---->

Add the following code to the project in the main activity:

Java:

 import com.dynamsoft.dbr.BarcodeReader;
 import com.dynamsoft.dbr.BarcodeReaderException;
 import com.dynamsoft.dbr.DBRLTSLicenseVerificationListener;
 import com.dynamsoft.dbr.DCESettingParameters;
 import com.dynamsoft.dbr.TextResultCallback;
 import com.dynamsoft.dbr.TextResult;
 import com.dynamsoft.dce.CameraEnhancer;
 import com.dynamsoft.dce.CameraLTSLicenseVerificationListener;
 import com.dynamsoft.dce.CameraView;

 public class MainActivity extends AppCompatActivity {
     CameraView cameraView;            
     CameraEnhancer mCameraEnhancer;
     //************Newly added code***************
     TextResultCallback mTextResultCallback;
     BarcodeReader reader;
     TextView tvRes;
     //*******************************************
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
         cameraView = findViewById(R.id.cameraView);
                
         //**This line is newly added**
         tvRes = findViewById(R.id.tv_res);
         //****************************
         mCameraEnhancer = new CameraEnhancer(MainActivity.this);
         mCameraEnhancer.addCameraView(cameraView);
         //Initialize DCE from License Tracking Server
         com.dynamsoft.dce.DMLTSConnectionParameters info = new com.dynamsoft.dce.DMLTSConnectionParameters();
         info.organizationID = "Put your organizationID here.";
         mCameraEnhancer.initLicenseFromLTS(info,new CameraLTSLicenseVerificationListener() {
             @Override
             public void LTSLicenseVerificationCallback(boolean isSuccess, Exception error) {
                 if(!isSuccess){ error.printStackTrace(); }
             }
         });
         mCameraEnhancer.setCameraDesiredState(CameraState.CAMERA_STATE_ON);
         mCameraEnhancer.startScanning();

         //Make device level evaluation on the current device
         //User can set parameters for device level evaluation via API `setAutoModeLevelParam`         
         int level = mCameraEnhancer.getDeviceLevel();
         boolean frame_filter = true;
         boolean auto_focus = true;
         if (level == 2) {
             //Disable both autofocus and frame filter on high-level device
             frame_filter = false;
             auto_focus = false;
         }else if (level == 1) {
             //Disable autofocus on mid-level devices
             auto_focus = false;
         }
         mCameraEnhancer.enableDCEAutoFocus(auto_focus);
         mCameraEnhancer.enableFrameFilter(frame_filter);
         //Enable sensor control & fast mode
         mCameraEnhancer.enableSensorControl(true);        
         mCameraEnhancer.enableFastMode(true);

         //******************The following parts are newly added******************************
         //Initialize Dynamsoft Barcode Reader from License Tracking Server
         try {
             reader = new BarcodeReader();
             com.dynamsoft.dbr.DMLTSConnectionParameters parameters = new com.dynamsoft.dbr.DMLTSConnectionParameters();
             parameters.organizationID = "Put your organizationID here.";
             reader.initLicenseFromLTS(parameters, new DBRLTSLicenseVerificationListener() {
                 @Override
                 public void LTSLicenseVerificationCallback(boolean b, Exception e) {
                     if (!b) { e.printStackTrace(); }
                 }
             });
         } catch (BarcodeReaderException e) {
             e.printStackTrace();
         }
         //Get the text result from Dynamsoft Barcode Reader
         mTextResultCallback = new TextResultCallback() {
             @Override
             public void textResultCallback(int i, TextResult[] textResults, Object o) {
                 showResult(textResults);
             }
         };                
         //Set DCE setting parameters in Dynamsoft Barcode Reader
         DCESettingParameters dceSettingParameters = new DCESettingParameters();
         dceSettingParameters._cameraInstance = mCameraEnhancer;
         dceSettingParameters._textResultCallback = mTextResultCallback;
         //Instantiate DCE, send result and immediate result call back to Dynamsoft Barcode Reader
         reader.SetCameraEnhancerParam(dceSettingParameters);
     }
     //Start DCE on resume
     @Override
     public void onResume() {
         reader.StartCameraEnhancer();
         super.onResume();
     }
     //Stop DCE on pause
     @Override
     public void onPause() {
         reader.StopCameraEnhancer();
         super.onPause();
     }
     //This is the function for displaying decode result on the screen
     private void showResult(TextResult[] results) {
         if (results != null && results.length > 0) {
             String strRes = "";
             for (int i = 0; i < results.length; i++)
                 strRes += results[i].barcodeText + "\n\n";
             tvRes.setText(strRes);
         }
     }
 }

Kotlin:

 import com.dynamsoft.dbr.TextResultCallback
 import com.dynamsoft.dbr.BarcodeReader
 import com.dynamsoft.dcesimplesample.R
 import com.dynamsoft.dbr.DBRLTSLicenseVerificationListener
 import com.dynamsoft.dbr.BarcodeReaderException
 import com.dynamsoft.dbr.TextResult
 import com.dynamsoft.dbr.DCESettingParameters
 import com.dynamsoft.dbr.DMLTSConnectionParameters

 class MainActivity : AppCompatActivity() {
     var cameraView: CameraView? = null
     var mCameraEnhancer: CameraEnhancer? = null

     //************Newly added code***************
     var mTextResultCallback: TextResultCallback? = null
     var reader: BarcodeReader? = null
     var tvRes: TextView? = null

     //*******************************************
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
         cameraView = findViewById(R.id.cameraView)

         //**This line is newly added**
         tvRes = findViewById(R.id.tv_res)
         //****************************
         mCameraEnhancer = CameraEnhancer(this@MainActivity)
         mCameraEnhancer!!.addCameraView(cameraView)
         //Initialize DCE from License Tracking Server
         val info = com.dynamsoft.dce.DMLTSConnectionParameters()
         info.organizationID = "Put your organizationID here."
         mCameraEnhancer!!.initLicenseFromLTS(info) { isSuccess, error ->
             if (!isSuccess) {
                 error.printStackTrace()
             }
         }
         mCameraEnhancer!!.setCameraDesiredState(CameraState.CAMERA_STATE_ON)
         mCameraEnhancer!!.startScanning()

         //Make device level evaluation on the current device
         //User can set parameters for device level evaluation via API `setAutoModeLevelParam`
         val level = mCameraEnhancer!!.deviceLevel
         var frame_filter = true
         var auto_focus = true
         if (level == 2) {
             //Disable both autofocus and frame filter on high-level device
             frame_filter = false
             auto_focus = false
         } else if (level == 1) {
             //Disable autofocus on mid-level devices
             auto_focus = false
         }
         mCameraEnhancer!!.enableDCEAutoFocus(auto_focus)
         mCameraEnhancer!!.enableFrameFilter(frame_filter)
         //Enable sensor control & fast mode
         mCameraEnhancer!!.enableSensorControl(true)
         mCameraEnhancer!!.enableFastMode(true)

         //******************The following parts are newly added******************************
         //Initialize Dynamsoft Barcode Reader from License Tracking Server
         try {
             reader = BarcodeReader()
             val parameters = DMLTSConnectionParameters()
             parameters.organizationID = "Put your organizationID here."
             reader!!.initLicenseFromLTS(parameters) { b, e ->
                 if (!b) {
                     e.printStackTrace()
                 }
             }
         } catch (e: BarcodeReaderException) {
             e.printStackTrace()
         }
         //Get the text result from Dynamsoft Barcode Reader
         mTextResultCallback = TextResultCallback { i, textResults, o -> showResult(textResults) }
         //Set DCE setting parameters in Dynamsoft Barcode Reader
         val dceSettingParameters = DCESettingParameters()
         dceSettingParameters._cameraInstance = mCameraEnhancer
         dceSettingParameters._textResultCallback = mTextResultCallback
         //Instantiate DCE, send result and immediate result call back to Dynamsoft Barcode Reader
         reader!!.SetCameraEnhancerParam(dceSettingParameters)
     }

     //Start DCE on resume
     public override fun onResume() {
         reader!!.StartCameraEnhancer()
         super.onResume()
     }

     //Stop DCE on pause
     public override fun onPause() {
         reader!!.StopCameraEnhancer()
         super.onPause()
     }

     //This is the function for displaying decode result on the screen
     private fun showResult(results: Array<TextResult>?) {
         if (results != null && results.size > 0) {
             var strRes = ""
             for (i in results.indices) strRes += """
     ${results[i].barcodeText}
        
        
     """.trimIndent()
             tvRes!!.text = strRes
         }
     }
 }

Run the project, now a simple decode app has been built via Dynamsoft Camera Enhancer and Dynamsoft Barcode Reader.