diff --git a/_data/full_tree.yml b/_data/full_tree.yml deleted file mode 100644 index b600058d..00000000 --- a/_data/full_tree.yml +++ /dev/null @@ -1,19 +0,0 @@ -tree_file_list: - - sidelist-full-tree.html - - sidelist-programming/programming-oc.html - - sidelist-programming/programming-oc-v1.0.0.html - - sidelist-programming/programming-oc-v1.0.1.html - - sidelist-programming/programming-oc-v1.0.3.html - - sidelist-programming/programming-oc-v2.0.0.html - - sidelist-programming/programming-oc-v2.1.4.html - - sidelist-programming/programming-oc-v2.3.5.html - - sidelist-programming/programming-oc-v2.3.20.html - - sidelist-programming/programming-android.html - - sidelist-programming/programming-android-v1.0.0.html - - sidelist-programming/programming-android-v1.0.1.html - - sidelist-programming/programming-android-v1.0.3.html - - sidelist-programming/programming-android-v2.0.0.html - - sidelist-programming/programming-android-v2.1.4.html - - sidelist-programming/programming-android-v2.3.5.html - - sidelist-programming/programming-android-v2.3.12.html - - sidelist-programming/programming-android-v3.0.3.html diff --git a/_data/product_version.yml b/_data/product_version.yml deleted file mode 100644 index 57ecfdcf..00000000 --- a/_data/product_version.yml +++ /dev/null @@ -1,35 +0,0 @@ -useGroupedVersion: true - -version_info_list_mobile: - - value: latest version - - value: 4.x - child: - - 4.2.10_Android - - 4.2.1_ios - - 4.2.0 - - 4.0.2 - - 4.0.1 - - 4.0.0 - - value: 3.x - child: - - 3.0.3 - - 3.0.2 - - 3.0.1 - - 3.0.0 - - value: 2.x - child: - - 2.3.21_ios - - 2.3.20 - - 2.3.12 - - 2.3.11 - - 2.3.10 - - 2.3.5 - - 2.3.4 - - 2.3.3 - - 2.3.2 - - 2.3.1_ios - - 2.3.0 - - 2.1.4 - - 2.1.3 - - 2.1.1 - - 2.0.0 diff --git a/_includes/release-notes/product-highlight-2.0.0.md b/_includes/release-notes/product-highlight-2.0.0.md deleted file mode 100644 index ac28a856..00000000 --- a/_includes/release-notes/product-highlight-2.0.0.md +++ /dev/null @@ -1,8 +0,0 @@ - -- Simplified the usage of camera-control APIs. The new APIs are easier to use and cover more scenarios. -- Simplified the usage of camera enhancer features. Users can enable all required features via the method `enableFeatures` by inputting the combined enumeration value. -- Extended the features of `DCECameraView`. Users can add and personalize the overlays and viewfinder on the camera UI. -- Extended the features of `DCEFrame`. `DCEFrame` will store more frame information to cover more scenarios. In addition, the method `toBitmap` is added to enable users to convert `DCEFrame` to a visible image. -- The camera UI will display a fuzzified image instead of the previously captured image when the camera UI is quit and resumed. - - diff --git a/_includes/release-notes/product-highlight-2.1.0.md b/_includes/release-notes/product-highlight-2.1.0.md deleted file mode 100644 index b3ba81b9..00000000 --- a/_includes/release-notes/product-highlight-2.1.0.md +++ /dev/null @@ -1,4 +0,0 @@ - -- Added class scan region configuration APIs and `RegionDefinition` for users to set the region of interest. The frames will be cropped based on the scan region to accelerate further frame processing. - - diff --git a/_includes/release-notes/product-highlight-2.3.0.md b/_includes/release-notes/product-highlight-2.3.0.md deleted file mode 100644 index 1ac312fb..00000000 --- a/_includes/release-notes/product-highlight-2.3.0.md +++ /dev/null @@ -1,6 +0,0 @@ - - -* The same camera enhancer instance can now be used by multiple products. (JS edition only) -* Added photo capturing features. You can now capture high-resolution images using the library. (Mobile editions only) -* Added device feedback features. You can now trigger vibrations or beep sounds of mobile devices. (Mobile editions only) - diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html deleted file mode 100644 index ac90b4fd..00000000 --- a/_includes/sidelist-full-tree.html +++ /dev/null @@ -1,9 +0,0 @@ -
  • - DCE-iOS Introduction -
    • -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-oc.html" -%} - -
  • - DCE-Android Introduction -
    • -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-android.html" -%} diff --git a/_includes/sidelist-programming/programming-android-v1.0.0.html b/_includes/sidelist-programming/programming-android-v1.0.0.html deleted file mode 100644 index 0c1c0a81..00000000 --- a/_includes/sidelist-programming/programming-android-v1.0.0.html +++ /dev/null @@ -1,40 +0,0 @@ -
  • Java (Android) - -
    • diff --git a/_includes/sidelist-programming/programming-android-v1.0.1.html b/_includes/sidelist-programming/programming-android-v1.0.1.html deleted file mode 100644 index 0c1c0a81..00000000 --- a/_includes/sidelist-programming/programming-android-v1.0.1.html +++ /dev/null @@ -1,40 +0,0 @@ -
  • Java (Android) - -
    • diff --git a/_includes/sidelist-programming/programming-android-v1.0.3.html b/_includes/sidelist-programming/programming-android-v1.0.3.html deleted file mode 100644 index 7a0bcc51..00000000 --- a/_includes/sidelist-programming/programming-android-v1.0.3.html +++ /dev/null @@ -1,40 +0,0 @@ -
  • Java (Android) - -
    • diff --git a/_includes/sidelist-programming/programming-android-v2.0.0.html b/_includes/sidelist-programming/programming-android-v2.0.0.html deleted file mode 100644 index 0e9362c0..00000000 --- a/_includes/sidelist-programming/programming-android-v2.0.0.html +++ /dev/null @@ -1,37 +0,0 @@ -
  • DEVELOPMENT ON ANDROID
    • -
  • User Guide
    • -
  • API references - -
    • -
  • USEFUL RESOURCES
    • -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-android-v2.1.4.html b/_includes/sidelist-programming/programming-android-v2.1.4.html deleted file mode 100644 index 11373196..00000000 --- a/_includes/sidelist-programming/programming-android-v2.1.4.html +++ /dev/null @@ -1,38 +0,0 @@ -
  • DEVELOPMENT ON ANDROID
    • -
  • User Guide
    • -
  • API references - -
    • -
  • USEFUL RESOURCES
    • -
  • Release Notes - -
    • - diff --git a/_includes/sidelist-programming/programming-android-v2.3.12.html b/_includes/sidelist-programming/programming-android-v2.3.12.html deleted file mode 100644 index cde2e17e..00000000 --- a/_includes/sidelist-programming/programming-android-v2.3.12.html +++ /dev/null @@ -1,55 +0,0 @@ -
  • DEVELOPMENT ON ANDROID
    • -
  • User Guide - -
    • -
  • API references - -
    • -
  • USEFUL RESOURCES
    • -
  • How to Upgrade
    • -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-android-v2.3.5.html b/_includes/sidelist-programming/programming-android-v2.3.5.html deleted file mode 100644 index f385711f..00000000 --- a/_includes/sidelist-programming/programming-android-v2.3.5.html +++ /dev/null @@ -1,40 +0,0 @@ -
  • DEVELOPMENT ON ANDROID
    • -
  • User Guide
    • -
  • API references - -
    • -
  • USEFUL RESOURCES
    • -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-android-v3.0.3.html b/_includes/sidelist-programming/programming-android-v3.0.3.html deleted file mode 100644 index fc969b2c..00000000 --- a/_includes/sidelist-programming/programming-android-v3.0.3.html +++ /dev/null @@ -1,70 +0,0 @@ -
  • DEVELOPMENT ON DCE ANDROID
    • -
  • User Guide - -
    • -
  • API references - -
    • - -
  • USEFUL RESOURCES
    • -
  • How to Upgrade
    • -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-android.html b/_includes/sidelist-programming/programming-android.html deleted file mode 100644 index f9437a24..00000000 --- a/_includes/sidelist-programming/programming-android.html +++ /dev/null @@ -1,90 +0,0 @@ -
  • DEVELOPMENT ON ANDROID
    • -
  • User Guide - -
    • -
  • API references - -
    • - -
  • USEFUL RESOURCES
    • -
  • How to Upgrade
    • -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-oc-v1.0.0.html b/_includes/sidelist-programming/programming-oc-v1.0.0.html deleted file mode 100644 index 5ae47338..00000000 --- a/_includes/sidelist-programming/programming-oc-v1.0.0.html +++ /dev/null @@ -1,34 +0,0 @@ -
  • Objective-C & Swift (iOS) - -
    • diff --git a/_includes/sidelist-programming/programming-oc-v1.0.1.html b/_includes/sidelist-programming/programming-oc-v1.0.1.html deleted file mode 100644 index dea6f227..00000000 --- a/_includes/sidelist-programming/programming-oc-v1.0.1.html +++ /dev/null @@ -1,38 +0,0 @@ -
  • Objective-C & Swift (iOS) - -
    • diff --git a/_includes/sidelist-programming/programming-oc-v1.0.3.html b/_includes/sidelist-programming/programming-oc-v1.0.3.html deleted file mode 100644 index c2453e6e..00000000 --- a/_includes/sidelist-programming/programming-oc-v1.0.3.html +++ /dev/null @@ -1,38 +0,0 @@ -
  • Objective-C & Swift (iOS) - -
    • diff --git a/_includes/sidelist-programming/programming-oc-v2.0.0.html b/_includes/sidelist-programming/programming-oc-v2.0.0.html deleted file mode 100644 index 08d952a2..00000000 --- a/_includes/sidelist-programming/programming-oc-v2.0.0.html +++ /dev/null @@ -1,36 +0,0 @@ -
  • DEVELOPMENT ON IOS
    • -
  • User Guide
    • -
  • API references - -
    • -
  • USEFUL RESOURCES
    • -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-oc-v2.1.4.html b/_includes/sidelist-programming/programming-oc-v2.1.4.html deleted file mode 100644 index bcbb11d7..00000000 --- a/_includes/sidelist-programming/programming-oc-v2.1.4.html +++ /dev/null @@ -1,36 +0,0 @@ -
  • DEVELOPMENT ON IOS
    • -
  • User Guide
    • -
  • API references - -
    • -
  • USEFUL RESOURCES
    • -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-oc-v2.3.20.html b/_includes/sidelist-programming/programming-oc-v2.3.20.html deleted file mode 100644 index 0c910004..00000000 --- a/_includes/sidelist-programming/programming-oc-v2.3.20.html +++ /dev/null @@ -1,50 +0,0 @@ -
  • DEVELOPMENT ON IOS
    • -
  • User Guide - -
    • -
  • API references - -
    • -
  • USEFUL RESOURCES
    • -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-oc-v2.3.5.html b/_includes/sidelist-programming/programming-oc-v2.3.5.html deleted file mode 100644 index 2d641ee5..00000000 --- a/_includes/sidelist-programming/programming-oc-v2.3.5.html +++ /dev/null @@ -1,39 +0,0 @@ -
  • DEVELOPMENT ON IOS
    • -
  • User Guide
    • -
  • API references - -
    • -
  • USEFUL RESOURCES
    • -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-oc-v3.0.3.html b/_includes/sidelist-programming/programming-oc-v3.0.3.html deleted file mode 100644 index 18b0817d..00000000 --- a/_includes/sidelist-programming/programming-oc-v3.0.3.html +++ /dev/null @@ -1,50 +0,0 @@ -
  • DEVELOPMENT ON IOS
    • -
  • User Guide - -
    • -
  • API references - -
    • -
  • USEFUL RESOURCES
    • -
  • Release Notes - -
    • \ No newline at end of file diff --git a/_includes/sidelist-programming/programming-oc.html b/_includes/sidelist-programming/programming-oc.html deleted file mode 100644 index c3cf4f2f..00000000 --- a/_includes/sidelist-programming/programming-oc.html +++ /dev/null @@ -1,88 +0,0 @@ -
  • DEVELOPMENT ON IOS
    • -
  • User Guide - -
    • -
  • API references - -
    • -
  • USEFUL RESOURCES
    • -
  • How to Upgrade
    • -
  • Release Notes - -
    • \ No newline at end of file diff --git a/_layouts/default-layout.html b/_layouts/default-layout-OLD.html similarity index 100% rename from _layouts/default-layout.html rename to _layouts/default-layout-OLD.html diff --git a/_layouts/search-page.html b/_layouts/search-page-OLD.html similarity index 100% rename from _layouts/search-page.html rename to _layouts/search-page-OLD.html diff --git a/index.md b/index.md deleted file mode 100644 index e8e80f23..00000000 --- a/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -layout: home-page -title: Index of Dynamsoft Camera Enhancer -description: This is the documentation - Index of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer -needAutoGenerateSidebar: true -breadcrumbText: Start Programming ---- - -# Dynamsoft Camera Enhancer Mobile - -- [Android]({{site.android}}) -- [iOS]({{site.ios}}) diff --git a/programming-old/android/api-reference-v1.0.3.md b/programming-old/android/api-reference-v1.0.3.md deleted file mode 100644 index a5b705ae..00000000 --- a/programming-old/android/api-reference-v1.0.3.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -layout: default-layout -title: Android API references - Dynamsoft Camera Enhancer -description: This is the documentation - Android API reference page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, API -needAutoGenerateSidebar: true -breadcrumbText: API references -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference-v1.0.3.html ---- - -# Android API references - -## Primary Class - CameraEnhancer - -### [Initialization]({{site.android-api}}initialization.html) - -| Method | Description | -| ------ | ----------- | -| [`initLicenseFromDLS`]({{site.android-api}}initialization.html#initlicensefromdls) | Initialize the Camera Enhancer from the license server with a license. | - -### [Frame preprocessing methods]({{site.android-api}}preprocess.html) - -| Method | Description | -| ------ | ----------- | -| [`AcquireListFrame`]({{site.android-api}}preprocess.html#acquirelistframe) | Get the latest frame from the frame queue when this API is activated. | -| [`enableFastMode`]({{site.android-api}}preprocess.html#enablefastmode) | Set true/false to turn on/off DCE fast mode. | -| [`getEnabledFastModeStatus`]({{site.android-api}}preprocess.html#getenabledfastmodestatus) | Get the current status of fast mode (on/off). | -| [`enableFrameFilter`]({{site.android-api}}preprocess.html#enableframefilter) | Set true/false to turn on/off DCE frame filter. | -| [`getEnabledFrameFilterStatus`]({{site.android-api}}preprocess.html#getenabledframefilterstatus) | Get the status (on/off) of DCE frame filter mode. | -| [`setMaxFrameRate`]({{site.android-api}}preprocess.html#setmaxframerate) | Set max frame rate. | -| [`enableSensorControl`]({{site.android-api}}preprocess.html#enablesensorcontrol) | Set true/false to turn on/off DCE sensor control. | -| [`getEnabledSensorControlStatus`]({{site.android-api}}preprocess.html#getenabledsensorcontrolstatus) | Get the status (on/off) of DCE sensor control mode. | -| [`setSensorControlThreshold`]({{site.android-api}}preprocess.html#setsensorcontrolthreshold) | Enable user to change sensor sensitivity (default value is 50). | - -### [Regular camera methods]({{site.android-api}}camera.html) - -| Method | Description | -| ------ | ----------- | -| [`getDeviceLevel`]({{site.android-api}}camera.html#getdevicelevel)| Make an evaluation on the current device and define its level for further use. | -| [`setAutoModeLevelParam`]({{site.android-api}}camera.html#setautomodelevelparam) | Set auto mode level parameter. | -| [`updateCameraSetting`]({{site.android-api}}camera.html#updatecamerasetting) | Update camera, filter and focus settings from Json. | -| [`getVersion`]({{site.android-api}}camera.html#getversion) | Check current DCE version | -| [`getCameraCurrentState`]({{site.android-api}}camera.html#getcameracurrentstate) | Get camera current state. | -| [`getCameraDesiredState`]({{site.android-api}}camera.html#getcameradesiredstate) | Get camera desired state. | -| [`setCameraDesiredState`]({{site.android-api}}camera.html#setcameradesiredstate) | Set Camera on/off. | -| [`pauseCamera`]({{site.android-api}}camera.html#pausecamera-and-resumecamera) | Pause Camera. | -| [`resumeCamera`]({{site.android-api}}camera.html#pausecamera-and-resumecamera) | Resume Camera. | -| [`startScanning`]({{site.android-api}}camera.html#stopscanning-and-startscanning) | Start scanning. | -| [`stopScanning`]({{site.android-api}}camera.html#stopscanning-and-startscanning) | Stop scanning. | -| [`addCameraListener`]({{site.android-api}}camera.html#addcameralistener) | Add camera listener (on preview original, filtered or fast frames). | -| [`removeCameraListener`]({{site.android-api}}camera.html#removecameralistener) | Remove camera listener. | -| [`getTorchCurrentState`]({{site.android-api}}camera.html#gettorchcurrentstate) | Get torch current state. | -| [`getTorchDesiredState`]({{site.android-api}}camera.html#gettorchdesiredstate) | Get torch desired state. | -| [`setTorchDesiredState`]({{site.android-api}}camera.html#settorchdesiredstate) | Set torch state. | -| [`addTorchListener`]({{site.android-api}}camera.html#addtorchlistener) | Add torch listener. | -| [`getCameraPosition`]({{site.android-api}}camera.html#getcameraposition) | Get current camera position. | -| [`switchCameraPosition`]({{site.android-api}}camera.html#switchcameraposition) | Switch camera position front/back. | -| [`getResolution`]({{site.android-api}}camera.html#getresolution) | Get current resolution setting. | -| [`setResolution`]({{site.android-api}}camera.html#setresolution) | Set resolution. | -| [`getResolutionList`]({{site.android-api}}camera.html#getresolutionlist) | Get all available resolutions | - -### [Focus & zoom methods]({{site.android-api}}zoom-focus.html) - -| Method | Description | -| ------ | ----------- | -| [`setAutoFocusPosition`]({{site.android-api}}zoom-focus.html#setautofocusposition) | Set auto focus position (Change the default auto focus position). | -| [`setManualFocusPosition`]({{site.android-api}}zoom-focus.html#setmanualfocusposition) | Set manual focus position (This focus position is only effected once for each time the API is called). | -| [`setFocalLength`]({{site.android-api}}zoom-focus.html#setfocallength) | Set focal length between 0 to 10 to enable fixed focal length mode. In fixed focal length mode, all focus parameters can't be changed until this mode is quit. To quit fixed focal length mode, please set focal length equals to -1. | -| [`enableDCEAutoFocus`]({{site.android-api}}zoom-focus.html#enabledceautofocus) | Set true/false to turn on/off DCE auto focus. | -| [`getEnabledDCEAutoFocusStatus`]({{site.android-api}}zoom-focus.html#getenableddceautofocusstatus) | Get the status (on/off) of DCE auto focus. | -| [`enableDefaultAutoFocus`]({{site.android-api}}zoom-focus.html#enabledefaultautofocus) | Set true/false to turn on/off default auto focus. | -| [`getEnabledDefaultAutoFocusStatus`]({{site.android-api}}zoom-focus.html#getenableddefaultautofocusstatus) | Get the status (on/off) of camera default auto focus. | -| [`enableRegularAutoFocus`]({{site.android-api}}zoom-focus.html#enableregularautofocus) | If this is true, camera will auto focus every 3 seconds. This focus mode will start automatically if DCE auto focus is enabled. Users can manually quit this focus mode when DCE auto focus is activated. | -| [`getEnabledRegularAutoFocusStatus`]({{site.android-api}}zoom-focus.html#getenabledregularautofocusstatus) | Get the current status (on/off) of this auto focus mode. | -| [`setRegularAutoFocusParam`]({{site.android-api}}zoom-focus.html#setregularautofocusparam) | Set the time interval and terminate time for the regular auto focus | -| [`enableAutoFocusOnSharpnessChange`]({{site.android-api}}zoom-focus.html#enableautofocusonsharpnesschange) | If this is enabled, camera will autofocus when clarity change is detected. This focus mode will start automatically if DCE autofocus is enabled. Users can manually quit this focus mode when DCE autofocus is activated. | -| [`getEnabledAutoFocusOnSharpnessChangeStatus`]({{site.android-api}}zoom-focus.html#getenabledautofocusonsharpnesschangestatus) | Get the current status (on/off) of this auto focus mode. | -| [`enableAutoZoom`]({{site.android-api}}zoom-focus.html#enableautozoom) | Set enableAutoZoom value true to enable auto zoom mode. | -| [`getEnabledAutoZoomStatus`]({{site.android-api}}zoom-focus.html#getenabledautozoomstatus) | Get the status (on/off) of auto zoom mode. | -| [`setZoomFactor`]({{site.android-api}}zoom-focus.html#setzoomfactor) | Set zoom factor. | - -## Auxiliary Classes - -- [`DMDLSConnectionParameters`]({{site.android-api-auxiliary}}dlsconnection.html) -- [`Frame`]({{site.android-api-auxiliary}}dceframe.html) -- [`HardwareUtil`]({{site.android-api-auxiliary}}hardwareutil.html) -- [`CameraView`]({{site.android-api-auxiliary}}dcecameraview.html) -- [`CameraEnhancerException`]({{site.android-api-auxiliary}}camera-enhancer-exception.html) - -## Interfaces - -- [`CameraListener`]({{ site.android-api-auxiliary }}interface-dceframelistener.html) -- [`CameraDLSLicenseVerificationListener`]({{ site.android-api-auxiliary }}interface-licenselistener.html) -- [`TorchListener`]({{ site.android-api-auxiliary }}interface-torchlistener.html) - -## Enumerations - -- [View all Enumerations]({{ site.dce-enums }}enum-1.html?lang=android) diff --git a/programming-old/android/api-reference-v2.0.0.md b/programming-old/android/api-reference-v2.0.0.md deleted file mode 100644 index f2f71643..00000000 --- a/programming-old/android/api-reference-v2.0.0.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -layout: default-layout -title: Android API references - Dynamsoft Camera Enhancer -description: This is the documentation - Android API reference page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, API -needAutoGenerateSidebar: true -breadcrumbText: API references -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference-v2.0.0.html ---- - -# Android API references - -## Primary Class - CameraEnhancer - -### Initialization - -| Method | Description | -| ------ | ----------- | -| [`CameraEnhancer`]({{site.android-api}}camera-enhancer.html#cameraenhancer) | Initialize the `CameraEnhancer` object. | -| [`initLicense`]({{site.android-api}}camera-enhancer.html#initlicense) | Sets product key and activate the SDK. | -| [`getVersion`]({{site.android-api}}camera-enhancer.html#getversion) | Get the SDK version. | - -### Basic Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`getAllCameras`]({{site.android-api}}camera-enhancer.html#getallcameras) | Get all available cameras. This method returns a list of available camera IDs. | -| [`selectCamera`]({{site.android-api}}camera-enhancer.html#selectcamera) | Select and active a camera from the camera list with the camera ID. | -| [`getSelectedCamera`]({{site.android-api}}camera-enhancer.html#getselectedcamera) | Get the camera ID of the current selected camera. | -| [`getCameraState`]({{site.android-api}}camera-enhancer.html#getcamerastate) | Get the state of the currently selected camera. | -| [`open`]({{site.android-api}}camera-enhancer.html#open) | Turn on the current selected camera. | -| [`close`]({{site.android-api}}camera-enhancer.html#close) | Turn off the current selected camera. | -| [`pause`]({{site.android-api}}camera-enhancer.html#pause) | Pause the current selected camera. | -| [`resume`]({{site.android-api}}camera-enhancer.html#resume) | Resume the current selected camera. | -| [`turnOnTorch`]({{site.android-api}}camera-enhancer.html#turnontorch) | Turn on the torch. | -| [`turnOffTorch`]({{site.android-api}}camera-enhancer.html#turnofftorch) | Turn off the torch. | -| [`setFrameRate`]({{site.android-api}}camera-enhancer.html#setframerate) | Set the frame rate to the input value (if the input value is available for the device). | -| [`getFrameRate`]({{site.android-api}}camera-enhancer.html#getframerate) | Get the current frame rate. | -| [`getResolutionList`]({{site.android-api}}camera-enhancer.html#getresolutionlist) | Get all available resolutions. | -| [`setResolution`]({{site.android-api}}camera-enhancer.html#setresolution) | Set the resolution to the input value (if the input value is available for the device). | -| [`getResolution`]({{site.android-api}}camera-enhancer.html#getresolution) | Get the current resolution. | -| [`setZoom`]({{site.android-api}}camera-enhancer.html#setzoom) | Set the zoom factor. Once `setZoom` is triggered and approved, the zoom factor of the actived camera will immediately become the input value. | -| [`setFocus`]({{site.android-api}}camera-enhancer.html#setfocus) | Set the focus position (value range from 0.0f to 1.0f) and trigger a focus at the configured position. | - -### Frame Acquiring Methods - -| Method | Description | -| ------ | ----------- | -| [`getFrameFromBuffer`]({{site.android-api}}camera-enhancer.html#getframefrombuffer) | Get the latest frame from the buffer. The input boolean value determines whether the fetched frame will be removed from the buffer. | -| [`addListener`]({{site.android-api}}camera-enhancer.html#addlistener) | Add a listener to the Camera Enhancer instance. | -| [`removeListener`]({{site.android-api}}camera-enhancer.html#removelistener) | Remove a preciously added listener from the Camera Enhancer instance. | - -### Enhanced Features - -| Method | Description | -| ------ | ----------- | -| [`enableFeatures`]({{site.android-api}}camera-enhancer.html#enablefeatures) | Enable DCE features with Enumeration value. | -| [`disableFeatures`]({{site.android-api}}camera-enhancer.html#disablefeatures) | Disable DCE features with Enumeration value. | -| [`isFeatureEnabled`]({{site.android-api}}camera-enhancer.html#isfeatureenabled) | Returns a boolean value that means whether the feature(s) you input is (are) enabled. | - -### Camera UI Methods - -| Method | Description | -| ------ | ----------- | -| [`setCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Sets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | -| [`getCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Gets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | - -### Advanced Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`updateAdvancedSettingsFromFile`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromfile) | Update advanced parameter settings including filter, sensor and focus settings from a JSON file. | -| [`updateAdvancedSettingsFromString`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromstring) | Update advanced parameter settings including filter, sensor and focus settings from a JSON string. | - -## Auxiliary Classes - -- [`DCEFrame`]({{site.android-api-auxiliary}}dceframe.html) -- [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html) -- [`RegionDefinition`]({{site.android-api-auxiliary}}region-definition.html) -- [`CameraEnhancerException`]({{site.android-api-auxiliary}}camera-enhancer-exception.html) - -## Interfaces - -- [`DCEFrameListener`]({{ site.android-api-auxiliary }}interface-dceframelistener.html) -- [`DCELicenseVerificationListener`]({{ site.android-api-auxiliary }}interface-licenselistener.html) - -## Enumerations - -- [`EnumDCEErrorCode`]({{ site.dce-enums }}error-code.html?lang=android) -- [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html?lang=android) -- [`EnumCameraState`]({{ site.dce-enums }}camera-state.html?lang=android) -- [`EnumEnhancerFeatures`]({{ site.dce-enums }}enhanced-features.html?lang=android) -- [`EnumResolution`]({{ site.dce-enums }}resolution.html?lang=android) diff --git a/programming-old/android/api-reference-v2.1.3.md b/programming-old/android/api-reference-v2.1.3.md deleted file mode 100644 index 2ba3d4dc..00000000 --- a/programming-old/android/api-reference-v2.1.3.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -layout: default-layout -title: Android API references - Dynamsoft Camera Enhancer -description: This is the documentation - Android API reference page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, API -needAutoGenerateSidebar: true -breadcrumbText: API references -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference-v2.1.3.html ---- - -# Android API references - -## Primary Class - CameraEnhancer - -### Initialization - -| Method | Description | -| ------ | ----------- | -| [`CameraEnhancer`]({{site.android-api}}camera-enhancer.html#cameraenhancer) | Initialize the `CameraEnhancer` object. | -| [`initLicense`]({{site.android-api}}camera-enhancer.html#initlicense) | Sets product key and activate the SDK. | -| [`getVersion`]({{site.android-api}}camera-enhancer.html#getversion) | Get the SDK version. | - -### Basic Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`getAllCameras`]({{site.android-api}}camera-enhancer.html#getallcameras) | Get all available cameras. This method returns a list of available camera IDs. | -| [`selectCamera`]({{site.android-api}}camera-enhancer.html#selectcamera) | Select and active a camera from the camera list with the camera ID. | -| [`getSelectedCamera`]({{site.android-api}}camera-enhancer.html#getselectedcamera) | Get the camera ID of the current selected camera. | -| [`getCameraState`]({{site.android-api}}camera-enhancer.html#getcamerastate) | Get the state of the currently selected camera. | -| [`open`]({{site.android-api}}camera-enhancer.html#open) | Turn on the current selected camera. | -| [`close`]({{site.android-api}}camera-enhancer.html#close) | Turn off the current selected camera. | -| [`pause`]({{site.android-api}}camera-enhancer.html#pause) | Pause the current selected camera. | -| [`resume`]({{site.android-api}}camera-enhancer.html#resume) | Resume the current selected camera. | -| [`turnOnTorch`]({{site.android-api}}camera-enhancer.html#turnontorch) | Turn on the torch. | -| [`turnOffTorch`]({{site.android-api}}camera-enhancer.html#turnofftorch) | Turn off the torch. | -| [`setFrameRate`]({{site.android-api}}camera-enhancer.html#setframerate) | Set the frame rate to the input value (if the input value is available for the device). | -| [`getFrameRate`]({{site.android-api}}camera-enhancer.html#getframerate) | Get the current frame rate. | -| [`getResolutionList`]({{site.android-api}}camera-enhancer.html#getresolutionlist) | Get all available resolutions. | -| [`setResolution`]({{site.android-api}}camera-enhancer.html#setresolution) | Set the resolution to the input value (if the input value is available for the device). | -| [`getResolution`]({{site.android-api}}camera-enhancer.html#getresolution) | Get the current resolution. | -| [`setZoom`]({{site.android-api}}camera-enhancer.html#setzoom) | Set the zoom factor. Once `setZoom` is triggered and approved, the zoom factor of the actived camera will immediately become the input value. | -| [`setFocus`]({{site.android-api}}camera-enhancer.html#setfocus) | Set the focus position (value range from 0.0f to 1.0f) and trigger a focus at the configured position. | -| [`setScanRegion`]({{site.android-api}}camera-enhancer.html#setscanregion) | Set the scan region with a RegionDefinition value. The frame will be cropped according to the scan region. | -| [`getScanRegion`]({{site.android-api}}camera-enhancer.html#getscanregion) | Get the scan region. | -| [`setScanRegionVisible`]({{site.android-api}}camera-enhancer.html#setscanregionvisible) | Set whether to display the **scanRegion** on the UI. | -| [`getScanRegionVisible`]({{site.android-api}}camera-enhancer.html#getscanregionvisible) | Get whether the **scanRegion** will be displayed on the UI. | - -### Frame Acquiring Methods - -| Method | Description | -| ------ | ----------- | -| [`getFrameFromBuffer`]({{site.android-api}}camera-enhancer.html#getframefrombuffer) | Get the latest frame from the buffer. The input boolean value determines whether the fetched frame will be removed from the buffer. | -| [`addListener`]({{site.android-api}}camera-enhancer.html#addlistener) | Add a listener to the Camera Enhancer instance. | -| [`removeListener`]({{site.android-api}}camera-enhancer.html#removelistener) | Remove a preciously added listener from the Camera Enhancer instance. | - -### Enhanced Features - -| Method | Description | -| ------ | ----------- | -| [`enableFeatures`]({{site.android-api}}camera-enhancer.html#enablefeatures) | Enable DCE features with Enumeration value. | -| [`disableFeatures`]({{site.android-api}}camera-enhancer.html#disablefeatures) | Disable DCE features with Enumeration value. | -| [`isFeatureEnabled`]({{site.android-api}}camera-enhancer.html#isfeatureenabled) | Returns a boolean value that means whether the feature(s) you input is (are) enabled. | - -### Camera UI Methods - -| Method | Description | -| ------ | ----------- | -| [`setCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Sets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | -| [`getCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Gets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | - -### Advanced Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`updateAdvancedSettingsFromFile`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromfile) | Update advanced parameter settings including filter, sensor and focus settings from a JSON file. | -| [`updateAdvancedSettingsFromString`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromstring) | Update advanced parameter settings including filter, sensor and focus settings from a JSON string. | - -## Auxiliary Classes - -- [`DCEFrame`]({{site.android-api-auxiliary}}dceframe.html) -- [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html) -- [`RegionDefinition`]({{site.android-api-auxiliary}}region-definition.html) -- [`CameraEnhancerException`]({{site.android-api-auxiliary}}camera-enhancer-exception.html) - -## Interfaces - -- [`DCEFrameListener`]({{ site.android-api-auxiliary }}interface-dceframelistener.html) -- [`DCELicenseVerificationListener`]({{ site.android-api-auxiliary }}interface-licenselistener.html) - -## Enumerations - -- [`EnumDCEErrorCode`]({{ site.dce-enums }}error-code.html?lang=android) -- [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html?lang=android) -- [`EnumCameraState`]({{ site.dce-enums }}camera-state.html?lang=android) -- [`EnumEnhancerFeatures`]({{ site.dce-enums }}enhanced-features.html?lang=android) -- [`EnumResolution`]({{ site.dce-enums }}resolution.html?lang=android) diff --git a/programming-old/android/api-reference-v2.1.4.md b/programming-old/android/api-reference-v2.1.4.md deleted file mode 100644 index 7f1f348a..00000000 --- a/programming-old/android/api-reference-v2.1.4.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -layout: default-layout -title: Android API references - Dynamsoft Camera Enhancer -description: This is the documentation - Android API reference page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, API -needAutoGenerateSidebar: true -breadcrumbText: API references -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference-v2.1.4.html ---- - -# Android API references - -## Primary Class - CameraEnhancer - -### Initialization - -| Method | Description | -| ------ | ----------- | -| [`CameraEnhancer`]({{site.android-api}}camera-enhancer.html#cameraenhancer) | Initialize the `CameraEnhancer` object. | -| [`initLicense`]({{site.android-api}}camera-enhancer.html#initlicense) | Sets product key and activate the SDK. | -| [`getVersion`]({{site.android-api}}camera-enhancer.html#getversion) | Get the SDK version. | - -### Basic Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`getAllCameras`]({{site.android-api}}camera-enhancer.html#getallcameras) | Get all available cameras. This method returns a list of available camera IDs. | -| [`selectCamera`]({{site.android-api}}camera-enhancer.html#selectcamera) | Select and active a camera from the camera list with the camera ID. | -| [`getSelectedCamera`]({{site.android-api}}camera-enhancer.html#getselectedcamera) | Get the camera ID of the current selected camera. | -| [`getCameraState`]({{site.android-api}}camera-enhancer.html#getcamerastate) | Get the state of the currently selected camera. | -| [`open`]({{site.android-api}}camera-enhancer.html#open) | Turn on the current selected camera. | -| [`close`]({{site.android-api}}camera-enhancer.html#close) | Turn off the current selected camera. | -| [`pause`]({{site.android-api}}camera-enhancer.html#pause) | Pause the current selected camera. | -| [`resume`]({{site.android-api}}camera-enhancer.html#resume) | Resume the current selected camera. | -| [`turnOnTorch`]({{site.android-api}}camera-enhancer.html#turnontorch) | Turn on the torch. | -| [`turnOffTorch`]({{site.android-api}}camera-enhancer.html#turnofftorch) | Turn off the torch. | -| [`getFrameRate`]({{site.android-api}}camera-enhancer.html#getframerate) | Get the current frame rate. | -| [`getResolutionList`]({{site.android-api}}camera-enhancer.html#getresolutionlist) | Get all available resolutions. | -| [`setResolution`]({{site.android-api}}camera-enhancer.html#setresolution) | Set the resolution to the input value (if the input value is available for the device). | -| [`getResolution`]({{site.android-api}}camera-enhancer.html#getresolution) | Get the current resolution. | -| [`setZoom`]({{site.android-api}}camera-enhancer.html#setzoom) | Set the zoom factor. Once `setZoom` is triggered and approved, the zoom factor of the actived camera will immediately become the input value. | -| [`setFocus`]({{site.android-api}}camera-enhancer.html#setfocus) | Set the focus position (value range from 0.0f to 1.0f) and trigger a focus at the configured position. | -| [`setScanRegion`]({{site.android-api}}camera-enhancer.html#setscanregion) | Set the scan region with a RegionDefinition value. The frame will be cropped according to the scan region. | -| [`getScanRegion`]({{site.android-api}}camera-enhancer.html#getscanregion) | Get the scan region. | -| [`setScanRegionVisible`]({{site.android-api}}camera-enhancer.html#setscanregionvisible) | Set whether to display the **scanRegion** on the UI. | -| [`getScanRegionVisible`]({{site.android-api}}camera-enhancer.html#getscanregionvisible) | Get whether the **scanRegion** will be displayed on the UI. | -| [`setFrameRate`]({{site.android-api}}camera-enhancer.html#setframerate) | **Deprecated**. Set the frame rate to the input value (if the input value is available for the device). | - -### Frame Acquiring Methods - -| Method | Description | -| ------ | ----------- | -| [`getFrameFromBuffer`]({{site.android-api}}camera-enhancer.html#getframefrombuffer) | Get the latest frame from the buffer. The input boolean value determines whether the fetched frame will be removed from the buffer. | -| [`addListener`]({{site.android-api}}camera-enhancer.html#addlistener) | Add a listener to the Camera Enhancer instance. | -| [`removeListener`]({{site.android-api}}camera-enhancer.html#removelistener) | Remove a preciously added listener from the Camera Enhancer instance. | - -### Enhanced Features - -| Method | Description | -| ------ | ----------- | -| [`enableFeatures`]({{site.android-api}}camera-enhancer.html#enablefeatures) | Enable DCE features with Enumeration value. | -| [`disableFeatures`]({{site.android-api}}camera-enhancer.html#disablefeatures) | Disable DCE features with Enumeration value. | -| [`isFeatureEnabled`]({{site.android-api}}camera-enhancer.html#isfeatureenabled) | Returns a boolean value that means whether the feature(s) you input is (are) enabled. | - -### Camera UI Methods - -| Method | Description | -| ------ | ----------- | -| [`setCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Sets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | -| [`getCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Gets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | - -### Advanced Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`updateAdvancedSettingsFromFile`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromfile) | Update advanced parameter settings including filter, sensor and focus settings from a JSON file. | -| [`updateAdvancedSettingsFromString`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromstring) | Update advanced parameter settings including filter, sensor and focus settings from a JSON string. | - -## Auxiliary Classes - -- [`DCEFrame`]({{site.android-api-auxiliary}}dceframe.html) -- [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html) -- [`RegionDefinition`]({{site.android-api-auxiliary}}region-definition.html) -- [`CameraEnhancerException`]({{site.android-api-auxiliary}}camera-enhancer-exception.html) - -## Interfaces - -- [`DCEFrameListener`]({{ site.android-api-auxiliary }}interface-dceframelistener.html) -- [`DCEPhotoListener`]({{ site.android-api-auxiliary }}interface-dcephotolistener.html) -- [`DCELicenseVerificationListener`]({{ site.android-api-auxiliary }}interface-licenselistener.html) - -## Enumerations - -- [`EnumDCEErrorCode`]({{ site.dce-enums }}error-code.html?lang=android) -- [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html?lang=android) -- [`EnumCameraState`]({{ site.dce-enums }}camera-state.html?lang=android) -- [`EnumEnhancerFeatures`]({{ site.dce-enums }}enhanced-features.html?lang=android) -- [`EnumResolution`]({{ site.dce-enums }}resolution.html?lang=android) diff --git a/programming-old/android/api-reference-v2.3.0.md b/programming-old/android/api-reference-v2.3.0.md deleted file mode 100644 index 9d5d1508..00000000 --- a/programming-old/android/api-reference-v2.3.0.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -layout: default-layout -title: Android API references - Dynamsoft Camera Enhancer -description: This is the documentation - Android API reference page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, API -needAutoGenerateSidebar: true -breadcrumbText: API references -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference-v2.3.0.html ---- - -# Android API references - -## Primary Class - CameraEnhancer - -### Initialization - -| Method | Description | -| ------ | ----------- | -| [`CameraEnhancer`]({{site.android-api}}camera-enhancer.html#cameraenhancer) | Initialize the `CameraEnhancer` object. | -| [`initLicense`]({{site.android-api}}camera-enhancer.html#initlicense) | Sets product key and activate the SDK. | -| [`getVersion`]({{site.android-api}}camera-enhancer.html#getversion) | Get the SDK version. | - -### Basic Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`getAllCameras`]({{site.android-api}}camera-enhancer.html#getallcameras) | Get all available cameras. This method returns a list of available camera IDs. | -| [`selectCamera`]({{site.android-api}}camera-enhancer.html#selectcamera) | Select and active a camera from the camera list with the camera ID. | -| [`getSelectedCamera`]({{site.android-api}}camera-enhancer.html#getselectedcamera) | Get the camera ID of the current selected camera. | -| [`getCameraState`]({{site.android-api}}camera-enhancer.html#getcamerastate) | Get the state of the currently selected camera. | -| [`open`]({{site.android-api}}camera-enhancer.html#open) | Turn on the current selected camera. | -| [`close`]({{site.android-api}}camera-enhancer.html#close) | Turn off the current selected camera. | -| [`pause`]({{site.android-api}}camera-enhancer.html#pause) | Pause the current selected camera. | -| [`resume`]({{site.android-api}}camera-enhancer.html#resume) | Resume the current selected camera. | -| [`turnOnTorch`]({{site.android-api}}camera-enhancer.html#turnontorch) | Turn on the torch. | -| [`turnOffTorch`]({{site.android-api}}camera-enhancer.html#turnofftorch) | Turn off the torch. | -| [`getFrameRate`]({{site.android-api}}camera-enhancer.html#getframerate) | Get the current frame rate. | -| [`getResolutionList`]({{site.android-api}}camera-enhancer.html#getresolutionlist) | Get all available resolutions. | -| [`setResolution`]({{site.android-api}}camera-enhancer.html#setresolution) | Set the resolution to the input value (if the input value is available for the device). | -| [`getResolution`]({{site.android-api}}camera-enhancer.html#getresolution) | Get the current resolution. | -| [`setZoom`]({{site.android-api}}camera-enhancer.html#setzoom) | Set the zoom factor. Once `setZoom` is triggered and approved, the zoom factor of the actived camera will immediately become the input value. | -| [`getMaxZoomFactor`]({{site.android-api}}camera-enhancer.html#getmaxzoomfactor) | Get the maximum available zoom factor. | -| [`setFocus`]({{site.android-api}}camera-enhancer.html#setfocus) | Set the focus position (value range from 0.0f to 1.0f) and trigger a focus at the configured position. | -| [`setScanRegion`]({{site.android-api}}camera-enhancer.html#setscanregion) | Set the scan region with a RegionDefinition value. The frame will be cropped according to the scan region. | -| [`getScanRegion`]({{site.android-api}}camera-enhancer.html#getscanregion) | Get the scan region. | -| [`setScanRegionVisible`]({{site.android-api}}camera-enhancer.html#setscanregionvisible) | Set whether to display the **scanRegion** on the UI. | -| [`getScanRegionVisible`]({{site.android-api}}camera-enhancer.html#getscanregionvisible) | Get whether the **scanRegion** will be displayed on the UI. | -| [`setFrameRate`]({{site.android-api}}camera-enhancer.html#setframerate) | **Deprecated**. Set the frame rate to the input value (if the input value is available for the device). | - -### Frame Acquiring Methods - -| Method | Description | -| ------ | ----------- | -| [`getFrameFromBuffer`]({{site.android-api}}camera-enhancer.html#getframefrombuffer) | Get the latest frame from the buffer. The input boolean value determines whether the fetched frame will be removed from the buffer. | -| [`addListener`]({{site.android-api}}camera-enhancer.html#addlistener) | Add a listener to the Camera Enhancer instance. | -| [`removeListener`]({{site.android-api}}camera-enhancer.html#removelistener) | Remove a preciously added listener from the Camera Enhancer instance. | -| [`takePhoto`]({{site.android-api}}camera-enhancer.html#takephoto) | Take a photo from the camera and save the image in the memory. | - -### Enhanced Features - -| Method | Description | -| ------ | ----------- | -| [`enableFeatures`]({{site.android-api}}camera-enhancer.html#enablefeatures) | Enable DCE features with Enumeration value. | -| [`disableFeatures`]({{site.android-api}}camera-enhancer.html#disablefeatures) | Disable DCE features with Enumeration value. | -| [`isFeatureEnabled`]({{site.android-api}}camera-enhancer.html#isfeatureenabled) | Returns a boolean value that means whether the feature(s) you input is (are) enabled. | - -### Camera UI Methods - -| Method | Description | -| ------ | ----------- | -| [`setCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Sets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | -| [`getCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Gets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | - -### Advanced Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`updateAdvancedSettingsFromFile`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromfile) | Update advanced parameter settings including filter, sensor and focus settings from a JSON file. | -| [`updateAdvancedSettingsFromString`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromstring) | Update advanced parameter settings including filter, sensor and focus settings from a JSON string. | - -## Auxiliary Classes - -- [`DCEFrame`]({{site.android-api-auxiliary}}dceframe.html) -- [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html) -- [`DCEFeedback`]({{site.android-api-auxiliary}}dcefeedback.html) -- [`RegionDefinition`]({{site.android-api-auxiliary}}region-definition.html) -- [`CameraEnhancerException`]({{site.android-api-auxiliary}}camera-enhancer-exception.html) - -## Interfaces - -- [`DCEFrameListener`]({{ site.android-api-auxiliary }}interface-dceframelistener.html) -- [`DCEPhotoListener`]({{ site.android-api-auxiliary }}interface-dcephotolistener.html) -- [`DCELicenseVerificationListener`]({{ site.android-api-auxiliary }}interface-licenselistener.html) - -## Enumerations - -- [`EnumDCEErrorCode`]({{ site.dce-enums }}error-code.html?lang=android) -- [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html?lang=android) -- [`EnumCameraState`]({{ site.dce-enums }}camera-state.html?lang=android) -- [`EnumEnhancerFeatures`]({{ site.dce-enums }}enhanced-features.html?lang=android) -- [`EnumResolution`]({{ site.dce-enums }}resolution.html?lang=android) diff --git a/programming-old/android/api-reference-v2.3.10.md b/programming-old/android/api-reference-v2.3.10.md deleted file mode 100644 index fac158fc..00000000 --- a/programming-old/android/api-reference-v2.3.10.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -layout: default-layout -title: Android API references - Dynamsoft Camera Enhancer -description: This is the documentation - Android API reference page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, API -needAutoGenerateSidebar: true -breadcrumbText: API references -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference-v2.3.10.html ---- - -# Android API references - -## Primary Class - CameraEnhancer - -### Initialization - -| Method | Description | -| ------ | ----------- | -| [`CameraEnhancer`]({{site.android-api}}camera-enhancer.html#cameraenhancer) | Initialize the `CameraEnhancer` object. | -| [`initLicense`]({{site.android-api}}camera-enhancer.html#initlicense) | Sets product key and activate the SDK. | -| [`getVersion`]({{site.android-api}}camera-enhancer.html#getversion) | Get the SDK version. | - -### Basic Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`getAllCameras`]({{site.android-api}}camera-enhancer.html#getallcameras) | Get all available cameras. This method returns a list of available camera IDs. | -| [`selectCamera(EnumCameraPosition)`]({{site.android-api}}camera-enhancer.html#selectcameraenumcameraposition) | Select whether to use front-facing camera or back-facing camera. | -| [`getCameraPosition`]({{site.android-api}}camera-enhancer.html#getcameraposition) | Returns whether the front-facing camera or back-facing camera is selected. | -| [`selectCamera(String)`]({{site.android-api}}camera-enhancer.html#selectcamerastring) | Select a camera from the camera list with the camera ID. | -| [`getSelectedCamera`]({{site.android-api}}camera-enhancer.html#getselectedcamera) | Get the camera ID of the current selected camera. | -| [`getCameraPosition`]({{site.android-api}}camera-enhancer.html#getcameraposition) | Returns whether the device uses a front-facing or rear-facing camera. | -| [`getCameraState`]({{site.android-api}}camera-enhancer.html#getcamerastate) | Get the state of the currently selected camera. | -| [`open`]({{site.android-api}}camera-enhancer.html#open) | Turn on the current selected camera. | -| [`close`]({{site.android-api}}camera-enhancer.html#close) | Turn off the current selected camera. | -| [`pause`]({{site.android-api}}camera-enhancer.html#pause) | Pause the current selected camera. | -| [`resume`]({{site.android-api}}camera-enhancer.html#resume) | Resume the current selected camera. | -| [`turnOnTorch`]({{site.android-api}}camera-enhancer.html#turnontorch) | Turn on the torch. | -| [`turnOffTorch`]({{site.android-api}}camera-enhancer.html#turnofftorch) | Turn off the torch. | -| [`getFrameRate`]({{site.android-api}}camera-enhancer.html#getframerate) | Get the current frame rate. | -| [`getResolutionList`]({{site.android-api}}camera-enhancer.html#getresolutionlist) | Get all available resolutions. | -| [`setResolution`]({{site.android-api}}camera-enhancer.html#setresolution) | Set the resolution to the input value (if the input value is available for the device). | -| [`getResolution`]({{site.android-api}}camera-enhancer.html#getresolution) | Get the current resolution. | -| [`setZoom`]({{site.android-api}}camera-enhancer.html#setzoom) | Set the zoom factor. Once `setZoom` is triggered and approved, the zoom factor of the actived camera will immediately become the input value. | -| [`getMaxZoomFactor`]({{site.android-api}}camera-enhancer.html#getmaxzoomfactor) | Get the maximum available zoom factor. | -| [`setFocus`]({{site.android-api}}camera-enhancer.html#setfocus) | Set the focus position (value range from 0.0f to 1.0f) and focus once at the configured position. | -| [`setFocus(subsequentFocusMode)`]({{site.android-api}}camera-enhancer.html#setfocussubsequentfocusmode) | Trigger a focus at the targeting point and set the subsequent focus mode after focused. | -| [`setScanRegion`]({{site.android-api}}camera-enhancer.html#setscanregion) | Set the scan region with a RegionDefinition value. The frame will be cropped according to the scan region. | -| [`getScanRegion`]({{site.android-api}}camera-enhancer.html#getscanregion) | Get the scan region. | -| [`setScanRegionVisible`]({{site.android-api}}camera-enhancer.html#setscanregionvisible) | Set whether to display the **scanRegion** on the UI. | -| [`getScanRegionVisible`]({{site.android-api}}camera-enhancer.html#getscanregionvisible) | Get whether the **scanRegion** will be displayed on the UI. | -| [`setCameraStateListener`]({{site.android-api}}camera-enhancer.html#setcamerastatelistener ) | Add a `DCECameraStateListener` to receive notification when the camera state changes. | -| [`setFrameRate`]({{site.android-api}}camera-enhancer.html#setframerate) | **Deprecated**. Set the frame rate to the input value (if the input value is available for the device). | - -### Frame Acquiring Methods - -| Method | Description | -| ------ | ----------- | -| [`getFrameFromBuffer`]({{site.android-api}}camera-enhancer.html#getframefrombuffer) | Get the latest frame from the buffer. The input boolean value determines whether the fetched frame will be removed from the buffer. | -| [`addListener`]({{site.android-api}}camera-enhancer.html#addlistener) | Add a listener to the Camera Enhancer instance. | -| [`removeListener`]({{site.android-api}}camera-enhancer.html#removelistener) | Remove a preciously added listener from the Camera Enhancer instance. | -| [`takePhoto`]({{site.android-api}}camera-enhancer.html#takephoto) | Take a photo from the camera and save the image in the memory. | - -### Enhanced Features - -| Method | Description | -| ------ | ----------- | -| [`enableFeatures`]({{site.android-api}}camera-enhancer.html#enablefeatures) | Enable DCE features with Enumeration value. | -| [`disableFeatures`]({{site.android-api}}camera-enhancer.html#disablefeatures) | Disable DCE features with Enumeration value. | -| [`isFeatureEnabled`]({{site.android-api}}camera-enhancer.html#isfeatureenabled) | Returns a boolean value that means whether the feature(s) you input is (are) enabled. | - -### Camera UI Methods - -| Method | Description | -| ------ | ----------- | -| [`setCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Sets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | -| [`getCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Gets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | - -### Advanced Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`updateAdvancedSettingsFromFile`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromfile) | Update advanced parameter settings including filter, sensor and focus settings from a JSON file. | -| [`updateAdvancedSettingsFromString`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromstring) | Update advanced parameter settings including filter, sensor and focus settings from a JSON string. | - -## Auxiliary Classes - -- [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html) -- [`DCEFeedback`]({{site.android-api-auxiliary}}dcefeedback.html) -- [`DCEFrame`]({{site.android-api-auxiliary}}dceframe.html) -- [`RegionDefinition`]({{site.android-api-auxiliary}}region-definition.html) - -## Exception - -- [`CameraEnhancerException`]({{site.android-api-auxiliary}}camera-enhancer-exception.html) -- [`Error Code Reference`]({{ site.dce-enums }}error-code.html?lang=android) - -## Interfaces - -- [`DCECameraStateListener`]({{ site.android-api-auxiliary }}interface-camerastatelistener.html) -- [`DCEFrameListener`]({{ site.android-api-auxiliary }}interface-dceframelistener.html) -- [`DCELicenseVerificationListener`]({{ site.android-api-auxiliary }}interface-licenselistener.html) -- [`DCEPhotoListener`]({{ site.android-api-auxiliary }}interface-dcephotolistener.html) - -## Enumerations - -- [`EnumCameraPosition`]({{ site.dce-enums }}camera-position.html?lang=android) -- [`EnumCameraState`]({{ site.dce-enums }}camera-state.html?lang=android) -- [`EnumEnhancerFeatures`]({{ site.dce-enums }}enhanced-features.html?lang=android) -- [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html?lang=android) -- [`EnumResolution`]({{ site.dce-enums }}resolution.html?lang=android) diff --git a/programming-old/android/api-reference-v2.3.12.md b/programming-old/android/api-reference-v2.3.12.md deleted file mode 100644 index c15088df..00000000 --- a/programming-old/android/api-reference-v2.3.12.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -layout: default-layout -title: Android API references - Dynamsoft Camera Enhancer -description: This is the documentation - Android API reference page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, API -needAutoGenerateSidebar: true -breadcrumbText: API references -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference-v2.3.12.html ---- - -# Android API references - -## Primary Class - CameraEnhancer - -### Initialization - -| Method | Description | -| ------ | ----------- | -| [`CameraEnhancer`]({{site.android-api}}camera-enhancer.html#cameraenhancer) | Initialize the `CameraEnhancer` object. | -| [`initLicense`]({{site.android-api}}camera-enhancer.html#initlicense) | Sets product key and activate the SDK. | -| [`getVersion`]({{site.android-api}}camera-enhancer.html#getversion) | Get the SDK version. | - -### Basic Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`getAllCameras`]({{site.android-api}}camera-enhancer.html#getallcameras) | Get all available cameras. This method returns a list of available camera IDs. | -| [`selectCamera(EnumCameraPosition)`]({{site.android-api}}camera-enhancer.html#selectcameraenumcameraposition) | Select whether to use front-facing camera or back-facing camera. | -| [`getCameraPosition`]({{site.android-api}}camera-enhancer.html#getcameraposition) | Returns whether the front-facing camera or back-facing camera is selected. | -| [`selectCamera(String)`]({{site.android-api}}camera-enhancer.html#selectcamerastring) | Select a camera from the camera list with the camera ID. | -| [`getSelectedCamera`]({{site.android-api}}camera-enhancer.html#getselectedcamera) | Get the camera ID of the current selected camera. | -| [`getCameraPosition`]({{site.android-api}}camera-enhancer.html#getcameraposition) | Returns whether the device uses a front-facing or rear-facing camera. | -| [`getCameraState`]({{site.android-api}}camera-enhancer.html#getcamerastate) | Get the state of the currently selected camera. | -| [`open`]({{site.android-api}}camera-enhancer.html#open) | Turn on the current selected camera. | -| [`close`]({{site.android-api}}camera-enhancer.html#close) | Turn off the current selected camera. | -| [`pause`]({{site.android-api}}camera-enhancer.html#pause) | Pause the current selected camera. | -| [`resume`]({{site.android-api}}camera-enhancer.html#resume) | Resume the current selected camera. | -| [`turnOnTorch`]({{site.android-api}}camera-enhancer.html#turnontorch) | Turn on the torch. | -| [`turnOffTorch`]({{site.android-api}}camera-enhancer.html#turnofftorch) | Turn off the torch. | -| [`getFrameRate`]({{site.android-api}}camera-enhancer.html#getframerate) | Get the current frame rate. | -| [`getResolutionList`]({{site.android-api}}camera-enhancer.html#getresolutionlist) | Get all available resolutions. | -| [`setResolution`]({{site.android-api}}camera-enhancer.html#setresolution) | Set the resolution to the input value (if the input value is available for the device). | -| [`getResolution`]({{site.android-api}}camera-enhancer.html#getresolution) | Get the current resolution. | -| [`setZoom`]({{site.android-api}}camera-enhancer.html#setzoom) | Set the zoom factor. Once `setZoom` is triggered and approved, the zoom factor of the actived camera will immediately become the input value. | -| [`getMaxZoomFactor`]({{site.android-api}}camera-enhancer.html#getmaxzoomfactor) | Get the maximum available zoom factor. | -| [`setFocus`]({{site.android-api}}camera-enhancer.html#setfocus) | Set the focus position (value range from 0.0f to 1.0f) and focus once at the configured position. | -| [`setFocus(subsequentFocusMode)`]({{site.android-api}}camera-enhancer.html#setfocussubsequentfocusmode) | Trigger a focus at the targeting point and set the subsequent focus mode after focused. | -| [`setScanRegion`]({{site.android-api}}camera-enhancer.html#setscanregion) | Set the scan region with a RegionDefinition value. The frame will be cropped according to the scan region. | -| [`getScanRegion`]({{site.android-api}}camera-enhancer.html#getscanregion) | Get the scan region. | -| [`setScanRegionVisible`]({{site.android-api}}camera-enhancer.html#setscanregionvisible) | Set whether to display the **scanRegion** on the UI. | -| [`getScanRegionVisible`]({{site.android-api}}camera-enhancer.html#getscanregionvisible) | Get whether the **scanRegion** will be displayed on the UI. | -| [`setCameraStateListener`]({{site.android-api}}camera-enhancer.html#setcamerastatelistener ) | Add a `DCECameraStateListener` to receive notification when the camera state changes. | -| [`setFrameRate`]({{site.android-api}}camera-enhancer.html#setframerate) | **Deprecated**. Set the frame rate to the input value (if the input value is available for the device). | - -### Frame Acquiring Methods - -| Method | Description | -| ------ | ----------- | -| [`getFrameFromBuffer`]({{site.android-api}}camera-enhancer.html#getframefrombuffer) | Get the latest frame from the buffer. The input boolean value determines whether the fetched frame will be removed from the buffer. | -| [`addListener`]({{site.android-api}}camera-enhancer.html#addlistener) | Add a listener to the Camera Enhancer instance. | -| [`removeListener`]({{site.android-api}}camera-enhancer.html#removelistener) | Remove a preciously added listener from the Camera Enhancer instance. | -| [`takePhoto`]({{site.android-api}}camera-enhancer.html#takephoto) | Take a photo from the camera and save the image in the memory. | - -### Enhanced Features - -| Method | Description | -| ------ | ----------- | -| [`enableFeatures`]({{site.android-api}}camera-enhancer.html#enablefeatures) | Enable DCE features with Enumeration value. | -| [`disableFeatures`]({{site.android-api}}camera-enhancer.html#disablefeatures) | Disable DCE features with Enumeration value. | -| [`isFeatureEnabled`]({{site.android-api}}camera-enhancer.html#isfeatureenabled) | Returns a boolean value that means whether the feature(s) you input is (are) enabled. | - -### Camera UI Methods - -| Method | Description | -| ------ | ----------- | -| [`setCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Sets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | -| [`getCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Gets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | - -### Advanced Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`updateAdvancedSettingsFromFile`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromfile) | Update advanced parameter settings including filter, sensor and focus settings from a JSON file. | -| [`updateAdvancedSettingsFromString`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromstring) | Update advanced parameter settings including filter, sensor and focus settings from a JSON string. | - -## Auxiliary Classes - -- [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html) -- [`DCEFeedback`]({{site.android-api-auxiliary}}dcefeedback.html) -- [`DCEFrame`]({{site.android-api-auxiliary}}dceframe.html) -- [`RegionDefinition`]({{site.android-api-auxiliary}}region-definition.html) - -## Exception - -- [`CameraEnhancerException`]({{site.android-api-auxiliary}}camera-enhancer-exception.html) -- [`Error Code Reference`]({{ site.dce-enums }}error-code.html?lang=android) - -## Interfaces - -- [`DCECameraStateListener`]({{ site.android-api-auxiliary }}interface-camerastatelistener.html) -- [`DCEFrameListener`]({{ site.android-api-auxiliary }}interface-dceframelistener.html) -- [`DCELicenseVerificationListener`]({{ site.android-api-auxiliary }}interface-licenselistener.html) -- [`DCEPhotoListener`]({{ site.android-api-auxiliary }}interface-dcephotolistener.html) - -## Enumerations - -- [`EnumCameraPosition`]({{ site.dce-enums }}camera-position.html?lang=android) -- [`EnumCameraState`]({{ site.dce-enums }}camera-state.html?lang=android) -- [`EnumEnhancerFeatures`]({{ site.dce-enums }}enhanced-features.html?lang=android) -- [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html?lang=android) -- [`EnumResolution`]({{ site.dce-enums }}resolution.html?lang=android) diff --git a/programming-old/android/api-reference-v2.3.5.md b/programming-old/android/api-reference-v2.3.5.md deleted file mode 100644 index 3fab3826..00000000 --- a/programming-old/android/api-reference-v2.3.5.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -layout: default-layout -title: Android API references - Dynamsoft Camera Enhancer -description: This is the documentation - Android API reference page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, API -needAutoGenerateSidebar: true -breadcrumbText: API references -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference-v2.3.5.html ---- - -# Android API references - -## Primary Class - CameraEnhancer - -### Initialization - -| Method | Description | -| ------ | ----------- | -| [`CameraEnhancer`]({{site.android-api}}camera-enhancer.html#cameraenhancer) | Initialize the `CameraEnhancer` object. | -| [`initLicense`]({{site.android-api}}camera-enhancer.html#initlicense) | Sets product key and activate the SDK. | -| [`getVersion`]({{site.android-api}}camera-enhancer.html#getversion) | Get the SDK version. | - -### Basic Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`getAllCameras`]({{site.android-api}}camera-enhancer.html#getallcameras) | Get all available cameras. This method returns a list of available camera IDs. | -| [`selectCamera(EnumCameraPosition)`]({{site.android-api}}camera-enhancer.html#selectcameraenumcameraposition) | Select whether to use front-facing camera or back-facing camera. | -| [`getCameraPosition`]({{site.android-api}}camera-enhancer.html#getcameraposition) | Returns whether the front-facing camera or back-facing camera is selected. | -| [`selectCamera(String)`]({{site.android-api}}camera-enhancer.html#selectcamerastring) | Select a camera from the camera list with the camera ID. | -| [`getSelectedCamera`]({{site.android-api}}camera-enhancer.html#getselectedcamera) | Get the camera ID of the current selected camera. | -| [`getCameraPosition`]({{site.android-api}}camera-enhancer.html#getcameraposition) | Returns whether the device uses a front-facing or rear-facing camera. | -| [`getCameraState`]({{site.android-api}}camera-enhancer.html#getcamerastate) | Get the state of the currently selected camera. | -| [`open`]({{site.android-api}}camera-enhancer.html#open) | Turn on the current selected camera. | -| [`close`]({{site.android-api}}camera-enhancer.html#close) | Turn off the current selected camera. | -| [`pause`]({{site.android-api}}camera-enhancer.html#pause) | Pause the current selected camera. | -| [`resume`]({{site.android-api}}camera-enhancer.html#resume) | Resume the current selected camera. | -| [`turnOnTorch`]({{site.android-api}}camera-enhancer.html#turnontorch) | Turn on the torch. | -| [`turnOffTorch`]({{site.android-api}}camera-enhancer.html#turnofftorch) | Turn off the torch. | -| [`getFrameRate`]({{site.android-api}}camera-enhancer.html#getframerate) | Get the current frame rate. | -| [`getResolutionList`]({{site.android-api}}camera-enhancer.html#getresolutionlist) | Get all available resolutions. | -| [`setResolution`]({{site.android-api}}camera-enhancer.html#setresolution) | Set the resolution to the input value (if the input value is available for the device). | -| [`getResolution`]({{site.android-api}}camera-enhancer.html#getresolution) | Get the current resolution. | -| [`setZoom`]({{site.android-api}}camera-enhancer.html#setzoom) | Set the zoom factor. Once `setZoom` is triggered and approved, the zoom factor of the actived camera will immediately become the input value. | -| [`getMaxZoomFactor`]({{site.android-api}}camera-enhancer.html#getmaxzoomfactor) | Get the maximum available zoom factor. | -| [`setFocus`]({{site.android-api}}camera-enhancer.html#setfocus) | Set the focus position (value range from 0.0f to 1.0f) and trigger a focus at the configured position. | -| [`setScanRegion`]({{site.android-api}}camera-enhancer.html#setscanregion) | Set the scan region with a RegionDefinition value. The frame will be cropped according to the scan region. | -| [`getScanRegion`]({{site.android-api}}camera-enhancer.html#getscanregion) | Get the scan region. | -| [`setScanRegionVisible`]({{site.android-api}}camera-enhancer.html#setscanregionvisible) | Set whether to display the **scanRegion** on the UI. | -| [`getScanRegionVisible`]({{site.android-api}}camera-enhancer.html#getscanregionvisible) | Get whether the **scanRegion** will be displayed on the UI. | -| [`setFrameRate`]({{site.android-api}}camera-enhancer.html#setframerate) | **Deprecated**. Set the frame rate to the input value (if the input value is available for the device). | - -### Frame Acquiring Methods - -| Method | Description | -| ------ | ----------- | -| [`getFrameFromBuffer`]({{site.android-api}}camera-enhancer.html#getframefrombuffer) | Get the latest frame from the buffer. The input boolean value determines whether the fetched frame will be removed from the buffer. | -| [`addListener`]({{site.android-api}}camera-enhancer.html#addlistener) | Add a listener to the Camera Enhancer instance. | -| [`removeListener`]({{site.android-api}}camera-enhancer.html#removelistener) | Remove a preciously added listener from the Camera Enhancer instance. | -| [`takePhoto`]({{site.android-api}}camera-enhancer.html#takephoto) | Take a photo from the camera and save the image in the memory. | - -### Enhanced Features - -| Method | Description | -| ------ | ----------- | -| [`enableFeatures`]({{site.android-api}}camera-enhancer.html#enablefeatures) | Enable DCE features with Enumeration value. | -| [`disableFeatures`]({{site.android-api}}camera-enhancer.html#disablefeatures) | Disable DCE features with Enumeration value. | -| [`isFeatureEnabled`]({{site.android-api}}camera-enhancer.html#isfeatureenabled) | Returns a boolean value that means whether the feature(s) you input is (are) enabled. | - -### Camera UI Methods - -| Method | Description | -| ------ | ----------- | -| [`setCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Sets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | -| [`getCameraView`]({{site.android-api}}camera-enhancer.html#setcameraview) | Gets camera video streaming UI. Read more from [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html). | - -### Advanced Camera Control Methods - -| Method | Description | -| ------ | ----------- | -| [`updateAdvancedSettingsFromFile`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromfile) | Update advanced parameter settings including filter, sensor and focus settings from a JSON file. | -| [`updateAdvancedSettingsFromString`]({{site.android-api}}camera-enhancer.html#updateadvancedsettingsfromstring) | Update advanced parameter settings including filter, sensor and focus settings from a JSON string. | - -## Auxiliary Classes - -- [`DCEFrame`]({{site.android-api-auxiliary}}dceframe.html) -- [`DCECameraView`]({{site.android-api-auxiliary}}dcecameraview.html) -- [`DCEFeedback`]({{site.android-api-auxiliary}}dcefeedback.html) -- [`RegionDefinition`]({{site.android-api-auxiliary}}region-definition.html) -- [`CameraEnhancerException`]({{site.android-api-auxiliary}}camera-enhancer-exception.html) - -## Interfaces - -- [`DCEFrameListener`]({{ site.android-api-auxiliary }}interface-dceframelistener.html) -- [`DCEPhotoListener`]({{ site.android-api-auxiliary }}interface-dcephotolistener.html) -- [`DCELicenseVerificationListener`]({{ site.android-api-auxiliary }}interface-licenselistener.html) - -## Enumerations - -- [`EnumDCEErrorCode`]({{ site.dce-enums }}error-code.html?lang=android) -- [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html?lang=android) -- [`EnumCameraState`]({{ site.dce-enums }}camera-state.html?lang=android) -- [`EnumEnhancerFeatures`]({{ site.dce-enums }}enhanced-features.html?lang=android) -- [`EnumResolution`]({{ site.dce-enums }}resolution.html?lang=android) -- [`EnumCameraPosition`]({{ site.dce-enums }}camera-position.html?lang=android) diff --git a/programming-old/android/api-reference-v3.0.0.md b/programming-old/android/api-reference-v3.0.0.md deleted file mode 100644 index 91cdb8d7..00000000 --- a/programming-old/android/api-reference-v3.0.0.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: default-layout -title: Android API references - Dynamsoft Camera Enhancer -description: This is the documentation - Android API references page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android API references -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android API references -permalink: /programming/android/api-reference-v3.0.0.html ---- - -# Android API references - -## Primary Class - -* [CameraEnhancer](primary-api/camera-enhancer.html) - -## View Classes - -* [`DCECameraView`](auxiliary-api/dcecameraview.html) -* [`DCEImageEditorView`](auxiliary-api/dceimageeditorview.html) - -## Auxiliary Classes - -* [CameraEnhancerException](auxiliary-api/camera-enhancer-exception.html) -* [DrawingItem](auxiliary-api/drawingitem.html) - * [LineDrawingItem](auxiliary-api/drawingitem-line.html) - * [QuadDrawingItem](auxiliary-api/drawingitem-quad.html) - * [RectDrawingItem](auxiliary-api/drawingitem-rect.html) - * [TextDrawingItem](auxiliary-api/drawingitem-tex.html) -* [DCEDrawingLayer](auxiliary-api/dcedrawinglayer.html) -* [DrawingStyle](auxiliary-api/drawingstyle.html) -* [DrawingStyleManager](auxiliary-api/drawingstylemanager.html) -* [DCEFeedback](auxiliary-api/dcefeedback.html) - -## Interfaces - -* [`CameraStateListener`](auxiliary-api/interface-camerastatelistener.html) -* [`PhotoListener`](auxiliary-api/interface-dcephotolistener.html) -* [`FrameListener`](auxiliary-api/interface-dceframelistener.html) - -## Enumerations - -* [`EnumCameraPosition`]({{ site.dcv-enum }}camera-position.html) -* [`EnumCameraState`]({{ site.dcv-enum }}camera-state.html) -* [`EnumCoordinateBase`]({{ site.dcv-enum }}coordinate-base.html) -* [`EnumDrawingItemMediaType`]({{ site.dcv-enum }}drawing-item-media-type.html) -* [`EnumDrawingItemState`]({{ site.dcv-enum }}drawing-item-state.html) -* [`EnumEnhancedFeatures`]({{ site.dcv-enum }}enhanced-features.html) -* [`EnumFocusMode`]({{ site.dcv-enum }}focus-mode.html) -* [`EnumResolution`]({{ site.dcv-enum }}resolution.html) diff --git a/programming-old/android/auxiliary-api/camera-enhancer-exception-v2.3.11.md b/programming-old/android/auxiliary-api/camera-enhancer-exception-v2.3.11.md deleted file mode 100644 index c1093c1a..00000000 --- a/programming-old/android/auxiliary-api/camera-enhancer-exception-v2.3.11.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: default-layout -title: Android CameraEnhancerException Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android CameraEnhancerException Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, CameraEnhancerException -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android CameraEnhancerException Class -permalink: /programming/android/auxiliary-api/camera-enhancer-exception-v2.3.11.html ---- - -# CameraEnhancerException - -Exception for signaling camera enhancer errors. - -```java -class com.dynamsoft.dce.CameraEnhancerException extends Exception -``` - -| Method Name | Type | -|------|------| -| [`getErrorCode`](#geterrorcode) | int | - -  - -## getErrorCode - -Gets the error code. - -```java -int getErrorCode() -``` - -**Return Value** - -The error code. See Camera Enhancer error code list. - -**Code Snippet** - -```java -try { - mCameraEnhancer.setResolution(EnumResolution.RESOLUTION_1080P); -} catch (CameraEnhancerException e) { - Log.e("DCE", "onCreate: Resolution setting error is:"+e.getErrorCode()); -} -``` diff --git a/programming-old/android/auxiliary-api/camera-enhancer-exception-v2.3.12.md b/programming-old/android/auxiliary-api/camera-enhancer-exception-v2.3.12.md deleted file mode 100644 index f911379f..00000000 --- a/programming-old/android/auxiliary-api/camera-enhancer-exception-v2.3.12.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: default-layout -title: Android CameraEnhancerException Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android CameraEnhancerException Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, CameraEnhancerException -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android CameraEnhancerException Class -permalink: /programming/android/auxiliary-api/camera-enhancer-exception-v2.3.12.html ---- - -# CameraEnhancerException - -Exception for signaling camera enhancer errors. - -```java -class com.dynamsoft.dce.CameraEnhancerException extends Exception -``` - -| Method Name | Type | -|------|------| -| [`getErrorCode`](#geterrorcode) | int | - -  - -## getErrorCode - -Gets the error code. - -```java -int getErrorCode() -``` - -**Return Value** - -The error code. See Camera Enhancer error code list. - -**Code Snippet** - -```java -try { - mCameraEnhancer.setResolution(EnumResolution.RESOLUTION_1080P); -} catch (CameraEnhancerException e) { - Log.e("DCE", "onCreate: Resolution setting error is:"+e.getErrorCode()); -} -``` diff --git a/programming-old/android/auxiliary-api/camera-enhancer-exception-v3.0.3.md b/programming-old/android/auxiliary-api/camera-enhancer-exception-v3.0.3.md deleted file mode 100644 index 24f02df8..00000000 --- a/programming-old/android/auxiliary-api/camera-enhancer-exception-v3.0.3.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: default-layout -title: Android CameraEnhancerException Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android CameraEnhancerException Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, CameraEnhancerException -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android CameraEnhancerException Class -permalink: /programming/android/auxiliary-api/camera-enhancer-exception-v3.0.3.html ---- - -# CameraEnhancerException - -Exception for signaling camera enhancer errors. - -```java -class com.dynamsoft.dce.CameraEnhancerException extends Exception -``` - -| Method Name | Type | -|------|------| -| [`getErrorCode`](#geterrorcode) | int | - -  - -## getErrorCode - -Gets the error code. - -```java -int getErrorCode() -``` - -**Return Value** - -The error code. See Camera Enhancer error code list. - -**Code Snippet** - -```java -try { - mCameraEnhancer.setResolution(EnumResolution.RESOLUTION_1080P); -} catch (CameraEnhancerException e) { - Log.e("DCE", "onCreate: Resolution setting error is:"+e.getErrorCode()); -} -``` diff --git a/programming-old/android/auxiliary-api/dcecameraview-v1.0.3.md b/programming-old/android/auxiliary-api/dcecameraview-v1.0.3.md deleted file mode 100644 index 9b5cd2a9..00000000 --- a/programming-old/android/auxiliary-api/dcecameraview-v1.0.3.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -layout: default-layout -title: Android CameraView Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android CameraView Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, CameraView -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android CameraView Class -permalink: /programming/android/auxiliary-api/dcecameraview-v1.0.3.html ---- - -# CameraView - -This page is for `CameraView` Class. `CameraView` is designed to Make basic settings on the overlay. - -```java -class com.dynamsoft.dce.CameraView -``` - -| Method Name | Description | -|------|------| -| [`addOverlay`](#addoverlay) | Add overlay | -| [`removeOverlay`](#removeoverlay) | Remove overlay | -| [`setBrushColor`](#setbrushcolor) | Set the brush color | - -  - -## addOverlay - -Add overlay on located barcode. - -```java -void addOverlay() -``` - -**Code Snippet** - -```java -cameraView.addOverlay(); -``` - -  - -## removeOverlay - -Remove the overlay. - -```java -void removeOverlay() -``` - -**Code Snippet** - -```java -cameraView.removeOverlay(); -``` - -  - -## setBrushColor - -```java -void setBrushColor(String color) -``` - -**Parameters** - -`String`: A string value that refers to a color. - -**Code Snippet** - -```java -cameraView.setBrushColor("Put your color string here"); -``` diff --git a/programming-old/android/auxiliary-api/dcecameraview-v2.0.0.md b/programming-old/android/auxiliary-api/dcecameraview-v2.0.0.md deleted file mode 100644 index 2f3e2c99..00000000 --- a/programming-old/android/auxiliary-api/dcecameraview-v2.0.0.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -layout: default-layout -title: Android DCECameraView Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android DCECameraView Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCECameraView -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCECameraView Class -permalink: /programming/android/auxiliary-api/dcecameraview-v2.0.0.html ---- - -# DCECameraView - -The camera view is the main UI view of the DCE SDK. It is designed to display the video preview, overlay, viewfinder, etc. - -```Java -class com.dynamsoft.dce.DCECameraView extends RelativeLayout -``` - -| Method Name | Description | -|------|------| -| [`DCECameraView`](#dcecameraview) | Initialize the `DCECameraView` object. | -| [`setOverlayVisible`](#setoverlayvisible) | This method controls whether the camera view to display coloured and translucent overlay. | -| [`getOverlayVisible`](#getoverlayvisible) | Get the visibility (true: visible/ false: invisible) of the overlay. | -| [`setOverlayColour`](#setoverlaycolour) | Set the stroke and fill colour of the overlay. | -| [`setViewfinderVisible`](#setviewfindervisible) | This method controls whether to display a viewfinder. | -| [`getViewfinderVisible`](#getviewfindervisible) | Get the visibility (true: visible/ false: invisible) of the viewfinder. | -| [`setViewfinder`](#setviewfinder) | Set the position and the size of the viewfinder. | - -  - -## DCECameraView - -Initialize the `DCECameraView` object. - -```java -DCECameraView(android.content.Context context) -``` - -**Parameters** - -`context`: An instance to global information about an application environment. - -  - -## setOverlayVisible - -This method controls whether the camera view displays coloured and translucent overlay. - -```java -void setOverlayVisible(boolean overlayVisibile) -``` - -**Parameters** - -`overlayVisibile`: If true, the camera view will draw and display overlay according to the position and colour settings. Otherwise, the overlay will be hidden. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayVisible(true); -``` - -  - -## getOverlayVisible - -Get the visibility (true: visible/ false: invisible) of the overlay. - -```java -boolean getOverlayVisible() -``` - -**Return Value** - -The visibility (true: visible/ false: invisible) of the overlay. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean isVisible = dceCameraView.getOverlayVisible(); -``` - -  - - -## setOverlayColour - -Set the stroke and fill colour of the overlay. - -```java -void setOverlayColour(int strokeARGB, int fillARGB) -``` - -**Parameters** - -`strokeARGB`: The colour code of the overlay stroke. -`fillARGB`: The colour code of the overlay stroke. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayColour(0xff00ff00, 0x00000000); -``` - -  - -## setViewfinderVisible - -This method controls whether to display a viewfinder. - -```java -void setViewfinderVisible(boolean viewfinderVisible) -``` - -**Parameters** - -`viewfinderVisible`: A boolean value that means whether the viewfinder is visible or not. Users can define the position and size of the viewfinder via method [`setViewfinder`](#setviewfinder). The viewfinder will be created based on the default value if the `setViewfinder` has never been triggered. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinderVisible(true); -``` - -  - -## getViewfinderVisible - -Get the visibility (true: visible/ false: invisible) of the viewfinder. - -**Return Value** - -A boolean value that means whether the viewfinder is visible. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean flag = dceCameraView.getViewfinderVisible(); -``` - -  - -## setViewfinder - -Set the position and the size of the viewfinder. - -```java -void setViewfinder(float left, float top, float right, float bottom) throws CameraEnhancerException -``` - -**Parameters** - -`left`: The distance (by percentage) between the left border of the viewfinder and the left side of the screen. The default value is 0.15. -`top`: The distance (by percentage) between the top border of the viewfinder and the top side of the screen. The default value is 0.3. -`right`: The distance (by percentage) between the right border of the viewfinder and the left side of the screen. The default value is 0.85. -`bottom`: The distance (by percentage) between the bottom border of the viewfinder and the top side of the screen. The default value is 0.7. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinder(0.2, 0.3, 0.8, 0.7); -``` - -**Remarks** - -The viewfinder is built based on the screen coordinate system. The origin of the coordinate is the left-top point of the mobile device. The `left border` of the viewfinder always means the closest border that parallels to the left side of the mobile device no matter how the mobile device is rotated. diff --git a/programming-old/android/auxiliary-api/dcecameraview-v2.1.0.md b/programming-old/android/auxiliary-api/dcecameraview-v2.1.0.md deleted file mode 100644 index 6c5648e4..00000000 --- a/programming-old/android/auxiliary-api/dcecameraview-v2.1.0.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -layout: default-layout -title: Android DCECameraView Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android DCECameraView Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCECameraView -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCECameraView Class -permalink: /programming/android/auxiliary-api/dcecameraview-v2.1.0.html ---- - -# DCECameraView - -The camera view is the main UI view of the DCE SDK. It is designed to display the video preview, overlay, viewfinder, etc. - -```java -class com.dynamsoft.dce.DCECameraView extends RelativeLayout -``` - -| Method Name | Description | -|------|------| -| [`DCECameraView`](#dcecameraview) | Initialize the `DCECameraView` object. | -| [`setOverlayVisible`](#setoverlayvisible) | This method controls whether the camera view to display coloured and translucent overlay. | -| [`getOverlayVisible`](#getoverlayvisible) | Get the visibility (true: visible/ false: invisible) of the overlay. | -| [`setOverlayColour`](#setoverlaycolour) | Set the stroke and fill colour of the overlay. | -| [`setViewfinderVisible`](#setviewfindervisible) | This method controls whether to display a viewfinder. | -| [`getViewfinderVisible`](#getviewfindervisible) | Get the visibility (true: visible/ false: invisible) of the viewfinder. | -| [`setViewfinder`](#setviewfinder) | Set the position and the size of the viewfinder. | -| [`setTorchButton`](#settorchbutton) | Set the position of the torch button. The visibility of the torch button will be set to true as well. | -| [`setTorchButtonVisible`](#settorchbuttonvisible) | Set the visibility of the torch button. The torch button icon is pre-set in the SDK. | -| [`getTorchButtonVisible`](#gettorchbuttonvisible) | Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. | - -  - -## DCECameraView - -Initialize the `DCECameraView` object. - -```java -DCECameraView(android.content.Context context) -``` - -**Parameters** - -`context`: An instance of global information about an application environment. - -  - -## setOverlayVisible - -This method controls whether the camera view displays coloured and translucent overlays. - -```java -void setOverlayVisible(boolean overlayVisibile) -``` - -**Parameters** - -`overlayVisibile`: If true, the camera view will draw and display overlays according to the position and colour settings. Otherwise, the overlay will be hidden. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayVisible(true); -``` - -  - -## getOverlayVisible - -Get the visibility (true: visible/ false: invisible) of the overlay. - -```java -boolean getOverlayVisible() -``` - -**Return Value** - -The visibility (true: visible/ false: invisible) of the overlay. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean isVisible = dceCameraView.getOverlayVisible(); -``` - -  - -## setOverlayColour - -Set the stroke and fill colour of the overlays. - -```java -void setOverlayColour(int strokeARGB, int fillARGB) -``` - -**Parameters** - -`strokeARGB`: The colour code of the overlays stroke. -`fillARGB`: The colour code of the overlays stroke. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayColour(0xff00ff00, 0x00000000); -``` - -  - -## setViewfinderVisible - -This method controls whether to display a viewfinder. - -```java -void setViewfinderVisible(boolean viewfinderVisible) -``` - -**Parameters** - -`viewfinderVisible`: A boolean value that means whether the viewfinder is visible or not. Users can define the position and size of the viewfinder via method [`setViewfinder`](#setviewfinder). The viewfinder will be created based on the default value if the `setViewfinder` has never been triggered. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinderVisible(true); -``` - -  - -## getViewfinderVisible - -Get the visibility (true: visible/ false: invisible) of the viewfinder. - -**Return Value** - -A boolean value means whether the viewfinder is visible. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean flag = dceCameraView.getViewfinderVisible(); -``` - -  - -## setViewfinder - -Set the position and the size of the viewfinder. - -```java -void setViewfinder(float left, float top, float right, float bottom) throws CameraEnhancerException -``` - -**Parameters** - -`left`: The distance (by percentage) between the left border of the viewfinder and the left side of the screen. The default value is 0.15. -`top`: The distance (by percentage) between the top border of the viewfinder and the top side of the screen. The default value is 0.3. -`right`: The distance (by percentage) between the right border of the viewfinder and the left side of the screen. The default value is 0.85. -`bottom`: The distance (by percentage) between the bottom border of the viewfinder and the top side of the screen. The default value is 0.7. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinder(0.2, 0.3, 0.8, 0.7); -``` - -**Remarks** - -The viewfinder is built based on the screen coordinate system. The origin of the coordinate is the left-top point of the mobile device. The `left border` of the viewfinder always means the closest border that parallels to the left side of the mobile device no matter how the mobile device is rotated. - -  - -## setTorchButton - -Set the position of the torch button. The visibility of the torch button will be set to true as well. - -```java -void setTorchButton(Point torchButtonPosition) -``` - -**Parameters** - -`torchButtonPosition`: The `torchButtonPosition` illustrates the coordinates of the torch button on the camera view. The x coordinate of the point stands for the pixel distance between the point and the left edge of the screen. The y coordinate of the point stands for the pixel distance between the point and the top edge of the screen. - -
    -

    setScanRegion

    -

    torchButtonPosition is the position on the camera view

    -
    - -**Code Snippet** - -```java -Point torchButtonPosition = new Point(); -torchButtonPosition.x = 100; -torchButtonPosition.y = 100; -dceCameraView.setTorchButtonPosition(torchButtonPosition); -``` - -  - -## setTorchButtonVisible - -Set the visibility of the torch button. The torch button icon is preset in the SDK. If the `torchButtonPosition` has never been configured, the `torchButton` will be displayed on the default position. Currently, the icon and the size of the button are not available for setting. - -```java -void setTorchButtonVisible(boolean isTorchButtonVisible) -``` - -**Parameters** - -`isTorchButtonVisible`: When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -dceCameraView.setTorchButtonVisible(true); -``` - -  - -## getTorchButtonVisible - -Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. - -```java -boolean getTorchButtonVisible() -``` - -**Return Value** - -A boolean value. When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -boolean isTorchButtonVisible = dceCameraView.getTorchButtonVisible(); -``` diff --git a/programming-old/android/auxiliary-api/dcecameraview-v2.3.11.md b/programming-old/android/auxiliary-api/dcecameraview-v2.3.11.md deleted file mode 100644 index f1e53f9a..00000000 --- a/programming-old/android/auxiliary-api/dcecameraview-v2.3.11.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -layout: default-layout -title: Android DCECameraView Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DCECameraView Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCECameraView -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCECameraView Class -permalink: /programming/android/auxiliary-api/dcecameraview-v2.3.11.html ---- - -# DCECameraView Class - -The camera view is the main UI view of the DCE SDK. It is designed to display the video preview, overlay, viewfinder, etc. - -```java -class com.dynamsoft.dce.DCECameraView -``` - -| Method Name | Description | -|------|------| -| [`DCECameraView`](#dcecameraview) | Initialize the `DCECameraView` object. | -| [`setTorchButton`](#settorchbutton) | Set the position, size and image of the torch button. | -| [`setTorchButtonVisible`](#settorchbuttonvisible) | Set the visibility of the torch button. The torch button icon is pre-set in the SDK. | -| [`getTorchButtonVisible`](#gettorchbuttonvisible) | Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. | -| [`getDrawingLayer`](#getdrawinglayer) | Get the [`DCEDrawingLayer`](dcedrawinglayer.html) instance with the layer ID. | -| [`createDrawingLayer`](#createdrawinglayer) | Create a user-defined [`DCEDrawingLayer`](dcedrawinglayer.html) instance. | -| [`getVisibleRegionOfVideo`](#getvisibleregionofvideo) | Get the visible region of the video streaming. | -| [`setOverlayVisible`](#setoverlayvisible) | **Deprecated**. This method controls whether the camera view to display coloured and translucent overlay. | -| [`getOverlayVisible`](#getoverlayvisible) | **Deprecated**. Get the visibility (true: visible/ false: invisible) of the overlay. | -| [`setOverlayColour`](#setoverlaycolour) | **Deprecated**. Set the stroke and fill colour of the overlay. | -| [`setViewfinderVisible`](#setviewfindervisible) | **Deprecated**. This method controls whether to display a viewfinder. | -| [`getViewfinderVisible`](#getviewfindervisible) | **Deprecated**. Get the visibility (true: visible/ false: invisible) of the viewfinder. | -| [`setViewfinder`](#setviewfinder) | **Deprecated**. Set the position and the size of the viewfinder. | - -  - -## DCECameraView - -Initialize the `DCECameraView` object. - -```java -DCECameraView(android.content.Context context) -``` - -**Parameters** - -`context`: An instance of global information about an application environment. - -  - -## setTorchButton - -Set the styles of the button with the position, size and images. - -```java -void setTorchButton(Point torchButtonPosition, int width, int height, Drawable torchOnImage, Drawable torchOffImage) -``` - -**Parameters** - -`torchButtonPosition`: The coordinate of the top-left corner of the torch button. You can input a null value to apply no changes to the position of the torch button. -`width`: The width of the torch button. You can input a null value to apply no changes to the width of the torch button. -`height`: The height of the torch button. You can input a null value to apply no changes to the height of the torch button. -`torchOnImage`: Display this image when the torch is on. You can input a null value to apply no changes to the image of the torch button when the torch is on. -`torchOffImage`: Display this image when the torch is off. You can input a null value to apply no changes to the image of the torch button when the torch is off. - -**Code Snippet** - -```java -cameraView.setTorchButton(new Point(100,100), 50,50, getDrawable(R.drawable.torch_on_image), getDrawable(R.drawable.torch_off_image)); -``` - -**Remarks** - -Method `setTorchButton(Point torchButtonPosition)` is deprecated. Please use the new `setTorchButton` method. - -  - -## setTorchButtonVisible - -Set the visibility of the torch button. The torch button icon is preset in the SDK. If the `torchButtonPosition` has never been configured, the `torchButton` will be displayed on the default position. Currently, the icon and the size of the button are not available for setting. - -```java -void setTorchButtonVisible(boolean isTorchButtonVisible) -``` - -**Parameters** - -`isTorchButtonVisible`: When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -dceCameraView.setTorchButtonVisible(true); -``` - -  - -## getTorchButtonVisible - -Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. - -```java -Boolean getTorchButtonVisible() -``` - -**Return Value** - -A boolean value. When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -Boolean isTorchButtonVisible = dceCameraView.getTorchButtonVisible(); -``` - -  - -## getDrawingLayer - -Get the [`DCEDrawingLayer`](dcedrawinglayer.html) instance with the layer ID. - -```java -public DCEDrawingLayer getDrawingLayer(int id); -``` - -**Parameters** - -`id`: The id of the target [`DCEDrawingLayer`](dcedrawinglayer.html). - -**Parameters** - -`id`: The id of the `DrawingLayer`. - -**Available ID List** - -| Layer | ID | -| ----- | -- | -| DDN_LAYER_ID | 1 | -| DBR_LAYER_ID | 2 | -| DLR_LAYER_ID | 3 | -| USER_DEFINED_LAYER_BASE_ID | 100 | - -**Code Snippet** - -```java -DCEDrawingLayer layer = dceCameraView.getDrawingLayer(DCEDrawingLayer.DDN_LAYER_ID); -``` - -  - -## createDrawingLayer - -Create a user-defined [`DCEDrawingLayer`](dcedrawinglayer.html) instance. - -```java -public DCEDrawingLayer createDrawingLayer(); -``` - -**Return Value** - -An instance of [`DCEDrawingLayer`](dcedrawinglayer.html). - -**Code Snippet** - -```java -DCEDrawingLayer layer = dceCameraView.createDrawingLayer(); -``` - -## setOverlayVisible - -> The method is deprecated - -This method controls whether the camera view displays coloured and translucent overlays. - -```java -void setOverlayVisible(boolean overlayVisibile) -``` - -**Parameters** - -`overlayVisibile`: If true, the camera view will draw and display overlays according to the position and colour settings. Otherwise, the overlay will be hidden. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayVisible(true); -``` - -  - -## getOverlayVisible - -> The method is deprecated - -Get the visibility (true: visible/ false: invisible) of the overlay. - -```java -boolean getOverlayVisible() -``` - -**Return Value** - -The visibility (true: visible/ false: invisible) of the overlay. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean isVisible = dceCameraView.getOverlayVisible(); -``` - -  - -## setOverlayColour - -> The method is deprecated - -Set the stroke and fill colour of the overlays. - -```java -void setOverlayColour(int strokeARGB, int fillARGB) -``` - -**Parameters** - -`strokeARGB`: The colour code of the overlays stroke. -`fillARGB`: The colour code of the overlays stroke. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayColour(0xff00ff00, 0x00000000); -``` - -  - -## setViewfinderVisible - -> The method is deprecated - -This method controls whether to display a viewfinder. - -```java -void setViewfinderVisible(boolean viewfinderVisible) -``` - -**Parameters** - -`viewfinderVisible`: A boolean value that means whether the viewfinder is visible or not. Users can define the position and size of the viewfinder via method [`setViewfinder`](#setviewfinder). The viewfinder will be created based on the default value if the `setViewfinder` has never been triggered. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinderVisible(true); -``` - -  - -## getViewfinderVisible - -> The method is deprecated - -Get the visibility (true: visible/ false: invisible) of the viewfinder. - -```java -boolean getViewfinderVisible() -``` - -**Return Value** - -A boolean value means whether the viewfinder is visible. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean flag = dceCameraView.getViewfinderVisible(); -``` - -  - -## setViewfinder - -> The method is deprecated - -Set the position and the size of the viewfinder. - -```java -void setViewfinder(float left, float top, float right, float bottom) throws CameraEnhancerException -``` - -**Parameters** - -`left`: The distance (by percentage) between the left border of the viewfinder and the left side of the screen. The default value is 0.15. -`top`: The distance (by percentage) between the top border of the viewfinder and the top side of the screen. The default value is 0.3. -`right`: The distance (by percentage) between the right border of the viewfinder and the left side of the screen. The default value is 0.85. -`bottom`: The distance (by percentage) between the bottom border of the viewfinder and the top side of the screen. The default value is 0.7. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinder(0.2, 0.3, 0.8, 0.7); -``` - -**Remarks** - -The viewfinder is built based on the screen coordinate system. The origin of the coordinate is the left-top point of the mobile device. The `left border` of the viewfinder always means the closest border that parallels to the left side of the mobile device no matter how the mobile device is rotated. - -  - -## getVisibleRegionOfVideo - -Get the visible region of the video streaming. - -When the shape of your camera view is quite different from the shape of the video streaming, there might exist a large area that is invisible. You can use this method to get the region of this invisible area. - -
    -

    visible-region

    -

    What's Visible Region

    -
    - -**Return Value** - -An `iRegionDefinition` object. You can use this object to set the scan region so that the invisible areas will be cropped from the video frames. - -**Code Snippet** - -```java -iRegionDefinition visibleRegion = cameraView.getVisibleRegion(); -cameraEnhancer.setScanRegion(visibleRegion); -``` diff --git a/programming-old/android/auxiliary-api/dcecameraview-v2.3.12.md b/programming-old/android/auxiliary-api/dcecameraview-v2.3.12.md deleted file mode 100644 index fb9405a1..00000000 --- a/programming-old/android/auxiliary-api/dcecameraview-v2.3.12.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -layout: default-layout -title: Android DCECameraView Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DCECameraView Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCECameraView -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCECameraView Class -permalink: /programming/android/auxiliary-api/dcecameraview-v2.3.12.html ---- - -# DCECameraView Class - -The camera view is the main UI view of the DCE SDK. It is designed to display the video preview, overlay, viewfinder, etc. - -```java -class com.dynamsoft.dce.DCECameraView -``` - -| Method Name | Description | -|------|------| -| [`DCECameraView`](#dcecameraview) | Initialize the `DCECameraView` object. | -| [`setTorchButton`](#settorchbutton) | Set the position, size and image of the torch button. | -| [`setTorchButtonVisible`](#settorchbuttonvisible) | Set the visibility of the torch button. The torch button icon is pre-set in the SDK. | -| [`getTorchButtonVisible`](#gettorchbuttonvisible) | Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. | -| [`getDrawingLayer`](#getdrawinglayer) | Get the [`DCEDrawingLayer`](dcedrawinglayer.html) instance with the layer ID. | -| [`createDrawingLayer`](#createdrawinglayer) | Create a user-defined [`DCEDrawingLayer`](dcedrawinglayer.html) instance. | -| [`getVisibleRegionOfVideo`](#getvisibleregionofvideo) | Get the visible region of the video streaming. | -| [`setOverlayVisible`](#setoverlayvisible) | **Deprecated**. This method controls whether the camera view to display coloured and translucent overlay. | -| [`getOverlayVisible`](#getoverlayvisible) | **Deprecated**. Get the visibility (true: visible/ false: invisible) of the overlay. | -| [`setOverlayColour`](#setoverlaycolour) | **Deprecated**. Set the stroke and fill colour of the overlay. | -| [`setViewfinderVisible`](#setviewfindervisible) | **Deprecated**. This method controls whether to display a viewfinder. | -| [`getViewfinderVisible`](#getviewfindervisible) | **Deprecated**. Get the visibility (true: visible/ false: invisible) of the viewfinder. | -| [`setViewfinder`](#setviewfinder) | **Deprecated**. Set the position and the size of the viewfinder. | - -  - -## DCECameraView - -Initialize the `DCECameraView` object. - -```java -DCECameraView(android.content.Context context) -``` - -**Parameters** - -`context`: An instance of global information about an application environment. - -  - -## setTorchButton - -Set the styles of the button with the position, size and images. - -```java -void setTorchButton(Point torchButtonPosition, int width, int height, Drawable torchOnImage, Drawable torchOffImage) -``` - -**Parameters** - -`torchButtonPosition`: The coordinate of the top-left corner of the torch button. You can input a null value to apply no changes to the position of the torch button. -`width`: The width of the torch button. You can input a null value to apply no changes to the width of the torch button. -`height`: The height of the torch button. You can input a null value to apply no changes to the height of the torch button. -`torchOnImage`: Display this image when the torch is on. You can input a null value to apply no changes to the image of the torch button when the torch is on. -`torchOffImage`: Display this image when the torch is off. You can input a null value to apply no changes to the image of the torch button when the torch is off. - -**Code Snippet** - -```java -cameraView.setTorchButton(new Point(100,100), 50,50, getDrawable(R.drawable.torch_on_image), getDrawable(R.drawable.torch_off_image)); -``` - -**Remarks** - -Method `setTorchButton(Point torchButtonPosition)` is deprecated. Please use the new `setTorchButton` method. - -  - -## setTorchButtonVisible - -Set the visibility of the torch button. The torch button icon is preset in the SDK. If the `torchButtonPosition` has never been configured, the `torchButton` will be displayed on the default position. Currently, the icon and the size of the button are not available for setting. - -```java -void setTorchButtonVisible(boolean isTorchButtonVisible) -``` - -**Parameters** - -`isTorchButtonVisible`: When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -dceCameraView.setTorchButtonVisible(true); -``` - -  - -## getTorchButtonVisible - -Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. - -```java -Boolean getTorchButtonVisible() -``` - -**Return Value** - -A boolean value. When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -Boolean isTorchButtonVisible = dceCameraView.getTorchButtonVisible(); -``` - -  - -## getDrawingLayer - -Get the [`DCEDrawingLayer`](dcedrawinglayer.html) instance with the layer ID. - -```java -public DCEDrawingLayer getDrawingLayer(int id); -``` - -**Parameters** - -`id`: The id of the target [`DCEDrawingLayer`](dcedrawinglayer.html). - -**Parameters** - -`id`: The id of the `DrawingLayer`. - -**Available ID List** - -| Layer | ID | -| ----- | -- | -| DDN_LAYER_ID | 1 | -| DBR_LAYER_ID | 2 | -| DLR_LAYER_ID | 3 | -| USER_DEFINED_LAYER_BASE_ID | 100 | - -**Code Snippet** - -```java -DCEDrawingLayer layer = dceCameraView.getDrawingLayer(DCEDrawingLayer.DDN_LAYER_ID); -``` - -  - -## createDrawingLayer - -Create a user-defined [`DCEDrawingLayer`](dcedrawinglayer.html) instance. - -```java -public DCEDrawingLayer createDrawingLayer(); -``` - -**Return Value** - -An instance of [`DCEDrawingLayer`](dcedrawinglayer.html). - -**Code Snippet** - -```java -DCEDrawingLayer layer = dceCameraView.createDrawingLayer(); -``` - -## setOverlayVisible - -> The method is deprecated - -This method controls whether the camera view displays coloured and translucent overlays. - -```java -void setOverlayVisible(boolean overlayVisibile) -``` - -**Parameters** - -`overlayVisibile`: If true, the camera view will draw and display overlays according to the position and colour settings. Otherwise, the overlay will be hidden. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayVisible(true); -``` - -  - -## getOverlayVisible - -> The method is deprecated - -Get the visibility (true: visible/ false: invisible) of the overlay. - -```java -boolean getOverlayVisible() -``` - -**Return Value** - -The visibility (true: visible/ false: invisible) of the overlay. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean isVisible = dceCameraView.getOverlayVisible(); -``` - -  - -## setOverlayColour - -> The method is deprecated - -Set the stroke and fill colour of the overlays. - -```java -void setOverlayColour(int strokeARGB, int fillARGB) -``` - -**Parameters** - -`strokeARGB`: The colour code of the overlays stroke. -`fillARGB`: The colour code of the overlays stroke. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayColour(0xff00ff00, 0x00000000); -``` - -  - -## setViewfinderVisible - -> The method is deprecated - -This method controls whether to display a viewfinder. - -```java -void setViewfinderVisible(boolean viewfinderVisible) -``` - -**Parameters** - -`viewfinderVisible`: A boolean value that means whether the viewfinder is visible or not. Users can define the position and size of the viewfinder via method [`setViewfinder`](#setviewfinder). The viewfinder will be created based on the default value if the `setViewfinder` has never been triggered. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinderVisible(true); -``` - -  - -## getViewfinderVisible - -> The method is deprecated - -Get the visibility (true: visible/ false: invisible) of the viewfinder. - -```java -boolean getViewfinderVisible() -``` - -**Return Value** - -A boolean value means whether the viewfinder is visible. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean flag = dceCameraView.getViewfinderVisible(); -``` - -  - -## setViewfinder - -> The method is deprecated - -Set the position and the size of the viewfinder. - -```java -void setViewfinder(float left, float top, float right, float bottom) throws CameraEnhancerException -``` - -**Parameters** - -`left`: The distance (by percentage) between the left border of the viewfinder and the left side of the screen. The default value is 0.15. -`top`: The distance (by percentage) between the top border of the viewfinder and the top side of the screen. The default value is 0.3. -`right`: The distance (by percentage) between the right border of the viewfinder and the left side of the screen. The default value is 0.85. -`bottom`: The distance (by percentage) between the bottom border of the viewfinder and the top side of the screen. The default value is 0.7. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinder(0.2, 0.3, 0.8, 0.7); -``` - -**Remarks** - -The viewfinder is built based on the screen coordinate system. The origin of the coordinate is the left-top point of the mobile device. The `left border` of the viewfinder always means the closest border that parallels to the left side of the mobile device no matter how the mobile device is rotated. - -  - -## getVisibleRegionOfVideo - -Get the visible region of the video streaming. - -When the shape of your camera view is quite different from the shape of the video streaming, there might exist a large area that is invisible. You can use this method to get the region of this invisible area. - -
    -

    visible-region

    -

    What's Visible Region

    -
    - -**Return Value** - -An `iRegionDefinition` object. You can use this object to set the scan region so that the invisible areas will be cropped from the video frames. - -**Code Snippet** - -```java -iRegionDefinition visibleRegion = cameraView.getVisibleRegion(); -cameraEnhancer.setScanRegion(visibleRegion); -``` diff --git a/programming-old/android/auxiliary-api/dcecameraview-v2.3.5.md b/programming-old/android/auxiliary-api/dcecameraview-v2.3.5.md deleted file mode 100644 index 954f0085..00000000 --- a/programming-old/android/auxiliary-api/dcecameraview-v2.3.5.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -layout: default-layout -title: Android DCECameraView Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android DCECameraView Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCECameraView -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCECameraView Class -permalink: /programming/android/auxiliary-api/dcecameraview-v2.3.5.html ---- - -# DCECameraView - -The camera view is the main UI view of the DCE SDK. It is designed to display the video preview, overlay, viewfinder, etc. - -```java -class com.dynamsoft.dce.DCECameraView extends RelativeLayout -``` - -| Method Name | Description | -|------|------| -| [`DCECameraView`](#dcecameraview) | Initialize the `DCECameraView` object. | -| [`setOverlayVisible`](#setoverlayvisible) | This method controls whether the camera view to display coloured and translucent overlay. | -| [`getOverlayVisible`](#getoverlayvisible) | Get the visibility (true: visible/ false: invisible) of the overlay. | -| [`setOverlayColour`](#setoverlaycolour) | Set the stroke and fill colour of the overlay. | -| [`setViewfinderVisible`](#setviewfindervisible) | This method controls whether to display a viewfinder. | -| [`getViewfinderVisible`](#getviewfindervisible) | Get the visibility (true: visible/ false: invisible) of the viewfinder. | -| [`setViewfinder`](#setviewfinder) | Set the position and the size of the viewfinder. | -| [`setTorchButton`](#settorchbutton) | Set the position, size and image of the torch button. | -| [`setTorchButtonVisible`](#settorchbuttonvisible) | Set the visibility of the torch button. The torch button icon is pre-set in the SDK. | -| [`getTorchButtonVisible`](#gettorchbuttonvisible) | Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. | - -  - - - -## DCECameraView - -Initialize the `DCECameraView` object. - -```java -DCECameraView(android.content.Context context) -``` - -**Parameters** - -`context`: An instance of global information about an application environment. - -  - -## setOverlayVisible - -This method controls whether the camera view displays coloured and translucent overlays. - -```java -void setOverlayVisible(boolean overlayVisibile) -``` - -**Parameters** - -`overlayVisibile`: If true, the camera view will draw and display overlays according to the position and colour settings. Otherwise, the overlay will be hidden. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayVisible(true); -``` - -  - -## getOverlayVisible - -Get the visibility (true: visible/ false: invisible) of the overlay. - -```java -boolean getOverlayVisible() -``` - -**Return Value** - -The visibility (true: visible/ false: invisible) of the overlay. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean isVisible = dceCameraView.getOverlayVisible(); -``` - -  - -## setOverlayColour - -Set the stroke and fill colour of the overlays. - -```java -void setOverlayColour(int strokeARGB, int fillARGB) -``` - -**Parameters** - -`strokeARGB`: The colour code of the overlays stroke. -`fillARGB`: The colour code of the overlays stroke. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayColour(0xff00ff00, 0x00000000); -``` - -  - -## setViewfinderVisible - -This method controls whether to display a viewfinder. - -```java -void setViewfinderVisible(boolean viewfinderVisible) -``` - -**Parameters** - -`viewfinderVisible`: A boolean value that means whether the viewfinder is visible or not. Users can define the position and size of the viewfinder via method [`setViewfinder`](#setviewfinder). The viewfinder will be created based on the default value if the `setViewfinder` has never been triggered. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinderVisible(true); -``` - -  - -## getViewfinderVisible - -Get the visibility (true: visible/ false: invisible) of the viewfinder. - -**Return Value** - -A boolean value means whether the viewfinder is visible. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean flag = dceCameraView.getViewfinderVisible(); -``` - -  - -## setViewfinder - -Set the position and the size of the viewfinder. - -```java -void setViewfinder(float left, float top, float right, float bottom) throws CameraEnhancerException -``` - -**Parameters** - -`left`: The distance (by percentage) between the left border of the viewfinder and the left side of the screen. The default value is 0.15. -`top`: The distance (by percentage) between the top border of the viewfinder and the top side of the screen. The default value is 0.3. -`right`: The distance (by percentage) between the right border of the viewfinder and the left side of the screen. The default value is 0.85. -`bottom`: The distance (by percentage) between the bottom border of the viewfinder and the top side of the screen. The default value is 0.7. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinder(0.2, 0.3, 0.8, 0.7); -``` - -**Remarks** - -The viewfinder is built based on the screen coordinate system. The origin of the coordinate is the left-top point of the mobile device. The `left border` of the viewfinder always means the closest border that parallels to the left side of the mobile device no matter how the mobile device is rotated. - -  - -## setTorchButton - -Set the styles of the button with the position, size and images. - -```java -void setTorchButton(Point torchButtonPosition, int width, int height, Drawable torchOnImage, Drawable torchOffImage) -``` - -**Parameters** - -`torchButtonPosition`: The coordinate of the top-left corner of the torch button. You can input a null value to apply no changes to the position of the torch button. -`width`: The width of the torch button. You can input a null value to apply no changes to the width of the torch button. -`height`: The height of the torch button. You can input a null value to apply no changes to the height of the torch button. -`torchOnImage`: Display this image when the torch is on. You can input a null value to apply no changes to the image of the torch button when the torch is on. -`torchOffImage`: Display this image when the torch is off. You can input a null value to apply no changes to the image of the torch button when the torch is off. - -**Code Snippet** - -```java -cameraView.setTorchButton(new Point(100,100), 50,50, getDrawable(R.drawable.torch_on_image), getDrawable(R.drawable.torch_off_image)); -``` - -**Remarks** - -Method `setTorchButton(Point torchButtonPosition)` is deprecated. Please use the new `setTorchButton` method. - -  - -## setTorchButtonVisible - -Set the visibility of the torch button. The torch button icon is preset in the SDK. If the `torchButtonPosition` has never been configured, the `torchButton` will be displayed on the default position. Currently, the icon and the size of the button are not available for setting. - -```java -void setTorchButtonVisible(boolean isTorchButtonVisible) -``` - -**Parameters** - -`isTorchButtonVisible`: When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -dceCameraView.setTorchButtonVisible(true); -``` - -  - -## getTorchButtonVisible - -Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. - -```java -boolean getTorchButtonVisible() -``` - -**Return Value** - -A boolean value. When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -boolean isTorchButtonVisible = dceCameraView.getTorchButtonVisible(); -``` diff --git a/programming-old/android/auxiliary-api/dcecameraview-v3.0.3.md b/programming-old/android/auxiliary-api/dcecameraview-v3.0.3.md deleted file mode 100644 index e7953459..00000000 --- a/programming-old/android/auxiliary-api/dcecameraview-v3.0.3.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -layout: default-layout -title: Android DCECameraView Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DCECameraView Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCECameraView -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCECameraView Class -permalink: /programming/android/auxiliary-api/dcecameraview-v3.0.3.html ---- - -# DCECameraView Class - -The camera view is the main UI view of the DCE SDK. It is designed to display the video preview, overlay, viewfinder, etc. - -```java -class com.dynamsoft.dce.DCECameraView -``` - -| Method Name | Description | -|------|------| -| [`DCECameraView`](#dcecameraview) | Initialize the `DCECameraView` object. | -| [`setTorchButton`](#settorchbutton) | Set the position, size and image of the torch button. | -| [`setTorchButtonVisible`](#settorchbuttonvisible) | Set the visibility of the torch button. The torch button icon is pre-set in the SDK. | -| [`getTorchButtonVisible`](#gettorchbuttonvisible) | Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. | -| [`getDrawingLayer`](#getdrawinglayer) | Get the [`DCEDrawingLayer`](dcedrawinglayer.html) instance with the layer ID. | -| [`createDrawingLayer`](#createdrawinglayer) | Create a user-defined [`DCEDrawingLayer`](dcedrawinglayer.html) instance. | -| [`getVisibleRegionOfVideo`](#getvisibleregionofvideo) | Get the visible region of the video streaming. | -| [`setOverlayVisible`](#setoverlayvisible) | **Deprecated**. This method controls whether the camera view to display coloured and translucent overlay. | -| [`getOverlayVisible`](#getoverlayvisible) | **Deprecated**. Get the visibility (true: visible/ false: invisible) of the overlay. | -| [`setOverlayColour`](#setoverlaycolour) | **Deprecated**. Set the stroke and fill colour of the overlay. | -| [`setViewfinderVisible`](#setviewfindervisible) | **Deprecated**. This method controls whether to display a viewfinder. | -| [`getViewfinderVisible`](#getviewfindervisible) | **Deprecated**. Get the visibility (true: visible/ false: invisible) of the viewfinder. | -| [`setViewfinder`](#setviewfinder) | **Deprecated**. Set the position and the size of the viewfinder. | - -  - -## DCECameraView - -Initialize the `DCECameraView` object. - -```java -DCECameraView(android.content.Context context) -``` - -**Parameters** - -`context`: An instance of global information about an application environment. - -  - -## setTorchButton - -Set the styles of the button with the position, size and images. - -```java -void setTorchButton(Point torchButtonPosition, int width, int height, Drawable torchOnImage, Drawable torchOffImage) -``` - -**Parameters** - -`torchButtonPosition`: The coordinate of the top-left corner of the torch button. You can input a null value to apply no changes to the position of the torch button. -`width`: The width of the torch button. You can input a null value to apply no changes to the width of the torch button. -`height`: The height of the torch button. You can input a null value to apply no changes to the height of the torch button. -`torchOnImage`: Display this image when the torch is on. You can input a null value to apply no changes to the image of the torch button when the torch is on. -`torchOffImage`: Display this image when the torch is off. You can input a null value to apply no changes to the image of the torch button when the torch is off. - -**Code Snippet** - -```java -cameraView.setTorchButton(new Point(100,100), 50,50, getDrawable(R.drawable.torch_on_image), getDrawable(R.drawable.torch_off_image)); -``` - -**Remarks** - -Method `setTorchButton(Point torchButtonPosition)` is deprecated. Please use the new `setTorchButton` method. - -  - -## setTorchButtonVisible - -Set the visibility of the torch button. The torch button icon is preset in the SDK. If the `torchButtonPosition` has never been configured, the `torchButton` will be displayed on the default position. Currently, the icon and the size of the button are not available for setting. - -```java -void setTorchButtonVisible(boolean isTorchButtonVisible) -``` - -**Parameters** - -`isTorchButtonVisible`: When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -dceCameraView.setTorchButtonVisible(true); -``` - -  - -## getTorchButtonVisible - -Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. - -```java -Boolean getTorchButtonVisible() -``` - -**Return Value** - -A boolean value. When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -Boolean isTorchButtonVisible = dceCameraView.getTorchButtonVisible(); -``` - -  - -## getDrawingLayer - -Get the [`DCEDrawingLayer`](dcedrawinglayer.html) instance with the layer ID. - -```java -public DCEDrawingLayer getDrawingLayer(int id); -``` - -**Parameters** - -`id`: The id of the target [`DCEDrawingLayer`](dcedrawinglayer.html). - -**Parameters** - -`id`: The id of the `DrawingLayer`. - -**Available ID List** - -| Layer | ID | -| ----- | -- | -| DDN_LAYER_ID | 1 | -| DBR_LAYER_ID | 2 | -| DLR_LAYER_ID | 3 | -| USER_DEFINED_LAYER_BASE_ID | 100 | - -**Code Snippet** - -```java -DCEDrawingLayer layer = dceCameraView.getDrawingLayer(DCEDrawingLayer.DDN_LAYER_ID); -``` - -  - -## createDrawingLayer - -Create a user-defined [`DCEDrawingLayer`](dcedrawinglayer.html) instance. - -```java -public DCEDrawingLayer createDrawingLayer(); -``` - -**Return Value** - -An instance of [`DCEDrawingLayer`](dcedrawinglayer.html). - -**Code Snippet** - -```java -DCEDrawingLayer layer = dceCameraView.createDrawingLayer(); -``` - -## setOverlayVisible - -> The method is deprecated - -This method controls whether the camera view displays coloured and translucent overlays. - -```java -void setOverlayVisible(boolean overlayVisibile) -``` - -**Parameters** - -`overlayVisibile`: If true, the camera view will draw and display overlays according to the position and colour settings. Otherwise, the overlay will be hidden. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayVisible(true); -``` - -  - -## getOverlayVisible - -> The method is deprecated - -Get the visibility (true: visible/ false: invisible) of the overlay. - -```java -boolean getOverlayVisible() -``` - -**Return Value** - -The visibility (true: visible/ false: invisible) of the overlay. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean isVisible = dceCameraView.getOverlayVisible(); -``` - -  - -## setOverlayColour - -> The method is deprecated - -Set the stroke and fill colour of the overlays. - -```java -void setOverlayColour(int strokeARGB, int fillARGB) -``` - -**Parameters** - -`strokeARGB`: The colour code of the overlays stroke. -`fillARGB`: The colour code of the overlays stroke. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayColour(0xff00ff00, 0x00000000); -``` - -  - -## setViewfinderVisible - -> The method is deprecated - -This method controls whether to display a viewfinder. - -```java -void setViewfinderVisible(boolean viewfinderVisible) -``` - -**Parameters** - -`viewfinderVisible`: A boolean value that means whether the viewfinder is visible or not. Users can define the position and size of the viewfinder via method [`setViewfinder`](#setviewfinder). The viewfinder will be created based on the default value if the `setViewfinder` has never been triggered. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinderVisible(true); -``` - -  - -## getViewfinderVisible - -> The method is deprecated - -Get the visibility (true: visible/ false: invisible) of the viewfinder. - -```java -boolean getViewfinderVisible() -``` - -**Return Value** - -A boolean value means whether the viewfinder is visible. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean flag = dceCameraView.getViewfinderVisible(); -``` - -  - -## setViewfinder - -> The method is deprecated - -Set the position and the size of the viewfinder. - -```java -void setViewfinder(float left, float top, float right, float bottom) throws CameraEnhancerException -``` - -**Parameters** - -`left`: The distance (by percentage) between the left border of the viewfinder and the left side of the screen. The default value is 0.15. -`top`: The distance (by percentage) between the top border of the viewfinder and the top side of the screen. The default value is 0.3. -`right`: The distance (by percentage) between the right border of the viewfinder and the left side of the screen. The default value is 0.85. -`bottom`: The distance (by percentage) between the bottom border of the viewfinder and the top side of the screen. The default value is 0.7. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinder(0.2, 0.3, 0.8, 0.7); -``` - -**Remarks** - -The viewfinder is built based on the screen coordinate system. The origin of the coordinate is the left-top point of the mobile device. The `left border` of the viewfinder always means the closest border that parallels to the left side of the mobile device no matter how the mobile device is rotated. - -  - -## getVisibleRegionOfVideo - -Get the visible region of the video streaming. - -When the shape of your camera view is quite different from the shape of the video streaming, there might exist a large area that is invisible. You can use this method to get the region of this invisible area. - -
    -

    visible-region

    -

    What's Visible Region

    -
    - -**Return Value** - -An `iRegionDefinition` object. You can use this object to set the scan region so that the invisible areas will be cropped from the video frames. - -**Code Snippet** - -```java -iRegionDefinition visibleRegion = cameraView.getVisibleRegion(); -cameraEnhancer.setScanRegion(visibleRegion); -``` diff --git a/programming-old/android/auxiliary-api/dcecameraview.md b/programming-old/android/auxiliary-api/dcecameraview.md deleted file mode 100644 index 57a7577c..00000000 --- a/programming-old/android/auxiliary-api/dcecameraview.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -layout: default-layout -title: Android DCECameraView Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android DCECameraView Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCECameraView -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCECameraView Class -permalink: /programming/android/auxiliary-api/dcecameraview.html ---- - -# DCECameraView - -The camera view is the main UI view of the DCE SDK. It is designed to display the video preview, overlay, viewfinder, etc. - -```java -class com.dynamsoft.dce.DCECameraView extends RelativeLayout -``` - -| Method Name | Description | -|------|------| -| [`DCECameraView`](#dcecameraview) | Initialize the `DCECameraView` object. | -| [`setOverlayVisible`](#setoverlayvisible) | This method controls whether the camera view to display coloured and translucent overlay. | -| [`getOverlayVisible`](#getoverlayvisible) | Get the visibility (true: visible/ false: invisible) of the overlay. | -| [`setOverlayColour`](#setoverlaycolour) | Set the stroke and fill colour of the overlay. | -| [`setViewfinderVisible`](#setviewfindervisible) | This method controls whether to display a viewfinder. | -| [`getViewfinderVisible`](#getviewfindervisible) | Get the visibility (true: visible/ false: invisible) of the viewfinder. | -| [`setViewfinder`](#setviewfinder) | Set the position and the size of the viewfinder. | -| [`setTorchButton`](#settorchbutton) | Set the position, size and image of the torch button. | -| [`setTorchButtonVisible`](#settorchbuttonvisible) | Set the visibility of the torch button. The torch button icon is pre-set in the SDK. | -| [`getTorchButtonVisible`](#gettorchbuttonvisible) | Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. | -| [`getVisibleRegionOfVideo`](#getvisibleregionofvideo) | Get the visible region of the video streaming. | - -  - -## DCECameraView - -Initialize the `DCECameraView` object. - -```java -DCECameraView(android.content.Context context) -``` - -**Parameters** - -`context`: An instance of global information about an application environment. - -  - -## setOverlayVisible - -This method controls whether the camera view displays coloured and translucent overlays. - -```java -void setOverlayVisible(boolean overlayVisibile) -``` - -**Parameters** - -`overlayVisibile`: If true, the camera view will draw and display overlays according to the position and colour settings. Otherwise, the overlay will be hidden. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayVisible(true); -``` - -  - -## getOverlayVisible - -Get the visibility (true: visible/ false: invisible) of the overlay. - -```java -boolean getOverlayVisible() -``` - -**Return Value** - -The visibility (true: visible/ false: invisible) of the overlay. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean isVisible = dceCameraView.getOverlayVisible(); -``` - -  - -## setOverlayColour - -Set the stroke and fill colour of the overlays. - -```java -void setOverlayColour(int strokeARGB, int fillARGB) -``` - -**Parameters** - -`strokeARGB`: The colour code of the overlays stroke. -`fillARGB`: The colour code of the overlays stroke. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setOverlayColour(0xff00ff00, 0x00000000); -``` - -  - -## setViewfinderVisible - -This method controls whether to display a viewfinder. - -```java -void setViewfinderVisible(boolean viewfinderVisible) -``` - -**Parameters** - -`viewfinderVisible`: A boolean value that means whether the viewfinder is visible or not. Users can define the position and size of the viewfinder via method [`setViewfinder`](#setviewfinder). The viewfinder will be created based on the default value if the `setViewfinder` has never been triggered. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinderVisible(true); -``` - -  - -## getViewfinderVisible - -Get the visibility (true: visible/ false: invisible) of the viewfinder. - -**Return Value** - -A boolean value means whether the viewfinder is visible. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -boolean flag = dceCameraView.getViewfinderVisible(); -``` - -  - -## setViewfinder - -Set the position and the size of the viewfinder. - -```java -void setViewfinder(float left, float top, float right, float bottom) throws CameraEnhancerException -``` - -**Parameters** - -`left`: The distance (by percentage) between the left border of the viewfinder and the left side of the screen. The default value is 0.15. -`top`: The distance (by percentage) between the top border of the viewfinder and the top side of the screen. The default value is 0.3. -`right`: The distance (by percentage) between the right border of the viewfinder and the left side of the screen. The default value is 0.85. -`bottom`: The distance (by percentage) between the bottom border of the viewfinder and the top side of the screen. The default value is 0.7. - -**Code Snippet** - -```java -//Suppose dceCameraView is an object of `DCECameraView` -dceCameraView.setViewfinder(0.2, 0.3, 0.8, 0.7); -``` - -**Remarks** - -The viewfinder is built based on the screen coordinate system. The origin of the coordinate is the left-top point of the mobile device. The `left border` of the viewfinder always means the closest border that parallels to the left side of the mobile device no matter how the mobile device is rotated. - -  - -## setTorchButton - -Set the styles of the button with the position, size and images. - -```java -void setTorchButton(Point torchButtonPosition, int width, int height, Drawable torchOnImage, Drawable torchOffImage) -``` - -**Parameters** - -`torchButtonPosition`: The coordinate of the top-left corner of the torch button. You can input a null value to apply no changes to the position of the torch button. -`width`: The width of the torch button. You can input a null value to apply no changes to the width of the torch button. -`height`: The height of the torch button. You can input a null value to apply no changes to the height of the torch button. -`torchOnImage`: Display this image when the torch is on. You can input a null value to apply no changes to the image of the torch button when the torch is on. -`torchOffImage`: Display this image when the torch is off. You can input a null value to apply no changes to the image of the torch button when the torch is off. - -**Code Snippet** - -```java -cameraView.setTorchButton(new Point(100,100), 50,50, getDrawable(R.drawable.torch_on_image), getDrawable(R.drawable.torch_off_image)); -``` - -**Remarks** - -Method `setTorchButton(Point torchButtonPosition)` is deprecated. Please use the new `setTorchButton` method. - -  - -## setTorchButtonVisible - -Set the visibility of the torch button. The torch button icon is preset in the SDK. If the `torchButtonPosition` has never been configured, the `torchButton` will be displayed on the default position. Currently, the icon and the size of the button are not available for setting. - -```java -void setTorchButtonVisible(boolean isTorchButtonVisible) -``` - -**Parameters** - -`isTorchButtonVisible`: When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -dceCameraView.setTorchButtonVisible(true); -``` - -  - -## getTorchButtonVisible - -Get the visibility setting of the torch button. When it returns true, a torch button should be displayed on the screen. - -```java -boolean getTorchButtonVisible() -``` - -**Return Value** - -A boolean value. When the value is true, the torch button should be displayed. Otherwise, the torch button should be hidden. - -**Code Snippet** - -```java -boolean isTorchButtonVisible = dceCameraView.getTorchButtonVisible(); -``` - -  - -## getVisibleRegionOfVideo - -Get the visible region of the video streaming. - -When the shape of your camera view is quite different from the shape of the video streaming, there might exist a large area that is invisible. You can use this method to get the region of this invisible area. - -
    -

    visible-region

    -

    What's Visible Region

    -
    - -**Return Value** - -An `iRegionDefinition` object. You can use this object to set the scan region so that the invisible areas will be cropped from the video frames. - -**Code Snippet** - -```java -iRegionDefinition visibleRegion = cameraView.getVisibleRegion(); -cameraEnhancer.setScanRegion(visibleRegion); -``` diff --git a/programming-old/android/auxiliary-api/dcedrawinglayer-v3.0.3.md b/programming-old/android/auxiliary-api/dcedrawinglayer-v3.0.3.md deleted file mode 100644 index a9c916a8..00000000 --- a/programming-old/android/auxiliary-api/dcedrawinglayer-v3.0.3.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -layout: default-layout -title: Android DCEDrawingLayer Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DCEDrawingLayer Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCEDrawingLayer -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCEDrawingLayer Class -permalink: /programming/android/auxiliary-api/dcedrawinglayer-v3.0.3.html ---- - -# DCEDrawingLayer Class - -A `DCEDrawingLayer` is the layer that contains and displays `DrawingItems`. Users can add configurations for the `DrawingItems` via `DCEDrawingLayer` - -```java -class com.dynamsoft.dce.DCEDrawingLayer -``` - -| Method Name | Description | -| ----------- | ----------- | -| [`DCEDrawingLayer`](#dcedrawinglayer) | The constructor of the `DCEDrawingLayer` class. | -| [`getId`](#getid) | Get the `DrawingLayer` ID of the `DrawingLayer`. | -| [`addDrawingItems`](#adddrawingitems) | Add a list of [`DrawingItems`](drawingitem.html) to the `DrawingLayer`. These [`DrawingItems`](drawingitem.html) will be appended to the drawing item list of the current `DrawingLayer`. | -| [`setDrawingItems`](#setdrawingitems) | Set a list of [`DrawingItems`](drawingitem.html) to the `DrawingLayer`. These [`DrawingItems`](drawingitem.html) will replace the previous [`DrawingItems`](drawingitem.html) of the current `DrawingLayer`. | -| [`getDrawingItems`](#getdrawingitems) | Get all available [`DrawingItems`](drawingitem.html) in the `DrawingLayer`. | -| [`clearDrawingItems`](#cleardrawingitems) | Clear all available [`DrawingItems`](drawingitem.html) in the `DrawingLayer`. | -| [`setDrawingStyleId(styleId)`](#setdrawingstyleidstyleid) | Specify a style ID for all available [`DrawingItems`](drawingitem.html). | -| [`setDrawingStyleId(styleId,state)`](#setdrawingstyleidstyleidstate) | Specify a style ID for the targeting [`DrawingItems`](drawingitem.html). | -| [`setDrawingStyleId(styleId,state,mediaType)`](#setdrawingstyleidstyleidstatemediatype) | Specify a style ID for the targeting [`DrawingItems`](drawingitem.html). | -| [`setVisible`](#setvisible) | Set the visibility of the `DrawingLayer`. | -| [`isVisible`](#isvisible) | Get the visibility of the `DrawingLayer`. | - -  - -## DCEDrawingLayer - -The constructor of the `DCEDrawingLayer` class. - -```java -public DCEDrawingLayer(int id); -``` - -**Parameters** - -`id`: Indicate the ID of the `DrawingLayer`. - -**Remarks** - -Please initialize the DrawingLayers via the following methods: - -- [`DCEImageEditorView.createDrawingLayer`](dceimageeditorview.html#createdrawinglayer) -- [`DCECameraView.createDrawingLayer`](dcecameraview.html#createdrawinglayer) - -  - -## getId - -Get the ID of the `DrawingLayer`. - -```java -public int getId(); -``` - -**Return Value** - -The id of the `DrawingLayer`. It can be one of the following: - -- `DDN_LAYER_ID` -- `DBR_LAYER_ID` -- `DLR_LAYER_ID` -- `USER_DEFINED_LAYER_BASE_ID` - -**Code Snippet** - -```java -DCEDrawingLayer drawingLayer = dceImageEditorView.createDrawingLayer(); -int id = drawingLayer.getId(); -``` - -  - -## addDrawingItems - -Add a list of [`DrawingItems`](drawingitem.html) to the `DrawingLayer`. These [`DrawingItems`](drawingitem.html) will be appended to the drawing item list of the current `DrawingLayer`. - -```java -public void addDrawingItems(Arraylist items); -``` - -**Parameters** - -`items`: A list of [`DrawingItems`](drawingitem.html). - -**Code Snippet** - -```java -ArrayList drawingItems = new ArrayList(); -drawingItems.add(drawingItem_1); -drawingItems.add(drawingItem_2); -drawingItems.add(drawingItem_3); -drawingLayer.addDrawingItems(drawingItems); -``` - -  - -## setDrawingItems - -Set a list of [`DrawingItems`](drawingitem.html) to the `DrawingLayer`. These [`DrawingItems`](drawingitem.html) will replace the previous [`DrawingItems`](drawingitem.html) of the current `DrawingLayer`. - -```java -public void setDrawingItems(Arraylist items); -``` - -**Parameters** - -`items`: A list of [`DrawingItems`](drawingitem.html). - -**Code Snippet** - -```java -ArrayList drawingItems = new ArrayList(); -drawingItems.add(drawingItem_1); -drawingItems.add(drawingItem_2); -drawingItems.add(drawingItem_3); -drawingLayer.setDrawingItems(drawingItems); -``` - -  - -## getDrawingItems - -Get all available [`DrawingItems`](drawingitem.html) in the `DrawingLayer`. - -```java -public Arraylist getDrawingItems(); -``` - -**Return Value** - -A list that includes all available [`DrawingItems`](drawingitem.html). - -**Code Snippet** - -```java -ArrayList drawingItems = dceDrawingLayer.getDrawingItems(); -``` - -  - -## clearDrawingItems - -Clear all available [`DrawingItems`](drawingitem.html) in the `DrawingLayer`. - -```java -public void clearDrawingItems(); -``` - -**Code Snippet** - -```java -drawingLayer.clearDrawingItems(); -``` - -  - -## setDrawingStyleId(styleId) - -Specify a style ID for all available [`DrawingItems`](drawingitem.html). - -```java -public void setDrawingStyleId(int styleId); -``` - -**Parameters** - -`id`: The style ID. - -**Code Snippet** - -```java -drawingLayer.setDrawingStyleId(0); -``` - -  - -## setDrawingStyleId(styleId,state) - -Specify a style ID for the targeting [`DrawingItems`](drawingitem.html). The `state`is a filter of the `DrawingItems`. All the eligible `DrawingItems` will be changed to the input style. - -```java -public void setDrawingStyleId(int styleId, EnumDrawingItemState state); -``` - -**Parameters** - -`id`: The style ID. -`state`: The state of the `DrawingItem`. - -**Code Snippet** - -```java -drawingLayer.setDrawingStyleId(0, EnumDrawingItemState.DIS_SELECTED); -``` - -  - -## setDrawingStyleId(styleId,state,mediaType) - -Specify a style ID for the targeting [`DrawingItems`](drawingitem.html). The `state` and `mediaType` are filters of the `DrawingItems`. All the eligible `DrawingItems` will be changed to the input style. - -```java -public void setDrawingStyleId(int styleId, EnumDrawingItemState state, EnumDrawingItemMediaType mediaTypes); -``` - -**Parameters** - -`id`: The style ID. -`state`: The state of the `DrawingItem`. -`mediaType`: The media type of the `DrawingItem`. - -**Code Snippet** - -```java -drawingLayer.setDrawingStyleId(0, EnumDrawingItemState.DIS_SELECTED, EnumDrawingItemMediaType.DIMT_RECTANGLE); -``` - -  - -## setVisible - -Set the visibility of the `DrawingLayer`. - -```java -public void setVisible(boolean visible); -``` - -**Parameters** - -`visible`: - -- true: The `DrawingLayer` will be visible -- false: The `DrawingLayer` will be invisible. - -**Code Snippet** - -```java -drawingLayer.setVisible(true); -``` - -  - -## isVisible - -Get the visibility of the `DrawingLayer`. - -```java -public boolean isVisible(); -``` - -**Return Value** - -- true: The `DrawingLayer` is visible. -- false: The `DrawingLayer` is invisible. - -**Code Snippet** - -```java -boolean visible = drawingLayer.isVisible(); -``` diff --git a/programming-old/android/auxiliary-api/dcefeedback-v2.3.12.md b/programming-old/android/auxiliary-api/dcefeedback-v2.3.12.md deleted file mode 100644 index 21ed6385..00000000 --- a/programming-old/android/auxiliary-api/dcefeedback-v2.3.12.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default-layout -title: Android DCEFeedback Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DCEFeedback Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCEFeedback -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCEFeedback Class -permalink: /programming/android/auxiliary-api/dcefeedback-v2.3.12.html ---- - -# DCEFeedback - -| Method | Description | -| ------ | ----------- | -| [`vibrate`](#vibrate) | Trigger a vibration when the method is called. | -| [`beep`](#beep) | Trigger a beep when the method is called. | - -## vibrate - -Trigger a vibration when the method is called. - -```java -static void vibrate(Context context) -``` - -**Code Snippet** - -```java -DCEFeedback.vibrate(MainActivity.this); -// For example, if `vibrate` is called in the TextResultCallback of DBR, the device will trigger a vibration each time when barcode result is detected. -mReader.setTextResultListener(new TextResultListener() { - @Override - public void textResultCallback(int id, ImageData imageData, TextResult[] textResults) { - ... - DCEFeedback.vibrate(MainActivity.this); - } -}); -``` - -## beep - -Trigger a beep when the method is called. - -```java -static void beep(Context context) -``` - -**Code Snippet** - -```java -DCEFeedback.beep(MainActivity.this); -// For example, if `beep` is called in the TextResultCallback of DBR, the device will trigger a beep each time when barcode result is detected. -mReader.setTextResultListener(new TextResultListener() { - @Override - public void textResultCallback(int id, ImageData imageData, TextResult[] textResults) { - ... - DCEFeedback.beep(MainActivity.this); - } -}); -``` diff --git a/programming-old/android/auxiliary-api/dcefeedback-v3.0.3.md b/programming-old/android/auxiliary-api/dcefeedback-v3.0.3.md deleted file mode 100644 index 3bde32ef..00000000 --- a/programming-old/android/auxiliary-api/dcefeedback-v3.0.3.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default-layout -title: Android DCEFeedback Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DCEFeedback Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCEFeedback -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCEFeedback Class -permalink: /programming/android/auxiliary-api/dcefeedback-v3.0.3.html ---- - -# DCEFeedback - -| Method | Description | -| ------ | ----------- | -| [`vibrate`](#vibrate) | Trigger a vibration when the method is called. | -| [`beep`](#beep) | Trigger a beep when the method is called. | - -## vibrate - -Trigger a vibration when the method is called. - -```java -static void vibrate(Context context) -``` - -**Code Snippet** - -```java -DCEFeedback.vibrate(MainActivity.this); -// For example, if `vibrate` is called in the TextResultCallback of DBR, the device will trigger a vibration each time when barcode result is detected. -mReader.setTextResultListener(new TextResultListener() { - @Override - public void textResultCallback(int id, ImageData imageData, TextResult[] textResults) { - ... - DCEFeedback.vibrate(MainActivity.this); - } -}); -``` - -## beep - -Trigger a beep when the method is called. - -```java -static void beep(Context context) -``` - -**Code Snippet** - -```java -DCEFeedback.beep(MainActivity.this); -// For example, if `beep` is called in the TextResultCallback of DBR, the device will trigger a beep each time when barcode result is detected. -mReader.setTextResultListener(new TextResultListener() { - @Override - public void textResultCallback(int id, ImageData imageData, TextResult[] textResults) { - ... - DCEFeedback.beep(MainActivity.this); - } -}); -``` diff --git a/programming-old/android/auxiliary-api/dcefeedback.md b/programming-old/android/auxiliary-api/dcefeedback.md deleted file mode 100644 index 120b6d6d..00000000 --- a/programming-old/android/auxiliary-api/dcefeedback.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default-layout -title: Android DCEFeedback Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android DCEFeedback Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCEFeedback -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCEFeedback Class -permalink: /programming/android/auxiliary-api/dcefeedback.html ---- - -# DCEFeedback - -| Method | Description | -| ------ | ----------- | -| [`vibrate`](#vibrate) | Trigger a vibration when the method is called. | -| [`beep`](#beep) | Trigger a beep when the method is called. | - -## vibrate - -Trigger a vibration when the method is called. - -```java -static void vibrate(Context context) -``` - -**Code Snippet** - -```java -DCEFeedback.vibrate(MainActivity.this); -// For example, if `vibrate` is called in the TextResultCallback of DBR, the device will trigger a vibration each time when barcode result is detected. -mReader.setTextResultListener(new TextResultListener() { - @Override - public void textResultCallback(int id, ImageData imageData, TextResult[] textResults) { - ... - DCEFeedback.vibrate(MainActivity.this); - } -}); -``` - -## beep - -Trigger a beep when the method is called. - -```java -static void beep(Context context) -``` - -**Code Snippet** - -```java -DCEFeedback.beep(MainActivity.this); -// For example, if `beep` is called in the TextResultCallback of DBR, the device will trigger a beep each time when barcode result is detected. -mReader.setTextResultListener(new TextResultListener() { - @Override - public void textResultCallback(int id, ImageData imageData, TextResult[] textResults) { - ... - DCEFeedback.beep(MainActivity.this); - } -}); -``` diff --git a/programming-old/android/auxiliary-api/dceframe-v1.0.3.md b/programming-old/android/auxiliary-api/dceframe-v1.0.3.md deleted file mode 100644 index 99473f75..00000000 --- a/programming-old/android/auxiliary-api/dceframe-v1.0.3.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -layout: default-layout -title: Android Frame Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android Frame Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, Frame -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android Frame Class -permalink: /programming/android/auxiliary-api/dceframe-v1.0.3.html ---- - -# Frame - -This page is for `Frame` Class. `Frame` parameters store the frame data. - -```java -class com.dynamsoft.dce.Frame -``` - -| Method Name | Type | -| ----------- | ---- | -| [`getData`](#getdata) | byte[] | -| [`getWidth`](#getwidth) | int | -| [`getHeight`](#getheight) | int | -| [`getStrides`](#getstrides) | int[] | -| [`getFormat`](#getformat) | int | -| [`getFrameId`](#getframeid) | int | -| [`isFastFrame`](#isfastframe) | boolean | -| [`getFastFrameId`](#getfastframeid) | int | -| [`getCropRect`](#getcroprect) | Rect | -| [`getOrientation`](#getorientation) | int | -| [`getOriW`](#getoriw) | int | -| [`getOriH`](#getorih) | int | - -  - -## getData - -Get the frame data in byte array. - -```java -byte[] getData() -``` - -**Return Value** - -The frame byte data. - - -  - -## getWidth - -Get the frame width in pixels. - -```java -int getWidth() -``` - -**Return Value** - -The pixel width of the frame. - - -  - -## getHeight - -Get the frame height in pixels. - -```java -int getHeight() -``` - -**Return Value** - -The pixel height of the frame. - - -  - -## getStrides - -Get the frame strides. - -```java -int[] getStrides() -``` - -**Return Value** - -The strides of the frame. - - -  - -## getFormat - -Get the frame pixel format. - -```java -int getFormat() -``` - -**Return Value** - -The format of the frame. - - -  - -## getFrameId - -Get the frame ID. - -```java -int getFrameId() -``` - -**Return Value** - -The ID of the frame. - - -  - -## isFastFrame - -Check whether the fast mode is enabled. - -```java -boolean isFastFrame() -``` - -**Return Value** - -Whether the frame is cropped. - - -  - -## getFastFrameId - -Get the fast frame (cropped frame) ID. - -```java -int getFastFrameId() -``` - -**Return Value** - -The ID of the fast frame (cropped frame). - - -  - -## getCropRect - -Get the cropped Rect data (Width & height) - -```java -Rect getCropRect() -``` - -**Return Value** - -The value of the cropped frame. - -  - -## getOrientation - -Get the orientation (of cropped frame). - -```java -int getOrientation() -``` - -**Return Value** - -The orientation (of cropped frame). - -| Orientation of the frame | Value (int) | -|--------------------------|-------| -| Vertical | 1 | -| Horizontal | 2 | - -  - -## getOriW - -Get the original width of the cropped frame. - -```java -int getOriW() -``` - -**Return Value** - -The pixel width of the cropped frame. - -  - -## getOriH - -Get the original width of the cropped frame. - -```java -int getOriH() -``` - -**Return Value** - -The pixel height of the cropped frame. diff --git a/programming-old/android/auxiliary-api/dceframe-v2.3.11.md b/programming-old/android/auxiliary-api/dceframe-v2.3.11.md deleted file mode 100644 index 426a2062..00000000 --- a/programming-old/android/auxiliary-api/dceframe-v2.3.11.md +++ /dev/null @@ -1,356 +0,0 @@ ---- -layout: default-layout -title: Android DCEFrame Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DCEFrame Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCEFrame -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCEFrame Class -permalink: /programming/android/auxiliary-api/dceframe-v2.3.11.html ---- - -# DCEFrame - -> You are viewing a historical document page of Dynamsoft Camera Enhancer v2.3.11. - -The `DCEFrame` is the class that stores pixel data and further information. - -```java -class com.dynamsoft.dce.DCEFrame -``` - -| Method Name | Description | -| ----------- | ----------- | -| [`getImageData`](#getimagedata) | Get the pixel data of the image. | -| [`getWidth`](#getwidth) | Get the pixel width of the image. | -| [`getHeight`](#getheight) | Get the pixel height of the image. | -| [`getStrides`](#getstrides) | Get the number of row bytes in each image plane (YUV). | -| [`getPixelFormat`](#getpixelformat) | Get the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. | -| [`getFrameID`](#getframeid) | Get the `frameID` of the `DCEFrame` object. | -| [`getQuality`](#getquality) | Get the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. | -| [`getIsCropped`](#getiscropped) | Get a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`getCropRegion`](#getcropregion) | Get the crop region of the image (if the image is cropped). | -| [`getOrientation`](#setorientation) | Set the orientation of the image. | -| [`setImageData`](#setimagedata) | Set the pixel data of the image. | -| [`setWidth`](#setwidth) | Set the pixel width of the image. | -| [`setHeight`](#setheight) | Set the pixel height of the image. | -| [`setStrides`](#setstrides) | Set the number of row bytes in each image plane (YUV). | -| [`setPixelFormat`](#setpixelformat) | Set the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. | -| [`setFrameID`](#setframeid) | Set the `frameID` of the `DCEFrame` object. | -| [`setQuality`](#setquality) | Set the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. | -| [`setIsCropped`](#setiscropped) | Set a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`setCropRegion`](#setcropregion) | Set a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`setOrientation`](#setorientation) | Set the orientation of the image. | -| [`toBitmap`](#tobitmap) | The method converts the image to `Bitmap`. | - -  - -## getImageData - -Get the pixel data of the image. - -```java -byte[] getImageData() -``` - -**Return Value** - -The method returns a byte list that stores the pixel data of the image. - -  - -## getWidth - -Get the pixel width of the image. - -```java -int getWidth() -``` - -**Return Value** - -The method returns the pixel width of the image. - -  - -## getHeight - -Get the pixel height of the image. - -```java -int getHeight() -``` - -**Return Value** - -The method returns the pixel height of the image. - -  - -## getStrides - -Get the number of row bytes in each image plane (YUV). - -```java -int[] getStrides() -``` - -**Return Value** - -The number of row bytes in each image plane (YUV). - -**Remarks** - -`strides[0]` is the stride of Y component in the image. `strides[1]` and `strides[2]` are the strides of the U (blue projection) and V (red projection) components in the image. - -  - -## getPixelFormat - -Get the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. - -```java -int getPixelFormat() -``` - -**Return Value** - -The method returns an int value that refers to the pixel format of the image. View morein [`EnumImagePixelFormat`]({{ site.core-enums }}image-pixel-format.html?src=android). - -  - -## getFrameID - -Get the `frameID` of the `DCEFrame` object. - -```java -int getFrameID() -``` - -**Return Value** - -The method returns an int value that stores the `frameID` of the image. - -  - -## getQuality - -Get the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. - -```java -EnumFrameQuality getQuality() -``` - -**Return Value** - -The method returns an enumeration value in [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html). - -**Remarks** - -Users can get all the original DCEFrame via `DCEFrameListener` but only high-quality frame can be acquired from the DCE video buffer if frame filter is enabled. In another word, when frame filter feature is enabled, the frame quality will always be high if they are acquired by triggering `getFrameFromBuffer`. - -  - -## getIsCropped - -Get a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. - -```java -boolean getIsCropped() -``` - -**Return Value** - -A boolean value. `True` means the image is cropped and `false` means the image has never been cropped. - -  - -## getCropRegion - -Get the crop region of the image (if the image is cropped). - -```java -Rect getCropRegion() -``` - -**Return Value** - -A Rect value that stores the crop region. If the image is not cropped, the value will be null. - -  - -## getOrientation - -Set the orientation of the image. - -```java -int getOrientation() -``` - -**Return Value** - -Int value that means the rotation angle of the image. The value is 0, 90, 180 or 270 with depends on the device orientation. - -
    -

    getOrientation

    -

    All examples of the orientation

    -
    - -  - -## setImageData - -Set the pixel data of the image. - -```java -void setImageData(byte[] imageData) -``` - -**Parameters** - -`imageData`: A byte list that storing the image pixel data. - -  - -## setWidth - -Set the pixel width of the image. - -```java -void setWidth(int width) -``` - -**Parameters** - -`width`: The pixel value that stands for the width of the image. - -  - -## setHeight - -Set the pixel height of the image. - -```java -void setHeight(int height) -``` - -**Parameters** - -`height`: The pixel value that stands for the height of the image. - -  - -## setStrides - -Set the number of row bytes in each image plane. - -```java -void setStrides(int[] strides) -``` - -**Parameters** - -`strides`: The number of row bytes in each image plane. - -  - -## setPixelFormat - -Set the pixel format of the image. - -```java -void setPixelFormat(int pixelFormat) -``` - -**Parameters** - -`pixelFormat`: The pixelFormat of the image. View more in [`EnumImagePixelFormat`]({{ site.core-enums }}image-pixel-format.html?src=android). - -  - -## setFrameID - -Set the `frameID` of the image. - -```java -void setFrameID(int frameID) -``` - -**Parameters** - -`frameID`: An int value that stands for the `frameID` of the image. - -  - -## setQuality - -Set the frame quality of the image. - -```java -void setQuality(EnumFrameQuality quality) -``` - -**Parameters** - -`quality`: One of the [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html) value that indicates the frame quality. - -  - -## setIsCropped - -Set whether the image is cropped. - -```java -void setIsCropped(boolean isCropped) -``` - -**Parameters** - -`isCropped`: A boolean value that means whether the image is cropped. - -  - -## setCropRegion - -Set the crop region of the image (if the frame is cropped). - -```java -void setCropRegion(Rect region) -``` - -**Parameters** - -`cropRegion`: A Rect value that means crop area of the image (if the frame is cropped). - -  - -## setOrientation - -Set the orientation of the image. - -```java -void setOrientation(int orientation) -``` - -**Parameters** - -`orientation`: Int value that means the rotation angle of the image. - -## toBitmap - -The method converts the image to `Bitmap`. - -```java -Bitmap toBitmap() -``` - -**Return Value** - -The converted image. - -**Code Snippet** - -```java -Bitmap frame = DCEFrame.toBitmap(); -``` diff --git a/programming-old/android/auxiliary-api/dceframe-v2.3.12.md b/programming-old/android/auxiliary-api/dceframe-v2.3.12.md deleted file mode 100644 index 7e498101..00000000 --- a/programming-old/android/auxiliary-api/dceframe-v2.3.12.md +++ /dev/null @@ -1,356 +0,0 @@ ---- -layout: default-layout -title: Android DCEFrame Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DCEFrame Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCEFrame -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCEFrame Class -permalink: /programming/android/auxiliary-api/dceframe-v2.3.12.html ---- - -# DCEFrame - -> You are viewing a historical document page of Dynamsoft Camera Enhancer v2.3.11. - -The `DCEFrame` is the class that stores pixel data and further information. - -```java -class com.dynamsoft.dce.DCEFrame -``` - -| Method Name | Description | -| ----------- | ----------- | -| [`getImageData`](#getimagedata) | Get the pixel data of the image. | -| [`getWidth`](#getwidth) | Get the pixel width of the image. | -| [`getHeight`](#getheight) | Get the pixel height of the image. | -| [`getStrides`](#getstrides) | Get the number of row bytes in each image plane (YUV). | -| [`getPixelFormat`](#getpixelformat) | Get the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. | -| [`getFrameID`](#getframeid) | Get the `frameID` of the `DCEFrame` object. | -| [`getQuality`](#getquality) | Get the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. | -| [`getIsCropped`](#getiscropped) | Get a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`getCropRegion`](#getcropregion) | Get the crop region of the image (if the image is cropped). | -| [`getOrientation`](#setorientation) | Set the orientation of the image. | -| [`setImageData`](#setimagedata) | Set the pixel data of the image. | -| [`setWidth`](#setwidth) | Set the pixel width of the image. | -| [`setHeight`](#setheight) | Set the pixel height of the image. | -| [`setStrides`](#setstrides) | Set the number of row bytes in each image plane (YUV). | -| [`setPixelFormat`](#setpixelformat) | Set the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. | -| [`setFrameID`](#setframeid) | Set the `frameID` of the `DCEFrame` object. | -| [`setQuality`](#setquality) | Set the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. | -| [`setIsCropped`](#setiscropped) | Set a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`setCropRegion`](#setcropregion) | Set a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`setOrientation`](#setorientation) | Set the orientation of the image. | -| [`toBitmap`](#tobitmap) | The method converts the image to `Bitmap`. | - -  - -## getImageData - -Get the pixel data of the image. - -```java -byte[] getImageData() -``` - -**Return Value** - -The method returns a byte list that stores the pixel data of the image. - -  - -## getWidth - -Get the pixel width of the image. - -```java -int getWidth() -``` - -**Return Value** - -The method returns the pixel width of the image. - -  - -## getHeight - -Get the pixel height of the image. - -```java -int getHeight() -``` - -**Return Value** - -The method returns the pixel height of the image. - -  - -## getStrides - -Get the number of row bytes in each image plane (YUV). - -```java -int[] getStrides() -``` - -**Return Value** - -The number of row bytes in each image plane (YUV). - -**Remarks** - -`strides[0]` is the stride of Y component in the image. `strides[1]` and `strides[2]` are the strides of the U (blue projection) and V (red projection) components in the image. - -  - -## getPixelFormat - -Get the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. - -```java -int getPixelFormat() -``` - -**Return Value** - -The method returns an int value that refers to the pixel format of the image. View morein [`EnumImagePixelFormat`]({{ site.core-enums }}image-pixel-format.html?src=android). - -  - -## getFrameID - -Get the `frameID` of the `DCEFrame` object. - -```java -int getFrameID() -``` - -**Return Value** - -The method returns an int value that stores the `frameID` of the image. - -  - -## getQuality - -Get the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. - -```java -EnumFrameQuality getQuality() -``` - -**Return Value** - -The method returns an enumeration value in [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html). - -**Remarks** - -Users can get all the original DCEFrame via `DCEFrameListener` but only high-quality frame can be acquired from the DCE video buffer if frame filter is enabled. In another word, when frame filter feature is enabled, the frame quality will always be high if they are acquired by triggering `getFrameFromBuffer`. - -  - -## getIsCropped - -Get a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. - -```java -boolean getIsCropped() -``` - -**Return Value** - -A boolean value. `True` means the image is cropped and `false` means the image has never been cropped. - -  - -## getCropRegion - -Get the crop region of the image (if the image is cropped). - -```java -Rect getCropRegion() -``` - -**Return Value** - -A Rect value that stores the crop region. If the image is not cropped, the value will be null. - -  - -## getOrientation - -Set the orientation of the image. - -```java -int getOrientation() -``` - -**Return Value** - -Int value that means the rotation angle of the image. The value is 0, 90, 180 or 270 with depends on the device orientation. - -
    -

    getOrientation

    -

    All examples of the orientation

    -
    - -  - -## setImageData - -Set the pixel data of the image. - -```java -void setImageData(byte[] imageData) -``` - -**Parameters** - -`imageData`: A byte list that storing the image pixel data. - -  - -## setWidth - -Set the pixel width of the image. - -```java -void setWidth(int width) -``` - -**Parameters** - -`width`: The pixel value that stands for the width of the image. - -  - -## setHeight - -Set the pixel height of the image. - -```java -void setHeight(int height) -``` - -**Parameters** - -`height`: The pixel value that stands for the height of the image. - -  - -## setStrides - -Set the number of row bytes in each image plane. - -```java -void setStrides(int[] strides) -``` - -**Parameters** - -`strides`: The number of row bytes in each image plane. - -  - -## setPixelFormat - -Set the pixel format of the image. - -```java -void setPixelFormat(int pixelFormat) -``` - -**Parameters** - -`pixelFormat`: The pixelFormat of the image. View more in [`EnumImagePixelFormat`]({{ site.core-enums }}image-pixel-format.html?src=android). - -  - -## setFrameID - -Set the `frameID` of the image. - -```java -void setFrameID(int frameID) -``` - -**Parameters** - -`frameID`: An int value that stands for the `frameID` of the image. - -  - -## setQuality - -Set the frame quality of the image. - -```java -void setQuality(EnumFrameQuality quality) -``` - -**Parameters** - -`quality`: One of the [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html) value that indicates the frame quality. - -  - -## setIsCropped - -Set whether the image is cropped. - -```java -void setIsCropped(boolean isCropped) -``` - -**Parameters** - -`isCropped`: A boolean value that means whether the image is cropped. - -  - -## setCropRegion - -Set the crop region of the image (if the frame is cropped). - -```java -void setCropRegion(Rect region) -``` - -**Parameters** - -`cropRegion`: A Rect value that means crop area of the image (if the frame is cropped). - -  - -## setOrientation - -Set the orientation of the image. - -```java -void setOrientation(int orientation) -``` - -**Parameters** - -`orientation`: Int value that means the rotation angle of the image. - -## toBitmap - -The method converts the image to `Bitmap`. - -```java -Bitmap toBitmap() -``` - -**Return Value** - -The converted image. - -**Code Snippet** - -```java -Bitmap frame = DCEFrame.toBitmap(); -``` diff --git a/programming-old/android/auxiliary-api/dceframe-v3.0.3.md b/programming-old/android/auxiliary-api/dceframe-v3.0.3.md deleted file mode 100644 index 7a17d3a7..00000000 --- a/programming-old/android/auxiliary-api/dceframe-v3.0.3.md +++ /dev/null @@ -1,356 +0,0 @@ ---- -layout: default-layout -title: Android DCEFrame Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DCEFrame Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCEFrame -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCEFrame Class -permalink: /programming/android/auxiliary-api/dceframe-v3.0.3.html ---- - -# DCEFrame - -> You are viewing a historical document page of Dynamsoft Camera Enhancer v3.0.3. - -The `DCEFrame` is the class that stores pixel data and further information. - -```java -class com.dynamsoft.dce.DCEFrame -``` - -| Method Name | Description | -| ----------- | ----------- | -| [`getImageData`](#getimagedata) | Get the pixel data of the image. | -| [`getWidth`](#getwidth) | Get the pixel width of the image. | -| [`getHeight`](#getheight) | Get the pixel height of the image. | -| [`getStrides`](#getstrides) | Get the number of row bytes in each image plane (YUV). | -| [`getPixelFormat`](#getpixelformat) | Get the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. | -| [`getFrameID`](#getframeid) | Get the `frameID` of the `DCEFrame` object. | -| [`getQuality`](#getquality) | Get the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. | -| [`getIsCropped`](#getiscropped) | Get a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`getCropRegion`](#getcropregion) | Get the crop region of the image (if the image is cropped). | -| [`getOrientation`](#setorientation) | Set the orientation of the image. | -| [`setImageData`](#setimagedata) | Set the pixel data of the image. | -| [`setWidth`](#setwidth) | Set the pixel width of the image. | -| [`setHeight`](#setheight) | Set the pixel height of the image. | -| [`setStrides`](#setstrides) | Set the number of row bytes in each image plane (YUV). | -| [`setPixelFormat`](#setpixelformat) | Set the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. | -| [`setFrameID`](#setframeid) | Set the `frameID` of the `DCEFrame` object. | -| [`setQuality`](#setquality) | Set the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. | -| [`setIsCropped`](#setiscropped) | Set a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`setCropRegion`](#setcropregion) | Set a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`setOrientation`](#setorientation) | Set the orientation of the image. | -| [`toBitmap`](#tobitmap) | The method converts the image to `Bitmap`. | - -  - -## getImageData - -Get the pixel data of the image. - -```java -byte[] getImageData() -``` - -**Return Value** - -The method returns a byte list that stores the pixel data of the image. - -  - -## getWidth - -Get the pixel width of the image. - -```java -int getWidth() -``` - -**Return Value** - -The method returns the pixel width of the image. - -  - -## getHeight - -Get the pixel height of the image. - -```java -int getHeight() -``` - -**Return Value** - -The method returns the pixel height of the image. - -  - -## getStrides - -Get the number of row bytes in each image plane (YUV). - -```java -int[] getStrides() -``` - -**Return Value** - -The number of row bytes in each image plane (YUV). - -**Remarks** - -`strides[0]` is the stride of Y component in the image. `strides[1]` and `strides[2]` are the strides of the U (blue projection) and V (red projection) components in the image. - -  - -## getPixelFormat - -Get the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. - -```java -int getPixelFormat() -``` - -**Return Value** - -The method returns an int value that refers to the pixel format of the image. View morein [`EnumImagePixelFormat`]({{ site.core-enums }}image-pixel-format.html?src=android). - -  - -## getFrameID - -Get the `frameID` of the `DCEFrame` object. - -```java -int getFrameID() -``` - -**Return Value** - -The method returns an int value that stores the `frameID` of the image. - -  - -## getQuality - -Get the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. - -```java -EnumFrameQuality getQuality() -``` - -**Return Value** - -The method returns an enumeration value in [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html). - -**Remarks** - -Users can get all the original DCEFrame via `DCEFrameListener` but only high-quality frame can be acquired from the DCE video buffer if frame filter is enabled. In another word, when frame filter feature is enabled, the frame quality will always be high if they are acquired by triggering `getFrameFromBuffer`. - -  - -## getIsCropped - -Get a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. - -```java -boolean getIsCropped() -``` - -**Return Value** - -A boolean value. `True` means the image is cropped and `false` means the image has never been cropped. - -  - -## getCropRegion - -Get the crop region of the image (if the image is cropped). - -```java -Rect getCropRegion() -``` - -**Return Value** - -A Rect value that stores the crop region. If the image is not cropped, the value will be null. - -  - -## getOrientation - -Set the orientation of the image. - -```java -int getOrientation() -``` - -**Return Value** - -Int value that means the rotation angle of the image. The value is 0, 90, 180 or 270 with depends on the device orientation. - -
    -

    getOrientation

    -

    All examples of the orientation

    -
    - -  - -## setImageData - -Set the pixel data of the image. - -```java -void setImageData(byte[] imageData) -``` - -**Parameters** - -`imageData`: A byte list that storing the image pixel data. - -  - -## setWidth - -Set the pixel width of the image. - -```java -void setWidth(int width) -``` - -**Parameters** - -`width`: The pixel value that stands for the width of the image. - -  - -## setHeight - -Set the pixel height of the image. - -```java -void setHeight(int height) -``` - -**Parameters** - -`height`: The pixel value that stands for the height of the image. - -  - -## setStrides - -Set the number of row bytes in each image plane. - -```java -void setStrides(int[] strides) -``` - -**Parameters** - -`strides`: The number of row bytes in each image plane. - -  - -## setPixelFormat - -Set the pixel format of the image. - -```java -void setPixelFormat(int pixelFormat) -``` - -**Parameters** - -`pixelFormat`: The pixelFormat of the image. View more in [`EnumImagePixelFormat`]({{ site.core-enums }}image-pixel-format.html?src=android). - -  - -## setFrameID - -Set the `frameID` of the image. - -```java -void setFrameID(int frameID) -``` - -**Parameters** - -`frameID`: An int value that stands for the `frameID` of the image. - -  - -## setQuality - -Set the frame quality of the image. - -```java -void setQuality(EnumFrameQuality quality) -``` - -**Parameters** - -`quality`: One of the [`EnumFrameQuality`]({{ site.dce-enums }}video-frame-quality.html) value that indicates the frame quality. - -  - -## setIsCropped - -Set whether the image is cropped. - -```java -void setIsCropped(boolean isCropped) -``` - -**Parameters** - -`isCropped`: A boolean value that means whether the image is cropped. - -  - -## setCropRegion - -Set the crop region of the image (if the frame is cropped). - -```java -void setCropRegion(Rect region) -``` - -**Parameters** - -`cropRegion`: A Rect value that means crop area of the image (if the frame is cropped). - -  - -## setOrientation - -Set the orientation of the image. - -```java -void setOrientation(int orientation) -``` - -**Parameters** - -`orientation`: Int value that means the rotation angle of the image. - -## toBitmap - -The method converts the image to `Bitmap`. - -```java -Bitmap toBitmap() -``` - -**Return Value** - -The converted image. - -**Code Snippet** - -```java -Bitmap frame = DCEFrame.toBitmap(); -``` diff --git a/programming-old/android/auxiliary-api/dceframe.md b/programming-old/android/auxiliary-api/dceframe.md deleted file mode 100644 index ef5c0d16..00000000 --- a/programming-old/android/auxiliary-api/dceframe.md +++ /dev/null @@ -1,359 +0,0 @@ ---- -layout: default-layout -title: Android DCEFrame Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android DCEFrame Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCEFrame -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCEFrame Class -permalink: /programming/android/auxiliary-api/dceframe.html -ignore: true ---- - -# DCEFrame - -> You are viewing a historical document page of Dynamsoft Camera Enhancer v3.0.3. - -The `DCEFrame` is the class that stores pixel data and further information. - -```java -class com.dynamsoft.dce.DCEFrame -``` - -| Method Name | Description | -| ----------- | ----------- | -| [`getImageData`](#getimagedata) | Get the pixel data of the image. | -| [`getWidth`](#getwidth) | Get the pixel width of the image. | -| [`getHeight`](#getheight) | Get the pixel height of the image. | -| [`getStrides`](#getstrides) | Get the number of row bytes in each image plane (YUV). | -| [`getPixelFormat`](#getpixelformat) | Get the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. | -| [`getFrameID`](#getframeid) | Get the `frameID` of the `DCEFrame` object. | -| [`getQuality`](#getquality) | Get the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. | -| [`getIsCropped`](#getiscropped) | Get a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`getCropRegion`](#getcropregion) | Get the crop region of the image (if the image is cropped). | -| [`getOrientation`](#setorientation) | Set the orientation of the image. | -| [`setImageData`](#setimagedata) | Set the pixel data of the image. | -| [`setWidth`](#setwidth) | Set the pixel width of the image. | -| [`setHeight`](#setheight) | Set the pixel height of the image. | -| [`setStrides`](#setstrides) | Set the number of row bytes in each image plane (YUV). | -| [`setPixelFormat`](#setpixelformat) | Set the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. | -| [`setFrameID`](#setframeid) | Set the `frameID` of the `DCEFrame` object. | -| [`setQuality`](#setquality) | Set the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. | -| [`setIsCropped`](#setiscropped) | Set a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`setCropRegion`](#setcropregion) | Set a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. | -| [`setOrientation`](#setorientation) | Set the orientation of the image. | -| [`toBitmap`](#tobitmap) | The method converts the image to `UIImage` to make it visible on the UI. | - -  - -## getImageData - -Get the pixel data of the image. - -```java -byte[] getImageData() -``` - -**Return Value** - -The method returns a byte list that stores the pixel data of the image. - -  - -## getWidth - -Get the pixel width of the image. - -```java -int getWidth() -``` - -**Return Value** - -The method returns the pixel width of the image. - -  - -## getHeight - -Get the pixel height of the image. - -```java -int getHeight() -``` - -**Return Value** - -The method returns the pixel height of the image. - -  - -## getStrides - -Get the number of row bytes in each image plane (YUV). - -```java -int[] getStrides() -``` - -**Return Value** - -The number of row bytes in each image plane (YUV). - -**Remarks** - -`strides[0]` is the stride of Y component in the image. `strides[1]` and `strides[2]` are the strides of the U (blue projection) and V (red projection) components in the image. - -  - -## getPixelFormat - -Get the pixel format of the image. Currently, the image output format of `DCEFrame` is always NV21. - -```java -int getPixelFormat() -``` - -**Return Value** - -The method returns an int value that refers to the enumeration value of [`ImagePixelFormat`]({{site.barcode-enum}}other-enums.html#imagepixelformat) (view the enumeration members in Dynamsoft Barcode Reader documents). - -  - - -## getFrameID - -Get the `frameID` of the `DCEFrame` object. - -```java -int getFrameID() -``` - -**Return Value** - -The method returns an int value that stores the `frameID` of the image. - -  - - -## getQuality - -Get the frame quality of the image. User have to enable the frame filter feature to get the quality (high/low) of the image. Otherwise, the frame quality will be unknown. - -```java -EnumFrameQuality getQuality() -``` - -**Return Value** - -The method returns an enumeration value in [`EnumFrameQuality`]({{site.dce-enums}}video-frame-quality.html?lang=android). - -**Remarks** - -Users can get all the original DCEFrame via `DCEFrameListener` but only high-quality frame can be acquired from the DCE video buffer if frame filter is enabled. In another word, when frame filter feature is enabled, the frame quality will always be high if they are acquired by triggering `getFrameFromBuffer`. - -  - -## getIsCropped - -Get a boolean value that means whether the image is cropped. The frames can be cropped if `fast mode` is enabled. - -```java -boolean getIsCropped() -``` - -**Return Value** - -A boolean value. `True` means the image is cropped and `false` means the image has never been cropped. - -  - -## getCropRegion - -Get the crop region of the image (if the image is cropped). - -```java -Rect getCropRegion() -``` - -**Return Value** - -A Rect value that stores the crop region. If the image is not cropped, the value will be null. - -  - -## getOrientation - -Set the orientation of the image. - -```java -int getOrientation() -``` - -**Return Value** - -Int value that means the rotation angle of the image. The value is 0, 90, 180 or 270 with depends on the device orientation. - -
    -

    getOrientation

    -

    All examples of the orientation

    -
    - -  - -## setImageData - -Set the pixel data of the image. - -```java -void setImageData(byte[] imageData) -``` - -**Parameters** - -`imageData`: A byte list that storing the image pixel data. - -  - -## setWidth - -Set the pixel width of the image. - -```java -void setWidth(int width) -``` - -**Parameters** - -`width`: The pixel value that stands for the width of the image. - -  - -## setHeight - -Set the pixel height of the image. - -```java -void setHeight(int height) -``` - -**Parameters** - -`height`: The pixel value that stands for the height of the image. - -  - -## setStrides - -Set the number of row bytes in each image plane. - -```java -void setStrides(int[] strides) -``` - -**Parameters** - -`strides`: The number of row bytes in each image plane. - -  - -## setPixelFormat - -Set the pixel format of the image. - -```java -void setPixelFormat(int pixelFormat) -``` - -**Parameters** - -`pixelFormat`: The pixelFormat of the image. View more in Dynamsoft Barcode Reader Enumeration [`ImagePixelFormat`]({{site.barcode-enum}}other-enums.html#imagepixelformat) - -  - -## setFrameID - -Set the `frameID` of the image. - -```java -void setFrameID(int frameID) -``` - -**Parameters** - -`frameID`: An int value that stands for the `frameID` of the image. - -  - -## setQuality - -Set the frame quality of the image. - -```java -void setQuality(EnumFrameQuality quality) -``` - -**Parameters** - -`quality`: An `Enumeration` value that means the frame quality. Read more in [`EnumFrameQuality`]({{site.dce-enums}}video-frame-quality.html?lang=android). - -  - -## setIsCropped - -Set whether the image is cropped. - -```java -void setIsCropped(boolean isCropped) -``` - -**Parameters** - -`isCropped`: A boolean value that means whether the image is cropped. - -  - -## setCropRegion - -Set the crop region of the image (if the frame is cropped). - -```java -void setCropRegion(Rect region) -``` - -**Parameters** - -`cropRegion`: A Rect value that means crop area of the image (if the frame is cropped). - -  - -## setOrientation - -Set the orientation of the image. - -```java -void setOrientation(int orientation) -``` - -**Parameters** - -`orientation`: Int value that means the rotation angle of the image. - -## toBitmap - -The method converts the image to `UIImage` to make it visible on the UI. - -```java -Bitmap toBitmap() -``` - -**Return Value** - -The converted image. - -**Code Snippet** - -```java -Bitmap frame = DCEFrame.toBitmap(); -``` diff --git a/programming-old/android/auxiliary-api/dceimageeditorview-v3.0.3.md b/programming-old/android/auxiliary-api/dceimageeditorview-v3.0.3.md deleted file mode 100644 index 25fa459f..00000000 --- a/programming-old/android/auxiliary-api/dceimageeditorview-v3.0.3.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -layout: default-layout -title: Android DCEImageEditorView Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DCEImageEditorView Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DCEImageEditorView -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DCEImageEditorView Class -permalink: /programming/android/auxiliary-api/dceimageeditorview-v3.0.3.html ---- - -# DCEImageEditorView - -`DCEImageEditorView` is the class that enable users to add UI configurations on a static image. - -```java -class com.dynamsoft.dce.DCEImageEditorView -``` - -| Method Name | Description | -| ----------- | ----------- | -| [`setOriginalImage`](#setoriginalimage) | Set the background image of the view with an original image. | -| [`getOriginalImage`](#getoriginalimage) | Get the current backgroud image. | -| [`getDrawingLayer`](#getdrawinglayer) | Get the [`DCEDrawingLayer`](dcedrawinglayer.html) instance with the layer ID. | -| [`createDrawingLayer`](#createdrawinglayer) | Create a user-defined [`DCEDrawingLayer`](dcedrawinglayer.html) instance. | -| [`getSelectedDrawingItem`](#getselecteddrawingitem) | Get the selected drawing item. | - -  - -## setOriginalImage - -Set the background image of the view with an original image. - -```java -public void setOriginalImage(ImageData imageData); -``` - -**Parameters** - -`imageData`: The `imageData` of the image. - -**Code Snippet** - -```java -mIEV = (DCEImageEditorView) findViewById(R.id.iev); -mImgData = getIntent().getIntExtra("imagedata"); -mIEV.setOriginalImage(mImgData); -``` - -  - -## getOriginalImage - -Get the current backgroud image. - -```java -public ImageData getOriginalImage(); -``` - -**Return Value** - -The `imageData` of the image. - -**Code Snippet** - -```java -ImageData image = imageEditorView.getOriginalImage(); -``` - -  - -## getDrawingLayer - -Get the instance of the target `DrawingLayer`. The target `DrawingLayer` will be created if it does not exist. - -```java -public DCEDrawingLayer getDrawingLayer(int id); -``` - -**Parameters** - -`id`: The id of the `DrawingLayer`. - -**Available ID List** - -| Layer | ID | -| ----- | -- | -| DDN_LAYER_ID | 1 | -| DBR_LAYER_ID | 2 | -| DLR_LAYER_ID | 3 | -| USER_DEFINED_LAYER_BASE_ID | 100 | - -**Return Value** - -An instance of [`DCEDrawingLayer`](dcedrawinglayer.html). - -**Code Snippet** - -```java -DCEDrawingLayer drawingLayer = dceImageEditorView.getDrawingLayer(DCEDrawingLayer.DDN_LAYER_ID); -``` - -  - -## createDrawingLayer - -Create a user-defined `DrawingLayer` instance. - -```java -public DCEDrawingLayer createDrawingLayer(); -``` - -**Return Value** - -An instance of [`DCEDrawingLayer`](dcedrawinglayer.html). - -**Code Snippet** - -```java -DCEDrawingLayer drawingLayer = dceImageEditorView.createDrawingLayer(); -``` - -  - -## getSelectedDrawingItem - -Get the user selected `DrawingItem`. - -```java -public DrawingItem getSelectedDrawingItem(); -``` - -**Return Value** - -An instance of `DrawingItem`. - -**Code Snippet** - -```java -DrawingItem drawingItem = dceImageEditorView.getSelectedDrawingItem(); -``` - -  diff --git a/programming-old/android/auxiliary-api/dlsconnection-v1.0.1.md b/programming-old/android/auxiliary-api/dlsconnection-v1.0.1.md deleted file mode 100644 index 05cd73d2..00000000 --- a/programming-old/android/auxiliary-api/dlsconnection-v1.0.1.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -layout: default-layout -title: Android DMLTSConnectionParameters Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android DMLTSConnectionParameters Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android DMLTSConnectionParameters Class -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DMLTSConnectionParameters Class -permalink: /programming/android/auxiliary-api/dlsconnection-v1.0.1.html ---- - -# DMLTSConnectionParameters - -`DMLTSConnectionParameters` is the class that defines a struct to configure the parameters to connect to the license tracking server. - -```java -class com.dynamsoft.dce.DMLTSConnectionParameters -``` - -| Attribute Name | Type | -|------|------| -| [`mainServerURL`](#mainserverurl) | String | -| [`standbyServerURL`](#standbyserverurl) | String | -| [`handshakeCode`](#handshakecode) | String | -| [`organizationID`](#organizationid) | String | -| [`sessionPassword`](#sessionpassword) | String | -| [`uuidGenerationMethod`](#uuidgenerationmethod) | int | -| [`maxBufferDays`](#maxbufferdays) | int | -| [`limitedLicenseModules`](#limitedlicensemodules) | list | -| [`chargeWay`](#chargeway) | int | -| [`products`](#products) | int | - -## mainServerURL - -The URL of the license tracking server. - -**Value Range** - -Any string value - -**Default Value** - -null - -**Code Snippet** - -```java -dceParameters.mainServerURL = ""; -``` - -**Remarks** - -If you choose "Dynamsoft-hosting", then no need to change the value of MainServerURL and StandbyServerURL. When both are set to null (default value), it will connect to Dynamsoft's license tracking servers for online verification. - -  - -## standbyServerURL - -The URL of the standby license tracking server. - -**Value Range** - -Any string value - -**Default Value** - -null - -**Code Snippet** - -```java -dceParameters.standbyServerURL = ""; -``` - -**Remarks** - -If you choose "Dynamsoft-hosting", then no need to change the value of MainServerURL and StandbyServerURL. When both are set to null (default value), it will connect to Dynamsoft's license tracking servers for online verification. - -  - -## handshakeCode - -The handshake code. - -**Value Range** - -Any string value - -**Default Value** - -null - -**Code Snippet** - -```java -dceParameters.handshakeCode = ""; -``` - -  - -## organizationID - -The organization ID - -**Value Range** - -Any string value - -**Default Value** - -null - -**Code Snippet** - -```java -dceParameters.organizationID = ""; -``` - -  - -## sessionPassword - -The session password of the handshake code set in license tracking server. - -**Value Range** - -Any string value - -**Default Value** - -null - -**Code Snippet** - -```java -dceParameters.sessionPassword = ""; -``` - -  - -## uuidGenerationMethod - -Sets the method to generate UUID. - -**Value Range** - -Any one of the [`EnumDMUUIDGenerationMethod`]({{ site.dce-enums }}enum-1.html?lang=android#enumcameradmuuidcenerationmethod) Enumeration items. - -**Default Value** - -DM_UUIDGM_RANDOM - -**Code Snippet** - -```java -dceParameters.uuidGenerationMethod = EnumCameraDMUUIDGenerationMethod.DM_UUIDGM_RANDOM; -``` - -**See Also** - -[`EnumDMUUIDGenerationMethod`]({{ site.dce-enums }}enum-1.html?lang=android#enumcameradmuuidcenerationmethod) - -  - - -## maxBufferDays - -Sets the max days to buffer the license info. - -**Value Range** - -[7,0x7fffffff] - -**Default Value** - -7 - -**Code Snippet** - - -```java -dceParameters.maxBufferDays = 7; -``` - - -  - -## chargeWay - -Sets the charge way. - -**Value Range** - -Any one of the [`EnumDMChargeWay`]({{ site.dce-enums }}enum-1.html?lang=android#enumdmchargeway) Enumeration items. - -**Default Value** - -DM_CW_AUTO - -**Code Snippet** - -```java -dceParameters.chargeWay = EnumDMChargeWay.DM_CW_DEVICE_COUNT; -``` - -**See Also** - -[`EnumDMChargeWay`]({{ site.dce-enums }}enum-1.html?lang=android#enumdmchargeway) - -  - -## products - -Set the products. This is a combined value of Product Enumration items. - -**Value Range** - -Any one of the [`EnumProduct`]({{ site.dce-enums }}enum-1.html?lang=android#enumproduct) Enumeration items. - -**Code Snippet** - -```java -dceParameters.products = EnumProduct.PROD_DBR; -``` - -**See Also** - -[`EnumProduct`]({{ site.dce-enums }}enum-1.html?lang=android#enumproduct) diff --git a/programming-old/android/auxiliary-api/dlsconnection.md b/programming-old/android/auxiliary-api/dlsconnection.md deleted file mode 100644 index 699fb175..00000000 --- a/programming-old/android/auxiliary-api/dlsconnection.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -layout: default-layout -title: Android DMDLSConnectionParameters Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android DMDLSConnectionParameters Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android DMDLSConnectionParameters Class -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DMDLSConnectionParameters Class -permalink: /programming/android/auxiliary-api/dlsconnection.html ---- - -# DMDLSConnectionParameters - -`DMDLSConnectionParameters` is the class that defines a struct to configure the parameters to connect to the Dynamsoft License Server. - -```java -class com.dynamsoft.dce.DMDLSConnectionParameters -``` - -| Attribute Name | Type | -| -------------- | ---- | -| [`mainServerURL`](#mainserverurl) | String | -| [`standbyServerURL`](#standbyserverurl) | String | -| [`handshakeCode`](#handshakecode) | String | -| [`organizationID`](#organizationid) | String | -| [`sessionPassword`](#sessionpassword) | String | -| [`uuidGenerationMethod`](#uuidgenerationmethod) | int | -| [`maxBufferDays`](#maxbufferdays) | int | -| [`limitedLicenseModules`](#limitedlicensemodules) | list | -| [`chargeWay`](#chargeway) | int | -| [`products`](#products) | int | - -## mainServerURL - -The URL of the Dynamsoft License Server. - -**Value Range** - -Any string value - -**Default Value** - -null - -**Code Snippet** - -```java -dceParameters.mainServerURL = ""; -``` - -**Remarks** - -If you choose "Dynamsoft-hosting", then no need to change the value of MainServerURL and StandbyServerURL. When both are set to null (default value), it will connect to Dynamsoft License Servers for online verification. - -  - -## standbyServerURL - -The URL of the standby Dynamsoft License Server. - -**Value Range** - -Any string value - -**Default Value** - -null - -**Code Snippet** - -```java -dceParameters.standbyServerURL = ""; -``` -**Remarks** - -If you choose "Dynamsoft-hosting", then no need to change the value of MainServerURL and StandbyServerURL. When both are set to null (default value), it will connect to Dynamsoft License Servers for online verification. - -  - - -## handshakeCode - -The handshake code. - -**Value Range** - -Any string value - -**Default Value** - -null - -**Code Snippet** - - -```java -dceParameters.handshakeCode = ""; -``` - -  - -## organizationID - -The organization ID - -**Value Range** - -Any string value - -**Default Value** - -null - -**Code Snippet** - -```java -dceParameters.organizationID = ""; -``` - -  - -## sessionPassword - -The session password of the handshake code set in Dynamsoft License Server. - -**Value Range** - -Any string value - -**Default Value** - -null - -**Code Snippet** - -```java -dceParameters.sessionPassword = ""; -``` - -  - -## uuidGenerationMethod - -Sets the method to generate UUID. - -**Value Range** - -Any one of the [`EnumDMUUIDGenerationMethod`]({{ site.dce-enums }}enum-1.html?lang=android#enumcameradmuuidcenerationmethod) Enumeration items. - -**Default Value** - -DM_UUIDGM_RANDOM - -**Code Snippet** - - -```java -dceParameters.uuidGenerationMethod = EnumCameraDMUUIDGenerationMethod.DM_UUIDGM_RANDOM; -``` - -**See Also** - -[`EnumDMUUIDGenerationMethod`]({{ site.dce-enums }}enum-1.html?lang=android#enumcameradmuuidcenerationmethod) - -  - -## maxBufferDays - -Sets the max days to buffer the license info. - -**Value Range** - -[7,0x7fffffff] - -**Default Value** - -7 - -**Code Snippet** - -```java -dceParameters.maxBufferDays = 7; -``` - -  - -## chargeWay - -Sets the charge way. - -**Value Range** - -Any one of the [`EnumDMChargeWay`]({{ site.dce-enums }}enum-1.html?lang=android#enumdmchargeway) Enumeration items. - -**Default Value** - -DM_CW_AUTO - -**Code Snippet** - -```java -dceParameters.chargeWay = EnumDMChargeWay.DM_CW_DEVICE_COUNT; -``` - -**See Also** - -[`EnumDMChargeWay`]({{ site.dce-enums }}enum-1.html?lang=android#enumdmchargeway) - -  - - -## products - -Set the products. This is a combined value of Product Enumration items. - -**Value Range** - -Any one of the [`EnumProduct`]({{ site.dce-enums }}enum-1.html?lang=android#enumproduct) Enumeration items. - -**Code Snippet** - - -```java -dceParameters.products = EnumProduct.PROD_DBR; -``` - -**See Also** - -[`EnumProduct`]({{ site.dce-enums }}enum-1.html?lang=android#enumproduct) diff --git a/programming-old/android/auxiliary-api/drawingitem-quad-v3.0.3.md b/programming-old/android/auxiliary-api/drawingitem-quad-v3.0.3.md deleted file mode 100644 index 8b3735e9..00000000 --- a/programming-old/android/auxiliary-api/drawingitem-quad-v3.0.3.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -layout: default-layout -title: Android QuadDrawingItem Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android QuadDrawingItem Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, QuadDrawingItem -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android QuadDrawingItem Class -permalink: /programming/android/auxiliary-api/drawingitem-quad-v3.0.3.html ---- - -# QuadDrawingItem Class - -`QuadDrawingItem` is a subclass of `DrawingItem`. Dynamsoft Camera Enhancer will draw the `QuadDrawingItem` on the UI if it is created and added to the `DCECameraView` or `DCEImageEditorView`. - -```java -class com.dynamsoft.dce.QuadDrawingItem extends DrawingItem -``` - -| Method | Descriptions | -| ------ | ------------ | -| [`QuadDrawingItem`](#quaddrawingitem) | The constructor of `QuadDrawingItem`. Create an instance of `QuadDrawingItem`. | -| [`getMediaType`](#getmediatype) | Get the media type of the `QuadDrawingItem`. | -| [`getQuad`](#getquad) | Get the `Quad` of the `QuadDrawingItem`. | -| [`getDrawingStyleId`](#getdrawingstyleid) | Get the drawing style of the current drawing item. | -| [`setDrawingStyleId`](#setdrawingstyleid) | Set the drawing style of the current drawing item. | -| [`getState`](#getstate) | Get the state of the current drawing item. | -| [`setState`](#setstate) | Set the state of the current drawing item. | - -## QuadDrawingItem - -The constructor of `QuadDrawingItem`. Create an instance of `QuadDrawingItem`. - -```java -public QuadDrawingItem(com.dynamsoft.core.Quadrilateral quad); -``` - -**Parameters** - -`quad`: The [`Quadrilateral`]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) that indicates the location of the `QuadDrawingItem`. - -**Code Snippet** - -```java -DrawingItem drawingItem = new QuadDrawingItem(quad); -``` - -  - -## getMediaType - -Get the media type of the `QuadDrawingItem`. - -```java -public EnumDrawingItemMeidaType getMediaType(); -``` - -**Return Value** - -The media type of the `QuadDrawingItem`. - -**Code Snippet** - -```java -EnumDrawingItemMediaType mediaType = drawingItem.getMediaType(); -``` - -  - -## getQuad - -Get the `Quad` of the `QuadDrawingItem`. - -```java -public com.dynamsoft.core.Quadrilateral getQuad(); -``` - -**Return Value** - -The [`Quadrilateral`]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) that indicates the location of the `QuadDrawingItem`. - -**Code Snippet** - -```java -com.dynamsoft.core.Quadrilateral quad = drawingItem.getQuad(); -``` - -  - -## getDrawingStyleId - -Get the ID of the `DrawingStyle` that is applied on this `DrawingItem`. - -```java -public int getDrawingStyleId(); -``` - -**Return Value** - -An int value that representing the style ID. - -**Code Snippet** - -```java -int styleId = drawingItem.getDrawingStyleId(); -``` - -  - -## setDrawingStyleId - -Set a `DrawingStyle` by ID for the `DrawingItem`. - -```java -public void setDrawingStyleId(int style); -``` - -**Parameters** - -`style`: An int value that representing the style ID. - -**Code Snippet** - -```java -drawingItem.setDrawingStyleId(0); -``` - -  - -## getState - -Get the status of the `DrawingItem`. - -```java -public EnumDrawingItemState getState(); -``` - -**Return Value** - -The value that indicates the state of the `DrawingItem`. View all available `DrawingItem` states in [`EnumDrawingItemState`]({{ site.android_camera_enhancer }}enum-drawing-item-state.html). - -**Code Snippet** - -```java -EnumDrawingItemState state = drawingItem.getState(); -``` - -  - -## setState - -Set the status of the `DrawingItem`. - -```java -public void setState(EnumDrawingItemState state); -``` - -**Parameters** - -`state`: The value that indicates the state of the `DrawingItem`. View all available `DrawingItem` states in [`EnumDrawingItemState`]({{ site.android_camera_enhancer }}enum-drawing-item-state.html). - -**Code Snippet** - -```java -drawingItem.setState(EnumDrawingItemState.DIS_SELECTED) -``` - -  diff --git a/programming-old/android/auxiliary-api/drawingitem-rect-v3.0.3.md b/programming-old/android/auxiliary-api/drawingitem-rect-v3.0.3.md deleted file mode 100644 index 0f51db6c..00000000 --- a/programming-old/android/auxiliary-api/drawingitem-rect-v3.0.3.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -layout: default-layout -title: Android RectDrawingItem Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android RectDrawingItem Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, RectDrawingItem -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android RectDrawingItem Class -permalink: /programming/android/auxiliary-api/drawingitem-rect-v3.0.3.html ---- - -# RectDrawingItem Class - -`RectDrawingItem` is a subclass of `DrawingItem`. Dynamsoft Camera Enhancer will draw the `RectDrawingItem` on the UI if it is created and added to the `DCECameraView` or `DCEImageEditorView`. - -```java -class com.dynamsoft.dce.RectDrawingItem extends DrawingItem -``` - -| Method | Descriptions | -| ------ | ------------ | -| [`RectDrawingItem`](#rectdrawingitem) | The constructor of `RectDrawingItem`. Create an instance of `RectDrawingItem`. | -| [`getMediaType`](#getmediatype) | Get the media type of the `RectDrawingItem`. | -| [`getRect`](#getrect) | Get the `Rect` of the `RectDrawingItem`. | -| [`getDrawingStyleId`](#getdrawingstyleid) | Get the drawing style of the current drawing item. | -| [`setDrawingStyleId`](#setdrawingstyleid) | Set the drawing style of the current drawing item. | -| [`getState`](#getstate) | Get the state of the current drawing item. | -| [`setState`](#setstate) | Set the state of the current drawing item. | - -  - -## RectDrawingItem - -The constructor of `RectDrawingItem`. Create an instance of `RectDrawingItem`. - -```java -public RectDrawingItem(android.graphics.Rect rect); -``` - -**Parameters** - -`rect`: The `Rect` that indicates the location of the `RectDrawingItem`. - -**Code Snippet** - -```java -DrawingItem drawingItem = new RectDrawingItem(rect); -``` - -  - -## getMediaType - -Get the media type of the `RectDrawingItem`. - -```java -public EnumDrawingItemMeidaType getMediaType(); -``` - -**Return Value** - -The media type of the `RectDrawingItem`. - -**Code Snippet** - -```java -EnumDrawingItemMediaType mediaType = drawingItem.getMediaType(); -``` - -  - -## getRect - -Get the `Rect` of the `RectDrawingItem`. - -```java -public android.graphics.Rect getRect(); -``` - -**Return Value** - -The `Rect` that indicates the location of the `RectDrawingItem`. - -**Code Snippet** - -```java -android.graphics.Rect rect = drawingItem.getRect(); -``` - -  - -## getDrawingStyleId - -Get the ID of the `DrawingStyle` that is applied on this `DrawingItem`. - -```java -public int getDrawingStyleId(); -``` - -**Return Value** - -An int value that representing the style ID. - -**Code Snippet** - -```java -int styleId = drawingItem.getDrawingStyleId(); -``` - -  - -## setDrawingStyleId - -Set a `DrawingStyle` by ID for the `DrawingItem`. - -```java -public void setDrawingStyleId(int style); -``` - -**Parameters** - -`style`: An int value that representing the style ID. - -**Code Snippet** - -```java -drawingItem.setDrawingStyleId(0); -``` - -  - -## getState - -Get the status of the `DrawingItem`. - -```java -public EnumDrawingItemState getState(); -``` - -**Return Value** - -The value that indicates the state of the `DrawingItem`. View all available `DrawingItem` states in [`EnumDrawingItemState`]({{ site.android_camera_enhancer }}enum-drawing-item-state.html). - -**Code Snippet** - -```java -EnumDrawingItemState state = drawingItem.getState(); -``` - -  - -## setState - -Set the status of the `DrawingItem`. - -```java -public void setState(EnumDrawingItemState state); -``` - -**Parameters** - -`state`: The value that indicates the state of the `DrawingItem`. View all available `DrawingItem` states in [`EnumDrawingItemState`]({{ site.android_camera_enhancer }}enum-drawing-item-state.html). - -**Code Snippet** - -```java -drawingItem.setState(EnumDrawingItemState.DIS_SELECTED) -``` - -  diff --git a/programming-old/android/auxiliary-api/drawingitem-text-v3.0.3.md b/programming-old/android/auxiliary-api/drawingitem-text-v3.0.3.md deleted file mode 100644 index 6e0d4fd6..00000000 --- a/programming-old/android/auxiliary-api/drawingitem-text-v3.0.3.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -layout: default-layout -title: Android TextDrawingItem Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android TextDrawingItem Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, TextDrawingItem -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android TextDrawingItem Class -permalink: /programming/android/auxiliary-api/drawingitem-text-v3.0.3.html ---- - -# TextDrawingItem Class - -`TextDrawingItem` is a subclass of `DrawingItem`. Dynamsoft Camera Enhancer will draw the `TextDrawingItem` on the UI if it is created and added to the `DCECameraView` or `DCEImageEditorView`. - -```java -class com.dynamsoft.dce.TextDrawingItem extends DrawingItem -``` - -| Method | Descriptions | -| ------ | ------------ | -| [`TextDrawingItem`](#textdrawingitem) | The constructor of `TextDrawingItem`. Create an instance of `TextDrawingItem`. | -| [`getMediaType`](#getmediatype) | Get the media type of the `TextDrawingItem`. | -| [`getText`](#gettext) | Get the `Text` of the `TextDrawingItem`. | -| [`getDrawingStyleId`](#getdrawingstyleid) | Get the drawing style of the current drawing item. | -| [`setDrawingStyleId`](#setdrawingstyleid) | Set the drawing style of the current drawing item. | -| [`getState`](#getstate) | Get the state of the current drawing item. | -| [`setState`](#setstate) | Set the state of the current drawing item. | - -  - -## TextDrawingItem - -The constructor of `TextDrawingItem`. Create an instance of `TextDrawingItem`. - -```java -public TextDrawingItem(String text, android.graphics.Rect textRect); -``` - -**Parameters** - -`text`: The text of the `TextDrawingItem`. -`textRect`: The `Rect` that indicates the location of the `TextDrawingItem`. - -**Code Snippet** - -```java -DrawingItem drawingItem = new TextDrawingItem(Text); -``` - -  - -## getMediaType - -Get the media type of the `TextDrawingItem`. - -```java -public EnumDrawingItemMeidaType getMediaType(); -``` - -**Return Value** - -The media type of the `TextDrawingItem`. - -**Code Snippet** - -```java -EnumDrawingItemMediaType mediaType = drawingItem.getMediaType(); -``` - -  - -## getText - -Get the `Text` of the `TextDrawingItem`. - -```java -public String getText(); -``` - -**Return Value** - -The text content of the `TextDrawingItem`. - -**Code Snippet** - -```java -String text = drawingItem.getText(); -``` - -  - -## getTextRect - -Get the `Rect` of the `TextDrawingItem`. It indicates the location of the `TextDrawingItem`. - -```java -public android.graphics.Rect getTextRect(); -``` - -**Return Value** - -The Rect of the `TextDrawingItem`. - -**Code Snippet** - -```java -android.graphics.Rect rect = drawingItem.getTextRect(); -``` - -  - -## getDrawingStyleId - -Get the ID of the `DrawingStyle` that is applied on this `DrawingItem`. - -```java -public int getDrawingStyleId(); -``` - -**Return Value** - -An int value that representing the style ID. - -**Code Snippet** - -```java -int styleId = drawingItem.getDrawingStyleId(); -``` - -  - -## setDrawingStyleId - -Set a `DrawingStyle` by ID for the `DrawingItem`. - -```java -public void setDrawingStyleId(int style); -``` - -**Parameters** - -`style`: An int value that representing the style ID. - -**Code Snippet** - -```java -drawingItem.setDrawingStyleId(0); -``` - -  - -## getState - -Get the status of the `DrawingItem`. - -```java -public EnumDrawingItemState getState(); -``` - -**Return Value** - -The value that indicates the state of the `DrawingItem`. View all available `DrawingItem` states in [`EnumDrawingItemState`]({{ site.android_camera_enhancer }}enum-drawing-item-state.html). - -**Code Snippet** - -```java -EnumDrawingItemState state = drawingItem.getState(); -``` - -  - -## setState - -Set the status of the `DrawingItem`. - -```java -public void setState(EnumDrawingItemState state); -``` - -**Parameters** - -`state`: The value that indicates the state of the `DrawingItem`. View all available `DrawingItem` states in [`EnumDrawingItemState`]({{ site.android_camera_enhancer }}enum-drawing-item-state.html). - -**Code Snippet** - -```java -drawingItem.setState(EnumDrawingItemState.DIS_SELECTED) -``` - -  diff --git a/programming-old/android/auxiliary-api/drawingitem-v3.0.3.md b/programming-old/android/auxiliary-api/drawingitem-v3.0.3.md deleted file mode 100644 index 1ecc5be5..00000000 --- a/programming-old/android/auxiliary-api/drawingitem-v3.0.3.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -layout: default-layout -title: Android DrawingItem Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DrawingItem Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DrawingItem -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DrawingItem Class -permalink: /programming/android/auxiliary-api/drawingitem-v3.0.3.html ---- - -# DrawingItem - -`DrawingItem` is the class for users to draw graphic items on the UI view. - -```java -class com.dynamsoft.dce.DrawingItem -``` - -| Method Name | Description | -| ----------- | ----------- | -| [`getDrawingStyleId`](#getdrawingstyleid) | Get the drawing style of the current drawing item. | -| [`setDrawingStyleId`](#setdrawingstyleid) | Set the drawing style of the current drawing item. | -| [`getState`](#getstate) | Get the state of the current drawing item. | -| [`setState`](#setstate) | Set the state of the current drawing item. | -| [`getMediaType`](#getmediatype) | Get the media type of the current drawing item. | - -  - -## getDrawingStyleId - -Get the ID of the `DrawingStyle` that is applied on this `DrawingItem`. - -```java -public int getDrawingStyleId(); -``` - -**Return Value** - -An int value that representing the style ID. - -**Code Snippet** - -```java -int styleId = drawingItem.getDrawingStyleId(); -``` - -  - -## setDrawingStyleId - -Set a `DrawingStyle` by ID for the `DrawingItem`. - -```java -public void setDrawingStyleId(int style); -``` - -**Parameters** - -`style`: An int value that representing the style ID. - -**Code Snippet** - -```java -drawingItem.setDrawingStyleId(0); -``` - -  - -## getState - -Get the status of the `DrawingItem`. - -```java -public EnumDrawingItemState getState(); -``` - -**Return Value** - -The value that indicates the state of the `DrawingItem`. View all available `DrawingItem` states in [`EnumDrawingItemState`]({{ site.android_camera_enhancer }}enum-drawing-item-state.html). - -**Code Snippet** - -```java -EnumDrawingItemState state = drawingItem.getState(); -``` - -  - -## setState - -Set the status of the `DrawingItem`. - -```java -public void setState(EnumDrawingItemState state); -``` - -**Parameters** - -`state`: The value that indicates the state of the `DrawingItem`. View all available `DrawingItem` states in [`EnumDrawingItemState`]({{ site.android_camera_enhancer }}enum-drawing-item-state.html). - -**Code Snippet** - -```java -drawingItem.setState(EnumDrawingItemState.DIS_SELECTED) -``` - -  - -## getMediaType - -Get the media type of the `DrawingItem`. - -```java -public abstract EnumDrawingItemMediaType getMediaType(); -``` - -**Return Value** - -One of the `EnumDrawingItemMediaType` that indicates the media type of the `DrawingItem`. - -**Code Snippet** - -```java -EnumDrawingItemMediaType type = drawingItem.getMediaType(); -``` diff --git a/programming-old/android/auxiliary-api/drawingstyle-v3.0.3.md b/programming-old/android/auxiliary-api/drawingstyle-v3.0.3.md deleted file mode 100644 index 324a2030..00000000 --- a/programming-old/android/auxiliary-api/drawingstyle-v3.0.3.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -layout: default-layout -title: Android DrawingStyle Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DrawingStyle Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DrawingStyle -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DrawingStyle Class -permalink: /programming/android/auxiliary-api/drawingstyle-v3.0.3.html ---- - -# DrawingStyle Class - -The class of DrawingStyle. It stores the detailed styles of the drawing item. - -```java -class com.dynamsoft.dce.DrawingStyle -``` - -| Method | Description | -| ------ | ----------- | -| [`DrawingStyle`](#drawingstyle) | The constructor of the `DrawingStyle`. | -| [`getId`](#getid) | Get the id of the drawing style. | -| [`getStrokeColor`](#getstrokecolor) | Get the stroke color of the drawing style. | -| [`setStrokeColor`](#setstrokecolor) | Set the stroke color of the drawing style. | -| [`getFillColor`](#getfillcolor) | Get the fill color of the drawing style. | -| [`setFillColor`](#setfillcolor) | Set the fill color of the drawing style. | -| [`getTextColor`](#gettextcolor) | Get the text color of the drawing style. | -| [`setTextColor`](#settextcolor) | Set the text color of the drawing style. | -| [`getStrokeWidth`](#getstrokewidth) | Get the stroke width of the drawing style. | -| [`setStrokeWidth`](#setstrokewidth) | Set the stroke width of the drawing style. | -| [`getFontSize`](#getfontsize) | Get the font size of the drawing style. | -| [`setFontSize`](#setfontsize) | Set the font size of the drawing style. | -| [`getFontFamily`](#getfontfamily) | Get the font-Family of the drawing style. | -| [`setFontFamily`](#setfontfamily) | Set the font-Family of the drawing style. | - -  - -## DrawingStyle - -The constructor of the `DrawingStyle`. - -```java -public DrawingStyle(int id, int strokeColor, float strokeWidth, int fillColor, int textColor, int fontSize, String fontFamily); -``` - -**Remarks** - -Please use [`DrawingStyleManager.createDrawingStyle`](drawingstylemanager.html#createdrawingstyle) to create the drawing style. - -  - -## getId - -Get the id of the drawing style. - -```java -public int getId(); -``` - -  - -## getStrokeColor - -Get the stroke color of the drawing style. - -```java -public int getStrokeColor(); -``` - -  - -## setStrokeColor - -Set the stroke color of the drawing style. - -```java -public void setStrokeColor(int color); -``` - -  - -## getFillColor - -Get the fill color of the drawing style. - -```java -public int getFillColor(); -``` - -  - -## setFillColor - -Set the fill color of the drawing style. - -```java -public void setFillColor(int color); -``` - -  - -## getTextColor - -Get the text color of the drawing style. - -```java -public int getTextColor(); -``` - -  - -## setTextColor - -Set the text color of the drawing style. - -```java -public void setTextColor(int color); -``` - -  - -## getStrokeWidth - -Get the stroke width of the drawing style. - -```java -public float getStrokeWidth(); -``` - -  - -## setStrokeWidth - -Set the stroke width of the drawing style. - -```java -public void setStrokeWidth(float width); -``` - -  - -## getFontSize - -Get the font size of the drawing style. - -```java -public int getFontSize(); -``` - -  - -## setFontSize - -Set the font size of the drawing style. - -```java -public void setFontSize(int size); -``` - -  - -## getFontFamily - -Get the font-Family of the drawing style. - -```java -public String getFontFamily(); -``` - -  - -## setFontFamily - -Set the font-Family of the drawing style. - -```java -public void setFontFamily(String font); -``` diff --git a/programming-old/android/auxiliary-api/drawingstylemanager-v3.0.3.md b/programming-old/android/auxiliary-api/drawingstylemanager-v3.0.3.md deleted file mode 100644 index 9df31265..00000000 --- a/programming-old/android/auxiliary-api/drawingstylemanager-v3.0.3.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -layout: default-layout -title: Android DrawingStyleManager Class - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Android DrawingStyleManager Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, DrawingStyleManager -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android DrawingStyleManager Class -permalink: /programming/android/auxiliary-api/drawingstylemanager-v3.0.3.html ---- - -# DrawingStyleManager - -`DrawingStyleManager` is the class for users to create and adjust `DrawingStyles`. - -```java -class com.dynamsoft.dce.DrawingStyleManager -``` - -| Method | Description | -| ------ | ----------- | -| [`getDrawingStyle`](#getdrawingstyle) | Get the `DrawingStyle` instance with the style ID. | -| [`createDrawingStyle`](#createdrawingstyle) | Create a user-defined `DrawingStyle` and get the style ID. | - -## getDrawingStyle - -Get the `DrawingStyle` instance with the style ID. - -```java -public static DrawingStyle getDrawingStyle(int styleId); -``` - -**Parameters** - -`styleId`: The ID of the target `DrawingStyle`. - -**Return Value** - -An instance of `DrawingStyle`. - -**Code Snippet** - -```java -DrawingStyle defaultStyle = DrawingStyleManager.getDrawingStyle(DrawingStyleManager.STYLE_ORANGE_STROKE); -``` - -**Remarks** - -There are 8 preset drawing styles. - -| ID | Style Name | -| -- | ---------- | -| 1 | `STYLE_BLUE_STROKE` | -| 2 | `STYLE_GREEN_STROKE` | -| 3 | `STYLE_ORANGE_STROKE` | -| 4 | `STYLE_YELLOW_STROKE` | -| 5 | `STYLE_BLUE_STROKE_FILL` | -| 6 | `STYLE_GREEN_STROKE_FILL` | -| 7 | `STYLE_ORANGE_STROKE_FILL` | -| 8 | `STYLE_YELLOW_STROKE_FILL` | - -  - -## createDrawingStyle - -Create a user-defined `DrawingStyle` and get the style ID. - -```java -public static int createDrawingStyle(int strokeColor, float strokeWidth, int fillColor, int textColor, int fontSize, String fontFamily); -``` - -**Parameters** - -`strokeColor`: The stroke colour. -`strokeWidth`: The width of the stroke (measured by px). -`fillColor`: The fill colour. -`textColor`: The text colour. -`fontSize`: The font size (measured by sp). -`fontFamily`: The font family. - -**Code Snippet** - -```java -int myStyleId = styleManager.createDrawingStyle(0xff00ff00,2,0xff00ff00,0xff00ff00,12,"sans-serif") -``` diff --git a/programming-old/android/auxiliary-api/guide-of-drawing-items-v3.0.3.md b/programming-old/android/auxiliary-api/guide-of-drawing-items-v3.0.3.md deleted file mode 100644 index 3d71cecd..00000000 --- a/programming-old/android/auxiliary-api/guide-of-drawing-items-v3.0.3.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -layout: default-layout -title: Android UI Configuration - Dynamsoft Camera Enhancer Documents -description: This is the documentation - Guide on Android page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Guide on Android -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android Guide -permalink: /programming/android/auxiliary-api/guide-of-drawing-items-v3.0.3.html ---- - -# UI Configurations - -# UI Configurations Classes - -| Class | Description | -| ----- | ----------- | -| [`DCECameraView`](dcecameraview.html) | The view displays video streaming and auxiliary UI elements. | -| [`DCEImageEditorView`](dceimageeditorview.html) | The view displays still image and auxiliary UI elements. | - -`DCECameraView` and `DCEImageEditorView` are the main classes for user to configure the UI. `DrawingItems` are the UI elements that user can create, modify and interact on the UI view. All the `DrawingItems` are contained in `DCEDrawingLayers` and finally displayed on the `DCECameraView` or `DCEImageEditorView`. - -
    -

    drawing-item

    -

    DrawingItems in DCECameraView and DCEImageEditorView

    -
    - -## Basic Usages - -  - -### Display Highlight Overlays - -When `DynamsoftCameraEnhancer(DCE)` is used together with other Dynamsoft products like `DynamsoftBarcodeReader(DBR)` and `DynamsoftDocumentNormalizer(DDN)`, it can automatically draw highlight overlays (`QuadDrawingItem`) on the detected barcodes or documents. If you want to disable this feature, you can use the following code to stop drawing the highlights. - -```java -// Example: Remove all highlights on the barcodes -editorView.getDrawingLayer(DCEDrawingLayer.DBR_LAYER_ID).setVisible(false); -``` - -  - -### Style Configuration - -You can change the style of the `DrawingItems` specifying a `DrawingStyleId`. The `DrawingStyleId` can be a preset `DrawingStyle` or a user-defined `DrawingStyle`. - -To change the style of `DrawingItems` with preset `DrawingStyles`: - -```java -// You can change the drawing style of all DrawingItems in the layer. -cameraView.getDrawingLayer(DCEDrawingLayer.DBR_LAYER_ID).setDrawingStyleId(DrawingStyleManager.STYLE_ORANGE_STROKE); -// You can also change the drawing style of a part of the DrawingItems. -editorView.getDrawingLayer(DCEDrawingLayer.DBR_LAYER_ID).setDrawingStyleId(DrawingStyleManager.STYLE_ORANGE_STROKE, EnumDrawingItemState.DIS_SELECTED, EnumDrawingItemMediaType.DIMT_QUADRILATERAL); -``` - -List of all available preset styles: - -```java -// DrawingItems on DDN layer are using this style as default. -public static int STYLE_BLUE_STROKE = 1; -// DrawingItems on DBR layer are using this style as default. -public static int STYLE_GREEN_STROKE = 2; -// DrawingItems on DLR layer are using this style as default. -public static int STYLE_ORANGE_STROKE = 3; -// DrawingItems on user defined layer are using this style as default. -public static int STYLE_YELLOW_STROKE = 4; -// DrawingItems on DDN layer are using this style as default if they are selected. -public static int STYLE_BLUE_STROKE_FILL = 5; -// DrawingItems on DBR layer are using this style as default if they are selected. -public static int STYLE_GREEN_STROKE_FILL = 6; -// DrawingItems on DLR layer are using this style as default if they are selected. -public static int STYLE_ORANGE_STROKE_FILL = 7; -// DrawingItems on user defined layer are using this style as default if they are selected. -public static int STYLE_YELLOW_STROKE_FILL = 8; -``` - -
    -

    drawing-item

    -

    Preset DrawingStyles

    -
    - -If you want to set other styles to your UI elements, you can add your personal defined `DrawingStyles`. - -```java -// Create a new DrawingStyle via DrawingStyle manager and get the style ID of the new style. -int myStyleId = DrawingStyleManager.createDrawingStyle(0xff00ff00,2,0xff00ff00,0xff00ff00,12,"sans-serif"); -// Assign the newly created style to the targeting DrawingItems. -cameraView.getDrawingLayer(DCEDrawingLayer.DBR_LAYER_ID).setDrawingStyleId(myStyleId); -``` - -To modify the existing DrawingStyles: - -```java -// Get the style by ID. -DrawingStyle myStyle = DrawingStyleManager.getDrawingStyle(myStyleId); -// Modify the style. -myStyle.strokeColor = 0xff00ff00; -``` - -  - -## Advanced Usages - -  - -### Add User Defined UI Elements - -Apart from the system-defined items, you can add your personal defined UI elements via the `DrawingItem` APIs. On this page, we will draw a user-defined `quadrilateral` on the `DCEImageEditorView` for example. - -1. Create a new `QuadDrawingItem`. - - ```java - // Create a new quadrilateral. - com.dynamsoft.core.Quadrilateral newQuad = new Quadrilateral(); - // Add your code to assign the quad data. - newQuad.points = new com.dynamsoft.core.Point[]{new Point(0,0),new Point(100,0), new Point(100,100), new Point(0,100)}; - // Use the newly created quadrilateral to initialize the DrawingItem. - DrawingItem item = new QuadDrawingItem(newQuad); - ``` - -2. Add the Created `DrawingItems` to the view. - - ```java - // To display the drawingItems on the UI, you have to put the DrawingItems in a ArrayList. - ArrayList drawingItems = new ArrayList<>(); - drawingItems.add(item); - // The following code shows how to add the ArrayList of DrawingItems to the first layer of the cameraView. - // There are multiple layers in DCECameraView and DCEImageEditorView. - // You must select a layer for your DrawingItems. - cameraView.getDrawingLayer(DCEDrawingLayer.DDN_LAYER_ID).addDrawingItems(drawingItems); - // To add the DrawingItems to the imageEditorView - // imageEditorView.getDrawingLayer(DCEDrawingLayer.DDN_LAYER_ID).addDrawingItems(drawingItems); - ``` - -  diff --git a/programming-old/android/auxiliary-api/hardwareutil.md b/programming-old/android/auxiliary-api/hardwareutil.md deleted file mode 100644 index fd3df273..00000000 --- a/programming-old/android/auxiliary-api/hardwareutil.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -layout: default-layout -title: Android HardwareUtil Class - Dynamsoft Camera Enhancer -description: This is the documentation - Android HardwareUtil Class page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Android, HardwareUtil -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android HardwareUtil Class -permalink: /programming/android/auxiliary-api/hardwareutil.html ---- - -# HardwareUtil - -This page is for `HardwareUtil` page. `HardwareUtil` parameters are static values that illustrate device level. - -```java -class com.dynamsoft.dce.HardwareUtil -``` - -| Attribute Name | Value | -| -------------- | ----- | -| `DEVICEINFO_UNKNOWN` | -1 | -| `DEVICE_LEVEL_HIGH` | 2 | -| `DEVICE_LEVEL_MID` | 1 | -| `DEVICE_LEVEL_LOW` | 0 | -| `DEVICE_LEVEL_UNKNOWN` | -2 | - -## Device level - -**Related API** - -[`getDeviceLevel`]({{ site.android-api }}camera.html#getdevicelevel) - -**Code Snippet** - -```java -int level; -level = mCamera.getDeviceLevel(); -if (level == HardwareUtil.DEVICE_LEVEL_LOW){ - mCamera.enableFrameFilter(true); - mCamera.enableDCEAutoFocus(true); -} -``` - diff --git a/programming-old/android/auxiliary-api/index-v3.0.3.md b/programming-old/android/auxiliary-api/index-v3.0.3.md deleted file mode 100644 index a4b6a41e..00000000 --- a/programming-old/android/auxiliary-api/index-v3.0.3.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: default-layout -title: Android Camera Enhancer Library - Dynamsoft Camera Enhancer Documents -description: This is the main page of Camera Enhancer API Reference for Android SDK. -keywords: api reference, Android, camera enhancer -needAutoGenerateSidebar: true -needGenerateH3Content: true -breadcrumbText: Android Camera Enhancer -noTitleIndex: true -permalink: /programming/android/auxiliary-api/index-v3.0.3.html ---- - -# Camera Enhancer API Reference - -`DynamsoftCameraEnhancer` is the libary that provides camera control and UI configuration APIs. - -## Components - -**Main Class** - -| Classes | Description | -| ------- | ----------- | -| [`DynamsoftCameraEnhancer`](camera-enhancer.html) | The main class that includes camera control APIs. Features like frame filtering can be enabled via this class. | - -**UI Classes** - -| Classes | Description | -| ------- | ----------- | -| [`DCECameraView`](dcecameraview.html) | UI view class that displays video streaming. UI configuration APIs are available for users to visualize the detected results on the video streaming. | -| [`DCEImageEditorView`](dceimageeditorview.html) | UI view class that displays images. UI configuration APIs are available for users to highlight the detected results on the view with quadrilateral elements. The border of the quadrilaterals can be edited so that user can further accurate the detected results. | - -
    -

    edit

    -

    DynamsoftCameraEnhancer UI View

    -
    - -**Auxiliary Classes** - -| Classes | Description | -| ------- | ----------- | -| [`DCEFrame`](dceframe.html) | The struct that `DynamsoftCameraEnhancer` stores the video frames. It contains the image data and other information of the video frame. | -| [`DCEDrawingLayer`](dcedrawinglayer.html) | The layers that contains `DrawingItems`. Users can add configurations for the `DrawingItems` via `DCEDrawingLayer` | -| [`DrawingItem`](drawingitem.html) | The`DrawingItems` are elements that can be added the UI. | -| [`QuadDrawingItem`](drawingitem-quad.html) | A subclass of `DrawingItem`. Users can add `QuadDrawingItems` to the layer to display quadrilateral elements on the view. | -| [`RectDrawingItem`](drawingitem-rect.html) | A subclass of `DrawingItem`. Users can add `RectDrawingItems` to the layer to display rectangle elements on the view. | -| [`TextDrawingItem`](drawingitem-text.html) | A subclass of `DrawingItem`. Users can add `TextDrawingItems` to the layer to display text box on the view. | -| [`DrawingStyle`](drawingstyle.html) | `DrawingStyle` stores colour, font and other detailed styles of `DrawingItems`. | -| [`DrawingStyleManager`](drawingstylemanager.html) | The class for users to create and adjust `DrawingStyles`. | -| [`CameraEnhancerException`](camera-enhancer-exception.html) | Exception for signaling camera enhancer errors. | - -**Interface** - -| Classes | Description | -| ------- | ----------- | -| [`DCEFrameListener`](interface-dceframelistener.html) | The interface to handle callback when previewed frame callback is returned. | -| [`DCECameraStateListener`](interface-dcecamerastatelistener.html) | The interface to handle callback when camera state changes. | diff --git a/programming-old/android/auxiliary-api/interface-dcecamerastatelistener-v2.3.11.md b/programming-old/android/auxiliary-api/interface-dcecamerastatelistener-v2.3.11.md deleted file mode 100644 index 7abc3125..00000000 --- a/programming-old/android/auxiliary-api/interface-dcecamerastatelistener-v2.3.11.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default-layout -title: Interface DCECameraStateListener - Dynamsoft Camera Enhancer -description: This is the documentation - DCECameraStateListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCECameraStateListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCECameraStateListener -permalink: /programming/android/auxiliary-api/interface-dcecamerastatelistener-v2.3.11.html ---- - -# DCECameraStateListener - -The interface to handle callback when camera state changes. - -```java -interface com.dynamsoft.dce.DCECameraStateListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`stateChangeCallback`](#statechangecallback) | The callback method is triggered when **camera state** changes. | - -## stateChangeCallback - -The callback method is triggered when **camera state** changes. - -```java -void stateChangeCallback(EnumCameraState currentState); -``` - -**Parameters** - -`currentState`: The camera state. It includes `opened`, `opening`, `closed` and `closing`. - -**Code Snippet** - -```java -cameraEnhancer.setCameraStateListener(new DCECameraStateListener() { - @Override - public void stateChangeCallback(EnumCameraState currentState) { - // Add your code to do when camera state changes - } -}); -``` - -**See also** - -- [`setCameraStateListener`](../camera-enhancer/camera-enhancer.html#setcamerastatelistener) diff --git a/programming-old/android/auxiliary-api/interface-dcecamerastatelistener-v2.3.12.md b/programming-old/android/auxiliary-api/interface-dcecamerastatelistener-v2.3.12.md deleted file mode 100644 index d1b0da18..00000000 --- a/programming-old/android/auxiliary-api/interface-dcecamerastatelistener-v2.3.12.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default-layout -title: Interface DCECameraStateListener - Dynamsoft Camera Enhancer -description: This is the documentation - DCECameraStateListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCECameraStateListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCECameraStateListener -permalink: /programming/android/auxiliary-api/interface-dcecamerastatelistener-v2.3.12.html ---- - -# DCECameraStateListener - -The interface to handle callback when camera state changes. - -```java -interface com.dynamsoft.dce.DCECameraStateListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`stateChangeCallback`](#statechangecallback) | The callback method is triggered when **camera state** changes. | - -## stateChangeCallback - -The callback method is triggered when **camera state** changes. - -```java -void stateChangeCallback(EnumCameraState currentState); -``` - -**Parameters** - -`currentState`: The camera state. It includes `opened`, `opening`, `closed` and `closing`. - -**Code Snippet** - -```java -cameraEnhancer.setCameraStateListener(new DCECameraStateListener() { - @Override - public void stateChangeCallback(EnumCameraState currentState) { - // Add your code to do when camera state changes - } -}); -``` - -**See also** - -- [`setCameraStateListener`](../camera-enhancer/camera-enhancer.html#setcamerastatelistener) diff --git a/programming-old/android/auxiliary-api/interface-dcecamerastatelistener-v3.0.3.md b/programming-old/android/auxiliary-api/interface-dcecamerastatelistener-v3.0.3.md deleted file mode 100644 index c12a7cc4..00000000 --- a/programming-old/android/auxiliary-api/interface-dcecamerastatelistener-v3.0.3.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default-layout -title: Interface DCECameraStateListener - Dynamsoft Camera Enhancer -description: This is the documentation - DCECameraStateListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCECameraStateListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCECameraStateListener -permalink: /programming/android/auxiliary-api/interface-dcecamerastatelistener-v3.0.3.html ---- - -# DCECameraStateListener - -The interface to handle callback when camera state changes. - -```java -interface com.dynamsoft.dce.DCECameraStateListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`stateChangeCallback`](#statechangecallback) | The callback method is triggered when **camera state** changes. | - -## stateChangeCallback - -The callback method is triggered when **camera state** changes. - -```java -void stateChangeCallback(EnumCameraState currentState); -``` - -**Parameters** - -`currentState`: The camera state. It includes `opened`, `opening`, `closed` and `closing`. - -**Code Snippet** - -```java -cameraEnhancer.setCameraStateListener(new DCECameraStateListener() { - @Override - public void stateChangeCallback(EnumCameraState currentState) { - // Add your code to do when camera state changes - } -}); -``` - -**See also** - -- [`setCameraStateListener`](../camera-enhancer/camera-enhancer.html#setcamerastatelistener) diff --git a/programming-old/android/auxiliary-api/interface-dceframelistener-v1.0.3.md b/programming-old/android/auxiliary-api/interface-dceframelistener-v1.0.3.md deleted file mode 100644 index 95325854..00000000 --- a/programming-old/android/auxiliary-api/interface-dceframelistener-v1.0.3.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -layout: default-layout -title: Android CameraListener - Dynamsoft Camera Enhancer -description: This is the documentation - CameraListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, CameraListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: CameraListener -permalink: /programming/android/auxiliary-api/interface-dceframelistener-v1.0.3.html ---- - -# CameraListener - -The interface to handle callback when previewed frame callback is returned. - -```java -interface com.dynamsoft.dce.CameraListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`onPreviewOriginalFrame`](#onprevieworiginalframe) | The callback function where you can add code to use the previewed **original** frames. | -| [`onPreviewFilterFrame`](#onpreviewfilterframe) | The callback function where you can add code to use the previewed **filtered** frames. | -| [`onPreviewFastFrame`](#onpreviewfastframe) | The callback function where you can add code to use the previewed **cropped** frames. | - -  - -## onPreviewOriginalFrame - -The callback function where you can add code to use the previewed **original** frames. - -```java -void onPreviewOriginalFrame(Frame originalFrame); -``` - -**Parameters** - -`originalFrame`: The data of original frame(s). The Camera Enhancer can make preprocessing on video frames. In this callback function, the input parameters are the original frames that are captured by the camera. - -**Code Snippet** - -```java -cameraEnhancer.addCameraListener(new CameraListener() { - @Override - public void onPreviewOriginalFrame(Frame originalFrame) { - // Add your code - } - @Override - public void onPreviewFilterFrame(Frame filteredFrame) {} - @Override - public void onPreviewFastFrame(Frame fastFrame) {} -}); -``` - -**See also** - -- [`class Frame`]({{site.android-api-auxiliary}}dceframe.html) - -  - - -## onPreviewFilterFrame - -The callback function where you can add code to use the previewed **filtered** frames. - -```java -void onPreviewFilterFrame(Frame filteredFrame); -``` - -**Parameters** - -`filteredFrame`: The data of filtered frame(s). The Camera Enhancer can make preprocessing on video frames. If the frame filter processing is enabled, the input parameter of this function will be the filtered frames. - -**Code Snippet** - -```java -cameraEnhancer.addCameraListener(new CameraListener() { - @Override - public void onPreviewOriginalFrame(Frame originalFrame) {} - @Override - public void onPreviewFilterFrame(Frame filteredFrame) { - // Add your code - } - @Override - public void onPreviewFastFrame(Frame fastFrame) {} -}); -``` - -**See also** - -- [`class Frame`]({{site.android-api-auxiliary}}dceframe.html) -- [`enableFrameFilter`]({{site.android-api}}preprocess.html#enableframefilter) - -  - -## onPreviewFastFrame - -The callback function where you can add code to use the previewed **cropped** frames. - -```java -void onPreviewFastFrame(Frame fastFrame); -``` - -**Parameters** - -`fastFrame`: The data of cropped frame(s). The Camera Enhancer can make preprocessing on video frames. If the fast mode is enabled, the input parameter of this function will be the specially cropped frames. - -**Code Snippet** - -```java -cameraEnhancer.addCameraListener(new CameraListener() { - @Override - public void onPreviewOriginalFrame(Frame originalFrame) {} - @Override - public void onPreviewFilterFrame(Frame filteredFrame) {} - @Override - public void onPreviewFastFrame(Frame fastFrame) { - // Add your code - } -}); -``` - -**See also** - -- [`class Frame`]({{site.android-api-auxiliary}}dceframe.html) -- [`enableFastMode`]({{site.android-api}}preprocess.html#enablefastmode) diff --git a/programming-old/android/auxiliary-api/interface-dceframelistener-v2.3.11.md b/programming-old/android/auxiliary-api/interface-dceframelistener-v2.3.11.md deleted file mode 100644 index a714b519..00000000 --- a/programming-old/android/auxiliary-api/interface-dceframelistener-v2.3.11.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default-layout -title: Android DCEFrameListener - Dynamsoft Camera Enhancer Documents -description: This is the documentation - DCEFrameListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCEFrameListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCEFrameListener -permalink: /programming/android/auxiliary-api/interface-dceframelistener-v2.3.11.html ---- - -# DCEFrameListener - -The interface to handle callback when previewed frame callback is returned. - -```java -interface com.dynamsoft.dce.DCEFrameListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`frameOutputCallback`](#frameoutputcallback) | The callback method for user to implement when frame is output. | - -## frameOutputCallback - -The callback method can be triggered when `frame` is output. - -```java -void frameOutputCallback(DCEFrame frame, long timeStamp); -``` - -**Parameters** - -`frame`: The `DCEFrame` object that contains the image data and further information. -`timeStamp`: The `timeStamp` that records when the `frame` is output. - -**Code Snippet** - -```java -cameraEnhancer.addListener(new DCEFrameListener() { - @Override - public void frameOutputCallback(DCEFrame frame, long timeStamp) { - // Add your code - } -}); -``` - -**See also** - -- [`class DCEFrame`](dceframe.html) diff --git a/programming-old/android/auxiliary-api/interface-dceframelistener-v2.3.12.md b/programming-old/android/auxiliary-api/interface-dceframelistener-v2.3.12.md deleted file mode 100644 index 00754bb9..00000000 --- a/programming-old/android/auxiliary-api/interface-dceframelistener-v2.3.12.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default-layout -title: Android DCEFrameListener - Dynamsoft Camera Enhancer Documents -description: This is the documentation - DCEFrameListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCEFrameListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCEFrameListener -permalink: /programming/android/auxiliary-api/interface-dceframelistener-v2.3.12.html ---- - -# DCEFrameListener - -The interface to handle callback when previewed frame callback is returned. - -```java -interface com.dynamsoft.dce.DCEFrameListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`frameOutputCallback`](#frameoutputcallback) | The callback method for user to implement when frame is output. | - -## frameOutputCallback - -The callback method can be triggered when `frame` is output. - -```java -void frameOutputCallback(DCEFrame frame, long timeStamp); -``` - -**Parameters** - -`frame`: The `DCEFrame` object that contains the image data and further information. -`timeStamp`: The `timeStamp` that records when the `frame` is output. - -**Code Snippet** - -```java -cameraEnhancer.addListener(new DCEFrameListener() { - @Override - public void frameOutputCallback(DCEFrame frame, long timeStamp) { - // Add your code - } -}); -``` - -**See also** - -- [`class DCEFrame`](dceframe.html) diff --git a/programming-old/android/auxiliary-api/interface-dceframelistener-v3.0.3.md b/programming-old/android/auxiliary-api/interface-dceframelistener-v3.0.3.md deleted file mode 100644 index bfa3d245..00000000 --- a/programming-old/android/auxiliary-api/interface-dceframelistener-v3.0.3.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default-layout -title: Android DCEFrameListener - Dynamsoft Camera Enhancer Documents -description: This is the documentation - DCEFrameListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCEFrameListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCEFrameListener -permalink: /programming/android/auxiliary-api/interface-dceframelistener-v3.0.3.html ---- - -# DCEFrameListener - -The interface to handle callback when previewed frame callback is returned. - -```java -interface com.dynamsoft.dce.DCEFrameListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`frameOutputCallback`](#frameoutputcallback) | The callback method for user to implement when frame is output. | - -## frameOutputCallback - -The callback method can be triggered when `frame` is output. - -```java -void frameOutputCallback(DCEFrame frame, long timeStamp); -``` - -**Parameters** - -`frame`: The `DCEFrame` object that contains the image data and further information. -`timeStamp`: The `timeStamp` that records when the `frame` is output. - -**Code Snippet** - -```java -cameraEnhancer.addListener(new DCEFrameListener() { - @Override - public void frameOutputCallback(DCEFrame frame, long timeStamp) { - // Add your code - } -}); -``` - -**See also** - -- [`class DCEFrame`](dceframe.html) diff --git a/programming-old/android/auxiliary-api/interface-dcephotolistener-v2.3.11.md b/programming-old/android/auxiliary-api/interface-dcephotolistener-v2.3.11.md deleted file mode 100644 index 942dcd3b..00000000 --- a/programming-old/android/auxiliary-api/interface-dcephotolistener-v2.3.11.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -layout: default-layout -title: Android DCEPhotoListener - Dynamsoft Camera Enhancer Documents -description: This is the documentation - DCEPhotoListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCEPhotoListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCEPhotoListener -permalink: /programming/android/auxiliary-api/interface-dcephotolistener-v2.3.11.html ---- - -# DCEPhotoListener - -The interface that provide method for capturing photo from the camera. - -```java -interface com.dynamsoft.dce.DCEPhotoListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`photoOutputCallback`](#photooutputcallback) | The callback method for user to receive the captured photo. | - -## photoOutputCallback - -The callback method for user to receive the captured photo. User can complete the method by adding code to execute with the capture image. - -```java -photoOutputCallback(byte[] bytes) -``` - -**Parameters** - -`bytes`: The byte data of the captured image. - -**Code Snippet** - -```java -// Create an instance of DCEPhotoListener -DCEPhotoListener photoListener = new DCEPhotoListener() { - @Override - public void photoOutputCallback(byte[] bytes) { - // Add your code to execute when photo is captured. - // For example, you can use Dynamsoft Barcode Reader (DBR) to decode the byte image. - try { - BarcodeReader mReader = new BarcodeReader(); - mReader.decodeFileInMemory(bytes); - } catch (BarcodeReaderException e) { - e.printStackTrace(); - } - } -}; -// Since you have configured the photoOutputCallback. -// When you trigger takePhote method, the library firstly capture a photo -// When the photo is captured and stored in memory, it will be processed by DBR -mCameraEnhancer.takePhoto(photoListener); -``` diff --git a/programming-old/android/auxiliary-api/interface-dcephotolistener-v2.3.12.md b/programming-old/android/auxiliary-api/interface-dcephotolistener-v2.3.12.md deleted file mode 100644 index d53e1847..00000000 --- a/programming-old/android/auxiliary-api/interface-dcephotolistener-v2.3.12.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -layout: default-layout -title: Android DCEPhotoListener - Dynamsoft Camera Enhancer Documents -description: This is the documentation - DCEPhotoListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCEPhotoListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCEPhotoListener -permalink: /programming/android/auxiliary-api/interface-dcephotolistener-v2.3.12.html ---- - -# DCEPhotoListener - -The interface that provide method for capturing photo from the camera. - -```java -interface com.dynamsoft.dce.DCEPhotoListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`photoOutputCallback`](#photooutputcallback) | The callback method for user to receive the captured photo. | - -## photoOutputCallback - -The callback method for user to receive the captured photo. User can complete the method by adding code to execute with the capture image. - -```java -photoOutputCallback(byte[] bytes) -``` - -**Parameters** - -`bytes`: The byte data of the captured image. - -**Code Snippet** - -```java -// Create an instance of DCEPhotoListener -DCEPhotoListener photoListener = new DCEPhotoListener() { - @Override - public void photoOutputCallback(byte[] bytes) { - // Add your code to execute when photo is captured. - // For example, you can use Dynamsoft Barcode Reader (DBR) to decode the byte image. - try { - BarcodeReader mReader = new BarcodeReader(); - mReader.decodeFileInMemory(bytes); - } catch (BarcodeReaderException e) { - e.printStackTrace(); - } - } -}; -// Since you have configured the photoOutputCallback. -// When you trigger takePhote method, the library firstly capture a photo -// When the photo is captured and stored in memory, it will be processed by DBR -mCameraEnhancer.takePhoto(photoListener); -``` diff --git a/programming-old/android/auxiliary-api/interface-dcephotolistener-v3.0.3.md b/programming-old/android/auxiliary-api/interface-dcephotolistener-v3.0.3.md deleted file mode 100644 index 6d45865b..00000000 --- a/programming-old/android/auxiliary-api/interface-dcephotolistener-v3.0.3.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -layout: default-layout -title: Android DCEPhotoListener - Dynamsoft Camera Enhancer Documents -description: This is the documentation - DCEPhotoListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCEPhotoListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCEPhotoListener -permalink: /programming/android/auxiliary-api/interface-dcephotolistener-v3.0.3.html ---- - -# DCEPhotoListener - -The interface that provide method for capturing photo from the camera. - -```java -interface com.dynamsoft.dce.DCEPhotoListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`photoOutputCallback`](#photooutputcallback) | The callback method for user to receive the captured photo. | - -## photoOutputCallback - -The callback method for user to receive the captured photo. User can complete the method by adding code to execute with the capture image. - -```java -photoOutputCallback(byte[] bytes) -``` - -**Parameters** - -`bytes`: The byte data of the captured image. - -**Code Snippet** - -```java -// Create an instance of DCEPhotoListener -DCEPhotoListener photoListener = new DCEPhotoListener() { - @Override - public void photoOutputCallback(byte[] bytes) { - // Add your code to execute when photo is captured. - // For example, you can use Dynamsoft Barcode Reader (DBR) to decode the byte image. - try { - BarcodeReader mReader = new BarcodeReader(); - mReader.decodeFileInMemory(bytes); - } catch (BarcodeReaderException e) { - e.printStackTrace(); - } - } -}; -// Since you have configured the photoOutputCallback. -// When you trigger takePhote method, the library firstly capture a photo -// When the photo is captured and stored in memory, it will be processed by DBR -mCameraEnhancer.takePhoto(photoListener); -``` diff --git a/programming-old/android/auxiliary-api/interface-licenselistener-v1.0.1.md b/programming-old/android/auxiliary-api/interface-licenselistener-v1.0.1.md deleted file mode 100644 index 61591663..00000000 --- a/programming-old/android/auxiliary-api/interface-licenselistener-v1.0.1.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default-layout -title: Android CameraLTSLicenseVerificationListener - Dynamsoft Camera Enhancer -description: This is the documentation - CameraLTSLicenseVerificationListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, CameraLTSLicenseVerificationListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: CameraLTSLicenseVerificationListener -permalink: /programming/android/auxiliary-api/interface-licenselistener-v1.0.1.html ---- - - -# CameraLTSLicenseVerificationListener - -The interface to handle callback when license verification messages are returned. - -```java -interface com.dynamsoft.dce.CameraLTSLicenseVerificationListener -``` - -| Method | Description | -| ------ | ----------- | -| `LTSLicenseVerificationCallback` | The call back of the license server. | - -## LTSLicenseVerificationCallback - -The call back of the license server. Add the code in the callback function to react when the license server connection is successful or failed. - -```java -void LTSLicenseVerificationCallback(boolean isSuccess, Exception error); -``` - -**Parameters** - -`isSuccess`: Whether the license verification was successful. -`error`: The error message from the license server. - -**Code Snippet** - -```java -cameraEnhancer.initLicenseFromLTS(dceParameters, new CameraLTSLicenseVerificationListener() { - @Override - public void LTSLicenseVerificationCallback(boolean isSuccess, Exception e) { - if (!isSuccess) { - e.printStackTrace(); - } - } -}); -``` diff --git a/programming-old/android/auxiliary-api/interface-licenselistener-v1.0.3.md b/programming-old/android/auxiliary-api/interface-licenselistener-v1.0.3.md deleted file mode 100644 index 618103d3..00000000 --- a/programming-old/android/auxiliary-api/interface-licenselistener-v1.0.3.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default-layout -title: Android CameraDLSLicenseVerificationListener - Dynamsoft Camera Enhancer -description: This is the documentation - CameraDLSLicenseVerificationListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, CameraDLSLicenseVerificationListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: CameraDLSLicenseVerificationListener -permalink: /programming/android/auxiliary-api/interface-licenselistener-v1.0.3.html ---- - -# CameraDLSLicenseVerificationListener - -The interface to handle callback when license verification messages are returned. - -```java -interface com.dynamsoft.dce.CameraDLSLicenseVerificationListener -``` - -| Method | Description | -| ------ | ----------- | -| `DLSLicenseVerificationCallback` | The call back of the license server. | - -## DLSLicenseVerificationCallback - -The call back of the license server. Add the code in the callback function to react when the license server connection is successful or failed. - -```java -void DLSLicenseVerificationCallback(boolean isSuccess, Exception error); -``` - -**Parameters** - -`isSuccess`: Whether the license verification was successful. -`error`: The error message from the license server. - -**Code Snippet** - -```java -cameraEnhancer.initLicenseFromDLS(dceParameters, new CameraDLSLicenseVerificationListener() { - @Override - public void DLSLicenseVerificationCallback(boolean isSuccess, Exception e) { - if (!isSuccess) { - e.printStackTrace(); - } - } -}); -``` diff --git a/programming-old/android/auxiliary-api/interface-licenselistener-v2.3.11.md b/programming-old/android/auxiliary-api/interface-licenselistener-v2.3.11.md deleted file mode 100644 index fa2231ec..00000000 --- a/programming-old/android/auxiliary-api/interface-licenselistener-v2.3.11.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default-layout -title: Android DCELicenseVerificationListener - Dynamsoft Camera Enhancer -description: This is the documentation - DCELicenseVerificationListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCELicenseVerificationListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCELicenseVerificationListener -permalink: /programming/android/auxiliary-api/interface-licenselistener-v2.3.11.html ---- - -# DCELicenseVerificationListener - -The interface to handle callback when license verification messages are returned. - -```java -interface com.dynamsoft.dce.DCELicenseVerificationListener -``` - -| Method | Description | -| ------ | ----------- | -| `DCELicenseVerificationCallback` | The call back of the license server. | - -  - -## DCELicenseVerificationCallback - -The call back of the license server. Add the code in the callback function to react when the license server connection is successful or failed. - -```java -void DCELicenseVerificationCallback(boolean isSuccess, Exception error); -``` - -**Parameters** - -`isSuccess`: Whether the license verification was successful. -`error`: The error message from the license server. - -**Code Snippet** - -```java -CameraEnhancer.initLicense("Put your license here", new DCELicenseVerificationListener() { - @Override - public void DCELicenseVerificationCallback(boolean isSuccess, Exception e) { - if (!isSuccess) { - e.printStackTrace(); - } - } -}); -``` diff --git a/programming-old/android/auxiliary-api/interface-licenselistener-v2.3.12.md b/programming-old/android/auxiliary-api/interface-licenselistener-v2.3.12.md deleted file mode 100644 index 958b6bd0..00000000 --- a/programming-old/android/auxiliary-api/interface-licenselistener-v2.3.12.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default-layout -title: Android DCELicenseVerificationListener - Dynamsoft Camera Enhancer -description: This is the documentation - DCELicenseVerificationListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCELicenseVerificationListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCELicenseVerificationListener -permalink: /programming/android/auxiliary-api/interface-licenselistener-v2.3.12.html ---- - -# DCELicenseVerificationListener - -The interface to handle callback when license verification messages are returned. - -```java -interface com.dynamsoft.dce.DCELicenseVerificationListener -``` - -| Method | Description | -| ------ | ----------- | -| `DCELicenseVerificationCallback` | The call back of the license server. | - -  - -## DCELicenseVerificationCallback - -The call back of the license server. Add the code in the callback function to react when the license server connection is successful or failed. - -```java -void DCELicenseVerificationCallback(boolean isSuccess, Exception error); -``` - -**Parameters** - -`isSuccess`: Whether the license verification was successful. -`error`: The error message from the license server. - -**Code Snippet** - -```java -CameraEnhancer.initLicense("Put your license here", new DCELicenseVerificationListener() { - @Override - public void DCELicenseVerificationCallback(boolean isSuccess, Exception e) { - if (!isSuccess) { - e.printStackTrace(); - } - } -}); -``` diff --git a/programming-old/android/auxiliary-api/interface-licenselistener-v3.0.3.md b/programming-old/android/auxiliary-api/interface-licenselistener-v3.0.3.md deleted file mode 100644 index a1616203..00000000 --- a/programming-old/android/auxiliary-api/interface-licenselistener-v3.0.3.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default-layout -title: Android DCELicenseVerificationListener - Dynamsoft Camera Enhancer -description: This is the documentation - DCELicenseVerificationListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, DCELicenseVerificationListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: DCELicenseVerificationListener -permalink: /programming/android/auxiliary-api/interface-licenselistener-v3.0.3.html ---- - -# DCELicenseVerificationListener - -The interface to handle callback when license verification messages are returned. - -```java -interface com.dynamsoft.dce.DCELicenseVerificationListener -``` - -| Method | Description | -| ------ | ----------- | -| `DCELicenseVerificationCallback` | The call back of the license server. | - -  - -## DCELicenseVerificationCallback - -The call back of the license server. Add the code in the callback function to react when the license server connection is successful or failed. - -```java -void DCELicenseVerificationCallback(boolean isSuccess, Exception error); -``` - -**Parameters** - -`isSuccess`: Whether the license verification was successful. -`error`: The error message from the license server. - -**Code Snippet** - -```java -CameraEnhancer.initLicense("Put your license here", new DCELicenseVerificationListener() { - @Override - public void DCELicenseVerificationCallback(boolean isSuccess, Exception e) { - if (!isSuccess) { - e.printStackTrace(); - } - } -}); -``` diff --git a/programming-old/android/auxiliary-api/interface-licenselistener.md b/programming-old/android/auxiliary-api/interface-licenselistener.md deleted file mode 100644 index ae46a1a6..00000000 --- a/programming-old/android/auxiliary-api/interface-licenselistener.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: LicenseVerificationListener - Dynamsoft Camera Enhancer Android Edition API Reference -description: The interface LicenseVerificationListener of Dynamsoft Camera Enhancer includes methods for monitoring the license verification status. -keywords: license verification, Java, Kotlin -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# LicenseVerificationListener - -The `LicenseVerificationListener` is a interface that includes methods for monitoring the license verification status. - -## Definition - -*Namespace:* com.dynamsoft.license - -*Assembly:* DynamsoftLicense.aar - -```java -interface LicenseVerificationListener -``` - -| Method | Description | -| ------ | ----------- | -| [`onLicenseVerified`](#onlicenseverified) | The method that is triggered when the license server returns the verification info. | - -### onLicenseVerified - -The method that is triggered when the license server returns the verification info. - -```java -void onLicenseVerified(boolean isSuccess, Exception error); -``` - -**Parameters** - -`[in] isSuccess`: A Boolean value indicating whether the license is verified successfully. - -`[in] error`: An exception object. It carries the error code and message that describe the reason why your license activation failed. diff --git a/programming-old/android/auxiliary-api/interface-torchlistener.md b/programming-old/android/auxiliary-api/interface-torchlistener.md deleted file mode 100644 index af467c5b..00000000 --- a/programming-old/android/auxiliary-api/interface-torchlistener.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default-layout -title: Android TorchListener - Dynamsoft Camera Enhancer -description: This is the documentation - TorchListener page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, TorchListener -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: TorchListener -permalink: /programming/android/auxiliary-api/interface-torchlistener.html ---- - -# TorchListener - -The interface to handle callback when torch state callback is returned. - -```java -interface com.dynamsoft.dce.TorchListener -``` - -| Methods | Description | -| --------- | ----------- | -| [`onTorchStateChanged`](#onTorchStateChanged) | The method for user to add code when torch state is changed. | - -## onTorchStateChanged - -The method for user to add code when torch state is changed. - -```java -void onTorchStateChanged(TorchState state); -``` - -**Parameters** - -`state`: The torch status value. One of the parameters in [`TorchState`]({{site.parameter-reference}}index.html#torchstate) - -**Code Snippet** - -```java -cameraEnhancer.addTorchListener(new TorchListener() { - @Override - public void onTorchStateChanged(TorchState torchState) { - // Add your code - } -}); -``` diff --git a/programming-old/android/auxiliary-api/region-definition-v2.3.11.md b/programming-old/android/auxiliary-api/region-definition-v2.3.11.md deleted file mode 100644 index 3c6d92bd..00000000 --- a/programming-old/android/auxiliary-api/region-definition-v2.3.11.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -layout: default-layout -title: Android RegionDefinition Class - Dynamsoft Camera Enhancer Documents -description: This page shows the RegionDefinition Class of Dynamsoft Camera Enhancer for Android SDK. -keywords: RegionDefinition, class, api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/auxiliary-api/region-definition-v2.3.11.html ---- - -# RegionDefinition - -Stores the region information. - -```java -class com.dynamsoft.core.RegionDefinition; -``` - -| Attribute | Type | Descriptions | -|---------- | ---- | ------------ | -| [`regionTop`](#regiontop) | *int* | The top-most coordinate or percentage of the region. | -| [`regionLeft`](#regionleft) | *int* | The left-most coordinate or percentage of the region. | -| [`regionRight`](#regionright) | *int* | The right-most coordinate or percentage of the region. | -| [`regionBottom`](#regionbottom) | *int* | The bottom-most coordinate or percentage of the region. | -| [`regionMeasuredByPercentage`](#regionmeasuredbypercentage) | *int* | Sets whether or not to use percentage to measure the region size. | - -## regionTop - -The top-most coordinate or percentage of the region. - -```java -int regionTop -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionLeft - -The left-most coordinate or percentage of the region. - -```java -int regionLeft -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionRight - -The right-most coordinate or percentage of the region. - -```java -int regionRight -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionBottom - -The bottom-most coordinate or percentage of the region. - -```java -int regionBottom -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionMeasuredByPercentage - -Sets whether or not to use percentage to measure the region size. - -```java -int regionMeasuredByPercentage -``` - -**Value Range** - -[0, 1] - -**Default Value** - -0 - -**Remarks** - -When it's set to 1, the values of Top, Left, Right, Bottom indicate percentage (from 0 to 100); Otherwise, they indicate coordinates. 0: not by percentage 1: by percentage. diff --git a/programming-old/android/auxiliary-api/region-definition-v2.3.12.md b/programming-old/android/auxiliary-api/region-definition-v2.3.12.md deleted file mode 100644 index 977de7eb..00000000 --- a/programming-old/android/auxiliary-api/region-definition-v2.3.12.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -layout: default-layout -title: Android RegionDefinition Class - Dynamsoft Camera Enhancer Documents -description: This page shows the RegionDefinition Class of Dynamsoft Camera Enhancer for Android SDK. -keywords: RegionDefinition, class, api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/auxiliary-api/region-definition-v2.3.12.html ---- - -# RegionDefinition - -Stores the region information. - -```java -class com.dynamsoft.core.RegionDefinition; -``` - -| Attribute | Type | Descriptions | -|---------- | ---- | ------------ | -| [`regionTop`](#regiontop) | *int* | The top-most coordinate or percentage of the region. | -| [`regionLeft`](#regionleft) | *int* | The left-most coordinate or percentage of the region. | -| [`regionRight`](#regionright) | *int* | The right-most coordinate or percentage of the region. | -| [`regionBottom`](#regionbottom) | *int* | The bottom-most coordinate or percentage of the region. | -| [`regionMeasuredByPercentage`](#regionmeasuredbypercentage) | *int* | Sets whether or not to use percentage to measure the region size. | - -## regionTop - -The top-most coordinate or percentage of the region. - -```java -int regionTop -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionLeft - -The left-most coordinate or percentage of the region. - -```java -int regionLeft -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionRight - -The right-most coordinate or percentage of the region. - -```java -int regionRight -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionBottom - -The bottom-most coordinate or percentage of the region. - -```java -int regionBottom -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionMeasuredByPercentage - -Sets whether or not to use percentage to measure the region size. - -```java -int regionMeasuredByPercentage -``` - -**Value Range** - -[0, 1] - -**Default Value** - -0 - -**Remarks** - -When it's set to 1, the values of Top, Left, Right, Bottom indicate percentage (from 0 to 100); Otherwise, they indicate coordinates. 0: not by percentage 1: by percentage. diff --git a/programming-old/android/auxiliary-api/region-definition-v3.0.3.md b/programming-old/android/auxiliary-api/region-definition-v3.0.3.md deleted file mode 100644 index e62c6f25..00000000 --- a/programming-old/android/auxiliary-api/region-definition-v3.0.3.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -layout: default-layout -title: Android RegionDefinition Class - Dynamsoft Camera Enhancer Documents -description: This page shows the RegionDefinition Class of Dynamsoft Camera Enhancer for Android SDK. -keywords: RegionDefinition, class, api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/auxiliary-api/region-definition-v3.0.3.html ---- - -# RegionDefinition - -Stores the region information. - -```java -class com.dynamsoft.core.RegionDefinition; -``` - -| Attribute | Type | Descriptions | -|---------- | ---- | ------------ | -| [`regionTop`](#regiontop) | *int* | The top-most coordinate or percentage of the region. | -| [`regionLeft`](#regionleft) | *int* | The left-most coordinate or percentage of the region. | -| [`regionRight`](#regionright) | *int* | The right-most coordinate or percentage of the region. | -| [`regionBottom`](#regionbottom) | *int* | The bottom-most coordinate or percentage of the region. | -| [`regionMeasuredByPercentage`](#regionmeasuredbypercentage) | *int* | Sets whether or not to use percentage to measure the region size. | - -## regionTop - -The top-most coordinate or percentage of the region. - -```java -int regionTop -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionLeft - -The left-most coordinate or percentage of the region. - -```java -int regionLeft -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionRight - -The right-most coordinate or percentage of the region. - -```java -int regionRight -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionBottom - -The bottom-most coordinate or percentage of the region. - -```java -int regionBottom -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionMeasuredByPercentage - -Sets whether or not to use percentage to measure the region size. - -```java -int regionMeasuredByPercentage -``` - -**Value Range** - -[0, 1] - -**Default Value** - -0 - -**Remarks** - -When it's set to 1, the values of Top, Left, Right, Bottom indicate percentage (from 0 to 100); Otherwise, they indicate coordinates. 0: not by percentage 1: by percentage. diff --git a/programming-old/android/auxiliary-api/region-definition.md b/programming-old/android/auxiliary-api/region-definition.md deleted file mode 100644 index 65fddae5..00000000 --- a/programming-old/android/auxiliary-api/region-definition.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -layout: default-layout -title: Android RegionDefinition Class - Dynamsoft Camera Enhancer Android API Reference -description: This page shows the RegionDefinition Class of Dynamsoft Camera Enhancer for Android SDK. -keywords: RegionDefinition, class, api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/auxiliary-api/region-definition.html ---- - -# RegionDefinition - -Stores the region information. - -```java -class com.dynamsoft.dce.RegionDefinition; -``` - -| Attribute | Type | Descriptions | -|---------- | ---- | ------------ | -| [`regionTop`](#regiontop) | *int* | The top-most coordinate or percentage of the region. | -| [`regionLeft`](#regionleft) | *int* | The left-most coordinate or percentage of the region. | -| [`regionRight`](#regionright) | *int* | The right-most coordinate or percentage of the region. | -| [`regionBottom`](#regionbottom) | *int* | The bottom-most coordinate or percentage of the region. | -| [`regionMeasuredByPercentage`](#regionmeasuredbypercentage) | *int* | Sets whether or not to use percentage to measure the region size. | - -## regionTop - -The top-most coordinate or percentage of the region. - -```java -int regionTop -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionLeft - -The left-most coordinate or percentage of the region. - -```java -int regionLeft -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionRight - -The right-most coordinate or percentage of the region. - -```java -int regionRight -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionBottom - -The bottom-most coordinate or percentage of the region. - -```java -int regionBottom -``` - -**Value Range** - -regionMeasuredByPercentage = 0: [0, 0x7fffffff] -regionMeasuredByPercentage = 1: [0, 100] - -**Default Value** - -0 - -  - -## regionMeasuredByPercentage - -Sets whether or not to use percentage to measure the region size. - -```java -int regionMeasuredByPercentage -``` - -**Value Range** - -[0, 1] - -**Default Value** - -0 - -**Remarks** - -When it's set to 1, the values of Top, Left, Right, Bottom indicate percentage (from 0 to 100); Otherwise, they indicate coordinates. 0: not by percentage 1: by percentage. diff --git a/programming-old/android/guide/basic-settings.md b/programming-old/android/guide/basic-settings.md deleted file mode 100644 index eefa2105..00000000 --- a/programming-old/android/guide/basic-settings.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -layout: default-layout -title: Customize Camera Settings on Android - Dynamsoft Camera Enhancer -description: This is the documentation - Customize Camera Settings on Android. -keywords: Camera Enhancer, Customize Camera Settings -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: Customize Camera Settings -permalink: /programming/android/guide/basic-settings.html ---- - -# Customize the Basic Settings - -There are three classes available in Dynamsoft Camera Enhancer SDK. - -| Class | Description | -| ----- | ----------- | -| `CameraEnhancer` | The class includes basic hardware control and video streaming control APIs. | -| `DCECameraView` | The class includes UI | -| `DCEFrame` | | - -## Camera Control - -### Basic Camera Settings - -When using Dynamsoft Camera Enhancer (DCE), the first back-forward camera is selected as the default camera. You can switch the cameras and control the status of the cameras via camera control APIs that are available in `CameraEnhancer` class. - -Use the following methods to switch cameras: - -- `getAllCameras` -- `selectCamera` -- `getSelectCamera` - -Use the following methods to control the camera status: - -- `open`/`close`/`pause`/`resume` - -### Additional Camera Settings - -Specifying the scan region will help you improve processing efficiency. You can specify the scan region and display it on the UI via the following methods: - -- `setScanRegion` -- `setScanRegionVisible` - -The resolution, focus, zoom factor and torchlight settings are also available when using DCE. - -- `setResolution`/`getResolution` -- `setZoom` -- `setFocus` -- `turnOnTorch`/`turnOffTorch` - -**Sample Code** - -```java -``` - -## UI Configurations - -Common UI elements are preset in DCECameraView classes. These UI elements facilitate you when working with Dynamsoft products. - -### Add Highlighted Overlays - -If DCE is bound with Dynamsoft Barcode Reader, highlight **overlays** can be created automatically on the decoded barcode results based on the localization areas. You can configure the **overlay** settings via the following methods. - -- `setOverlayVisible` -- `setOverlayColour` - -### Torch Button - -You can simply control the torchlight via the methods `turnOnTorch`/`turnOffTorch` or enable an interactive torch light control via the **torchButton** UI element. Methods are available for users to set the position, size, image and visibility of the **torchButton**. Once the **torchButton** is displayed on the UI, users can click on the **torchButton** to switch on/off the torchlight. - -- `setTorchButton` -- `setTorchButtonVisible` diff --git a/programming-old/android/guide/features-v3.0.3.md b/programming-old/android/guide/features-v3.0.3.md deleted file mode 100644 index 16221a20..00000000 --- a/programming-old/android/guide/features-v3.0.3.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -layout: default-layout -title: Advanced Features on Android - Dynamsoft Camera Enhancer -description: This is the documentation - Enable Advanced Features on Android. -keywords: Camera Enhancer, Advanced Features on Android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -breadcrumbText: Advanced Features -permalink: /programming/android/guide/features-v3.0.3.html ---- - -# Advanced Features - -On this page, you will read about how to use advanced features of Dynamsoft Camera Enhancer and how they help you on obtaining higher quality video streaming. A valid license is required when using the advanced features. - -## Advanced Features Summary - -All the advanced feaatures are defined in enumeration `EnumEnhancerFeatures`. Currently, they are available as follow: - -| Feature | Enumeration Member | Value | -| ------- | ------ | ----- | -| [Frame Filter](#frame-filter) | `EnumFRAME_FILTER` | 0x01 | -| [Sensor Control](#sensor-control) | `EnumSENSOR_CONTROL` | 0x02 | -| [Enhanced Focus](#enhanced-focus) | `EnumENHANCED_FOCUS` | 0x04 | -| [Fast Mode](#fast-mode) | `EnumFAST_MODE` | 0x08 | -| [Auto Zoom](#auto-zoom) | `EnumAUTO_ZOOM` | 0x10 | -| [Smart Torch](#smart-torch) | `EnumSMART_TORCH` | 0x20 | - -## How to Use - -- Enable: Trigger method `enableFeatures` with the enumeration members of the features that you want to enable. -- Disable: Trigger method `disableFeatures` with the enumeration members of the features that you want to disable. - -Sample code: - -```java -// To enable features -mCameraEnhancer.enableFeatures(EnumEnhancerFeatures.EF_FRAME_FILTER | EnumEnhancerFeatures.EF_AUTO_ZOOM); -// To disable features -mCameraEnhancer.disableFeatures(EnumEnhancerFeatures.EF_FRAME_FILTER | EnumEnhancerFeatures.EF_AUTO_ZOOM); -``` - -- You can enable or disable multiple features at one time. -- When an enabled feature is enabled again, it remains enabled. -- When a feature is disabled more than once, it remains disabled. - -## Advanced Features Details - -### Frame Filter - -All the frames in the video streaming are quickly evaluated and the majority of the blurry frames will be filtered out. You can enable this feature when your mobile device is always moving. The average time consumption on evaluating each video frame is less than 10ms. - -### Sensor Control - -The mobile sensor can help on filtering out all the frames that are produced when the device is shaking. It will get better effects when enabled together with **Frame Filter**. - -### Enhanced Focus - -This feature can assist the camera in its focus. It is recommended to be enabled on low-end devices. - -### Fast Mode - -The video frames are cropped into small sizes when the **Fast Mode** is enabled. The feature will sharply improve the processing efficiency When the targeting areas are always located in the middle of the video. The average time consumption on cropping each frame is less than 10ms. - -### Auto Zoom - -**Auto Zoom** feature is specially designed for decoding barcodes from long distances. The camera will zoom in automatically to enlarge the region of interest when a barcode is detected far away. The **Auto Zoom** feature might not work ideally when processing the documents or the text areas. Please disable this feature if the targets are not barcodes. - -### Smart Torch - -**Smart Torch** feature controls the visibility of the torch button created by `setTorchButton` method. The torch button will be displayed automatically when the environment light level is low. Otherwise, the torch button is hidden. The feature doesn't control the status of the mobile torch. Users have to click on the torch button to turn on the torch. diff --git a/programming-old/android/guide/guide-v1.0.1.md b/programming-old/android/guide/guide-v1.0.1.md deleted file mode 100644 index b9b3d594..00000000 --- a/programming-old/android/guide/guide-v1.0.1.md +++ /dev/null @@ -1,498 +0,0 @@ ---- -layout: default-layout -title: Guide on Android - Dynamsoft Camera Enhancer -description: This is the documentation - Guide on Android page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Guide on Android -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: Android Guide -permalink: /programming/android/guide/guide-v1.0.1.html ---- - -# 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 - -1. Download Dynamsoft Camera Enhancer to get `dce-android-{version-number}.zip`. Unzip the package to find `DynamsoftCameraEnhancerAndroid.aar`. - -2. Create a new Android project in Android Studio. - -3. Put the `.aar` file under the dictionary `/app/libs` in your project. - -4. Add the following code into `build.gradle(Module: app)`. - - ```groovy - repositories { - flatDir { - dirs 'libs' - } - } - ``` - -5. Also in `build.gradle(Module: app)` add the reference in dependencies: - - ```groovy - implementation(name: 'DynamsoftCameraEnhancerAndroid', ext: 'aar') - ``` - -6. 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. - -1. Keep working on the project that you have installed DCE. In the project, create a CameraView section in activity_main.xml. - - ```xml - - ``` - -2. 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: - - ```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: - - ```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() - } - } - ``` - -3. 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: - -```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: - -```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. - -1. 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)`. - - ```groovy - implementation(name: 'DynamsoftCameraEnhancerAndroid', ext: 'aar') - ``` - -2. Add a new text view for the camera module. In the text view, there will be decode results if the project is running successfully. - - ```xml - - - - - ``` - -3. Add the following code to the project in the main activity: - - Java: - - ```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: - - ```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?) { - if (results != null && results.size > 0) { - var strRes = "" - for (i in results.indices) strRes += """ - ${results[i].barcodeText} - - - """.trimIndent() - tvRes!!.text = strRes - } - } - } - ``` - -4. Run the project, now a simple decode app has been built via Dynamsoft Camera Enhancer and Dynamsoft Barcode Reader. diff --git a/programming-old/android/guide/guide-v1.0.3.md b/programming-old/android/guide/guide-v1.0.3.md deleted file mode 100644 index c70391e2..00000000 --- a/programming-old/android/guide/guide-v1.0.3.md +++ /dev/null @@ -1,499 +0,0 @@ ---- -layout: default-layout -title: Guide on Android - Dynamsoft Camera Enhancer -description: This is the documentation - Guide on Android page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Guide on Android -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: Android Guide -permalink: /programming/android/guide/guide-v1.0.3.html ---- - -# 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 - -1. Download Dynamsoft Camera Enhancer to get `dce-android-{version-number}.zip`. Unzip the package to find `DynamsoftCameraEnhancerAndroid.aar`. - -2. Create a new Android project in Android Studio. - -3. Put the `.aar` file under the dictionary `/app/libs` in your project. - -4. Add the following code into `build.gradle(Module: app)`. - - ```groovy - repositories { - flatDir { - dirs 'libs' - } - } - ``` - -5. Also in `build.gradle(Module: app)` add the reference in dependencies: - - ```groovy - implementation(name: 'DynamsoftCameraEnhancerAndroid', ext: 'aar') - ``` - -6. 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. - -1. Keep working on the project that you have installed DCE. In the project, create a CameraView section in activity_main.xml. - - ```xml - - ``` - -2. 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: - - ```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.DMDLSConnectionParameters info = new com.dynamsoft.dce.DMDLSConnectionParameters(); - info.organizationID = "Put your organizationID here."; - mCameraEnhancer.initLicenseFromDLS(info,new CameraDLSLicenseVerificationListener() { - @Override - public void DLSLicenseVerificationCallback(boolean isSuccess, Exception error) { - if(!isSuccess){ - error.printStackTrace(); - } - } - }); - //Turn on the camera - mCameraEnhancer.setCameraDesiredState(CameraState.CAMERA_STATE_ON); - //Start scanning - mCameraEnhancer.startScanning(); - } - } - ``` - - Kotlin: - - ```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 Dynamsoft License Server - val info = com.dynamsoft.dce.DMDLSConnectionParameters() - info.organizationID = "Put your organizationID here." - mCameraEnhancer!!.initLicenseFromDLS(info) { isSuccess, error -> - if (!isSuccess) { - error.printStackTrace() - } - } - mCameraEnhancer!!.setCameraDesiredState(CameraState.CAMERA_STATE_ON) - mCameraEnhancer!!.startScanning() - } - } - ``` - -3. 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: - -```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.DMDLSConnectionParameters info = new com.dynamsoft.dce.DMDLSConnectionParameters(); - info.organizationID = "Put your organizationID here."; - mCameraEnhancer.initLicenseFromDLS(info,new CameraDLSLicenseVerificationListener() { - @Override - public void DLSLicenseVerificationCallback(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: - -```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 Dynamsoft License Server - val info = com.dynamsoft.dce.DMDLSConnectionParameters() - info.organizationID = "Put your organizationID here." - mCameraEnhancer!!.initLicenseFromDLS(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. - -1. 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)`. - - ```groovy - implementation(name: 'DynamsoftCameraEnhancerAndroid', ext: 'aar') - ``` - -2. Add a new text view for the camera module. In the text view, there will be decode results if the project is running successfully. - - ```xml - - - - - ``` - -3. Add the following code to the project in the main activity: - - Java: - - ```java - import com.dynamsoft.dbr.BarcodeReader; - import com.dynamsoft.dbr.BarcodeReaderException; - import com.dynamsoft.dbr.DBRDLSLicenseVerificationListener; - import com.dynamsoft.dbr.DCESettingParameters; - import com.dynamsoft.dbr.TextResultCallback; - import com.dynamsoft.dbr.TextResult; - import com.dynamsoft.dce.CameraEnhancer; - import com.dynamsoft.dce.CameraDLSLicenseVerificationListener; - 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 Dynamsoft License Server - com.dynamsoft.dce.DMDLSConnectionParameters info = new com.dynamsoft.dce.DMDLSConnectionParameters(); - info.organizationID = "Put your organizationID here."; - mCameraEnhancer.initLicenseFromDLS(info,new CameraDLSLicenseVerificationListener() { - @Override - public void DLSLicenseVerificationCallback(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 Dynamsoft License Server - try { - reader = new BarcodeReader(); - com.dynamsoft.dbr.DMDLSConnectionParameters parameters = new com.dynamsoft.dbr.DMDLSConnectionParameters(); - parameters.organizationID = "Put your organizationID here."; - reader.initLicenseFromDLS(parameters, new DBRDLSLicenseVerificationListener() { - @Override - public void DLSLicenseVerificationCallback(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: - - ```kotlin - import com.dynamsoft.dbr.BarcodeReader - import com.dynamsoft.dbr.BarcodeReaderException - import com.dynamsoft.dbr.DBRDLSLicenseVerificationListener - import com.dynamsoft.dbr.DCESettingParameters - import com.dynamsoft.dbr.TextResultCallback - import com.dynamsoft.dbr.TextResult - import com.dynamsoft.dce.CameraEnhancer - import com.dynamsoft.dce.CameraDLSLicenseVerificationListener - import com.dynamsoft.dce.CameraView - - 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 Dynamsoft License Server - val info = com.dynamsoft.dce.DMDLSConnectionParameters() - info.organizationID = "Put your organizationID here." - mCameraEnhancer!!.initLicenseFromDLS(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 Dynamsoft License Server - try { - reader = BarcodeReader() - val parameters = DMDLSConnectionParameters() - parameters.organizationID = "Put your organizationID here." - reader!!.initLicenseFromDLS(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?) { - if (results != null && results.size > 0) { - var strRes = "" - for (i in results.indices) strRes += """ - ${results[i].barcodeText} - - - """.trimIndent() - tvRes!!.text = strRes - } - } - } - ``` - -4. Run the project, now a simple decode app has been built via Dynamsoft Camera Enhancer and Dynamsoft Barcode Reader. diff --git a/programming-old/android/guide/guide-v2.3.10.md b/programming-old/android/guide/guide-v2.3.10.md deleted file mode 100644 index efbf69dd..00000000 --- a/programming-old/android/guide/guide-v2.3.10.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -layout: default-layout -title: Guide on Android - Dynamsoft Camera Enhancer -description: This is the documentation - Guide on Android page of Dynamsoft Camera Enhancer. -keywords: Camera Enhancer, Guide on Android -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: true -breadcrumbText: Android Guide -permalink: /programming/android/guide/guide-v2.3.10.html ---- - -# Dynamsoft Camera Enhancer User Guide for Android (Java) - -The Dynamsoft Camera Enhancer Android SDK enables you to easily control cameras from your Android applications to stream live video and acquire realtime frames. - -> **Example Usage** -> -> See how Dynamsoft Camera Enhancer helps in camera control and video recognition: -> - **Barcode scanning from video stream**: check [Dynamsoft Barcode Reader Android User Guide](https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/android/user-guide.html?ver=latest) - -Step-by-step guide on how to integrate Dynamsoft Camera Enhancer SDK to your Android app: - -## App prerequisites - -- System Requirements: - - Supported OS: Android 5 or higher (Android 7 or higher recommended). - - Supported ABI: arm64-v8a/armeabi-v7a/x86/x86_64. - -- Environment: Android Studio 3.4+. - -## Installation - -If you don't have SDK yet, please download the Dynamsoft Camera Enhancer(DCE) SDK from the Dynamsoft website and unzip the package. After decompression, the root directory of the DCE installation package is `DynamsoftCameraEnhancer`, which is represented by `[INSTALLATION FOLDER]`. - -## Build Your First Application - -The following sample will demonstrate how to acquire a frame from video streaming by DCE. ->Note: ->- The following steps are completed in Android Studio 4.2. ->- You can download the similar complete source code from [Here](https://github.com/Dynamsoft/camera-enhancer-mobile-samples/tree/main/android/HelloWorld). ->- For more samples on using Dynamsoft Camera Enhancer supporting Barcode Reader please [click here](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/). - -### Create a New Project - -1. Open Android Studio and select New Project… in the File > New > New Project… menu to create a new project. - -2. Choose the correct template for your project. In this sample, we'll use `Empty Activity`. - -3. When prompted, choose your app name (`HelloWorld`) and set the Save location, Language, and Minimum SDK (21) - >Note: With minSdkVersion set to 21, your app is available on more than 94.1% of devices on the Google Play Store (last update: March 2021). - -### Include the library - -There are two ways to include the Dynamsoft Camera Enhancer SDK into your project: - -#### Local Binary Dependency - -1. Copy the file `[INSTALLATION FOLDER]\Lib\DynamsoftCameraEnhancerAndroid.aar` to the target directory `HelloWorld\app\libs` - -2. Open the file `HelloWorld\app\build.gradle`, and add reference in the dependencies: - ``` - dependencies { - implementation fileTree(dir: 'libs', include: ['*.aar']) - } - ``` - -3. Click `Sync Now`. After the synchronization completes, the SDK is added to the project. - -4. import the package int the file `MainActivity.java` - ```java - import com.dynamsoft.dce.*; - ``` - -#### Remote Binary Dependency - -1. Open the file `HelloWorld\app\build.gradle`, and add the remote repository: - ``` - repositories { - maven { - url "https://download2.dynamsoft.com/maven/aar" - } - } - ``` - -2. Add reference in the dependencies: - ``` - dependencies { - implementation 'com.dynamsoft:dynamsoftcameraenhancer:2.3.10@aar' - } - ``` - >Note:Please replace {version-number} with the correct version number. - -3. Click `Sync Now`. After the synchronization completes, the SDK is added to the project. - -4. import the package in the file `MainActivity.java` - ```java - import com.dynamsoft.dce.*; - ``` - -### License Activation (Optional) - -A valid license is required when using the following features: - -- Frame Sharpness Filter -- Sensor Filter -- Auto Zoom -- Enhanced Focus -- Fast Mode -- Smart torch - -The above features are enabled by triggering method [`enableFeatures`](../primary-api/camera-enhancer.html#enablefeatures). If you are not using these features, you can skip the license activation step. - -Use the following code to activate the license: - -```java -CameraEnhancer.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", new DCELicenseVerificationListener() { - @Override - public void DCELicenseVerificationCallback(boolean isSuccess, Exception error) { - if(!isSuccess){ - error.printStackTrace(); - } - } -}); -``` - ->Note: ->- Network connection is required for the license to work. ->- "DLS2***" is a time-limited public trial license used in the sample. ->- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=cvs&utm_source=guide&package=android){:target="_blank"} link. Offline trial license is also available by [contacting us](https://www.dynamsoft.com/contact/){:target="_blank"}. - -### Initialize Dynamsoft Camera Enhancer - -Create an instance of Dynamsoft Camera Enhancer - -```java -CameraEnhancer mCameraEnhancer; -mCameraEnhancer = new CameraEnhancer(MainActivity.this); -``` - -### Create Camera View And Control Camera - -1. In the Project window, open app > res > layout > `activity_main.xml`, create a DCE camera view section under the root node. - - ```xml - - ``` - -2. Initialize the camera view, and bind to the Camera Enhancer object. - - ```java - DCECameraView mCameraView; - - mCameraView = findViewById(R.id.cameraView); - mCameraEnhancer.setCameraView(mCameraView); - ``` - -3. Override the MainActivity.onResume and MainActivity.onPause function to open and close camera. - - ```java - @Override - protected void onResume() { - super.onResume(); - needCapture = false; - try { - mCameraEnhancer.open(); - } catch (CameraEnhancerException e) { - e.printStackTrace(); - } - } - - @Override - protected void onPause() { - super.onPause(); - try { - mCameraEnhancer.close(); - } catch (CameraEnhancerException e) { - e.printStackTrace(); - } - } - ``` - -### Capture Frame - -1. In the Project window, open app > res > layout > `activity_main.xml`, and add a `Button` to capture frame. - ```xml -