From 283e314fa520a0fa624e5e1cc09f1de6d60117ee Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Fri, 23 Aug 2024 01:09:55 -0700 Subject: [PATCH 1/2] update to internal commit 41eebf5f --- _includes/ddnNav.html | 36 +++++-------------- ...lt-layout.html => default-layout-OLD.html} | 0 ...{search-page.html => search-page-OLD.html} | 0 search.md | 1 + 4 files changed, 9 insertions(+), 28 deletions(-) rename _layouts/{default-layout.html => default-layout-OLD.html} (100%) rename _layouts/{search-page.html => search-page-OLD.html} (100%) diff --git a/_includes/ddnNav.html b/_includes/ddnNav.html index c85d4d2..343d77b 100644 --- a/_includes/ddnNav.html +++ b/_includes/ddnNav.html @@ -1,14 +1,13 @@ @@ -18,24 +17,13 @@
-
- - Get Pricing -
+ Get Pricing + Download 30-Day Trial
@@ -52,15 +40,7 @@
    - - - -
  • +
  • Documentation
  • 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/search.md b/search.md index 1a49355..8b06a39 100644 --- a/search.md +++ b/search.md @@ -2,4 +2,5 @@ layout: search-page title: Dynamsoft Document Normalizer Documentation Search keywords: Dynamsoft Document Normalizer Documentation Search +cx: 90b37820e9a5e454e --- \ No newline at end of file From 8faf2ecc2b369332a77d263904ad00ea31a9ca9b Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Fri, 11 Oct 2024 15:28:04 +0800 Subject: [PATCH 2/2] update to internal commit 273b80ab --- _config.yml | 3 +- _data/full_tree.yml | 9 - _data/product_version.yml | 42 -- .../release-notes/product-highlight-1.0.0.md | 15 - .../release-notes/product-highlight-2.0.0.md | 16 - _includes/sidelist-full-tree.html | 12 - .../programming-android-v1.0.30.html | 52 -- .../programming-android-v2.0.20.html | 216 ------ .../programming-android.html | 219 ------ .../programming-ios-v1.0.30.html | 51 -- .../programming-ios-v2.0.20.html | 212 ------ .../sidelist-programming/programming-ios.html | 215 ------ .../programming-xamarin.html | 58 -- _layouts/default-layout-OLD.html | 109 --- _layouts/home-page.html | 50 -- _layouts/search-page-OLD.html | 210 ------ assets/js/ddnMobileVersionSearch.json | 438 ----------- .../android/api-reference/auxiliary-index.md | 22 - .../api-reference/detect-result-listener.md | 49 -- .../api-reference/detected-quad-result.md | 41 - .../document-normalizer-exception.md | 41 - .../document-normalizer-general.md | 37 - .../document-normalizer-index-v1.0.0.md | 74 -- .../document-normalizer-index.md | 76 -- .../api-reference/document-normalizer-init.md | 41 - .../document-normalizer-normalizing.md | 297 -------- .../document-normalizer-settings.md | 115 --- .../document-normalizer-video-v1.0.0.md | 145 ---- .../document-normalizer-video.md | 174 ----- .../api-reference/image-data-v1.0.0.md | 96 --- .../android/api-reference/image-data.md | 105 --- .../android/api-reference/index-v1.0.0.md | 97 --- .../android/api-reference/index-v1.0.30.md | 97 --- .../android/api-reference/interface-index.md | 18 - .../android/api-reference/license-manager.md | 55 -- .../license-verification-listener.md | 47 -- .../normalized-image-result-v1.0.0.md | 30 - .../api-reference/normalized-image-result.md | 54 -- .../android/api-reference/quadrilateral.md | 37 - programming-old/android/index-v1.0.30.md | 32 - .../android/release-notes/android-1.md | 56 -- .../android/samples/helloworld-v1.0.30.md | 19 - .../android/samples/index-v1.0.30.md | 34 - programming-old/android/user-guide-v1.0.0.md | 470 ------------ programming-old/android/user-guide-v1.0.30.md | 470 ------------ .../enumerations/error-code-v1.0.0.md | 49 -- programming-old/enumerations/error-code.md | 52 -- .../enumerations/image-pixel-format.md | 38 - .../ios/api-reference/auxiliary-index.md | 21 - .../api-reference/detect-result-listener.md | 66 -- .../ios/api-reference/detected-quad-result.md | 60 -- .../document-normalizer-general.md | 55 -- .../document-normalizer-index-v1.0.0.md | 69 -- .../document-normalizer-index.md | 71 -- .../api-reference/document-normalizer-init.md | 51 -- .../document-normalizer-normalizing.md | 434 ----------- .../document-normalizer-settings.md | 215 ------ .../document-normalizer-video-v1.0.0.md | 183 ----- .../document-normalizer-video.md | 257 ------- .../ios/api-reference/image-data-v1.0.0.md | 160 ---- .../ios/api-reference/image-data.md | 198 ----- .../ios/api-reference/index-v1.0.0.md | 92 --- .../ios/api-reference/index-v1.0.30.md | 92 --- .../ios/api-reference/interface-index.md | 18 - .../ios/api-reference/license-manager.md | 78 -- .../license-verification-listener.md | 73 -- .../normalized-image-result-v1.0.0.md | 48 -- .../api-reference/normalized-image-result.md | 83 -- .../ios/api-reference/quadrilateral.md | 55 -- programming-old/ios/index-v1.0.30.md | 32 - programming-old/ios/release-notes/ios-1.md | 50 -- .../ios/samples/helloworld-v1.0.30.md | 20 - programming-old/ios/samples/index-v1.0.30.md | 33 - programming-old/ios/user-guide-v1.0.30.md | 711 ------------------ .../xamarin/api-reference/camera-enhancer.md | 70 -- .../xamarin/api-reference/camera-view.md | 36 - .../api-reference/detect-result-listener.md | 52 -- .../api-reference/detected-quad-result.md | 43 -- .../api-reference/document-normalizer.md | 464 ------------ .../api-reference/droid-camera-enhancer.md | 35 - .../droid-document-normalizer.md | 45 -- .../api-reference/droid-license-manager.md | 32 - .../api-reference/enum-image-pixel-format.md | 36 - .../xamarin/api-reference/image-data.md | 100 --- .../api-reference/image-editor-view.md | 119 --- .../xamarin/api-reference/index.md | 58 -- .../api-reference/ios-camera-enhancer.md | 34 - .../api-reference/ios-document-normalizer.md | 44 -- .../api-reference/ios-license-manager.md | 31 - .../xamarin/api-reference/license-manager.md | 58 -- .../license-verification-listener.md | 53 -- .../api-reference/normalized-image-result.md | 35 - .../xamarin/api-reference/quadrilateral.md | 53 -- programming-old/xamarin/index.md | 25 - .../xamarin/release-notes/index.md | 18 - .../xamarin/release-notes/xamarin-1.md | 49 -- programming-old/xamarin/user-guide.md | 374 --------- .../candidate-quad-edges-unit-v2.0.20.md | 41 - .../api-reference/corners-unit-v2.0.20.md | 41 - .../detected-quads-unit-v2.0.20.md | 41 - .../android/api-reference/index-v2.0.20.md | 168 ----- programming/android/api-reference/index.md | 68 -- .../api-reference/long-lines-unit-v2.0.20.md | 41 - .../normalized-image-unit-v2.0.20.md | 41 - ...document-normalizer-settings-v2.2.3000.md} | 34 +- ...simplified-document-normalizer-settings.md | 18 + programming/android/index.md | 41 - .../android/release-notes/android-2.md | 140 ---- programming/android/release-notes/index.md | 21 - programming/android/samples/helloworld.md | 24 - programming/android/samples/index.md | 33 - .../android/upgrade-instruction-v2.0.20.md | 131 ---- programming/android/user-guide-v2.0.10.md | 411 ---------- programming/android/user-guide-v2.0.20.md | 414 ---------- ...ide-v2.2.10.md => user-guide-v2.2.3000.md} | 153 ++-- programming/android/user-guide.md | 153 ++-- programming/assets/dcv-ddn-dependency.png | Bin 13064 -> 0 bytes .../candidate-quad-edges-unit-v2.0.20.md | 53 -- .../ios/api-reference/corners-unit-v2.0.20.md | 53 -- .../detected-quad-element-v2.0.20.md | 53 -- .../detected-quads-unit-v2.0.20.md | 53 -- .../ios/api-reference/index-v2.0.20.md | 176 ----- programming/ios/api-reference/index.md | 68 -- .../api-reference/long-lines-unit-2.0.20.md | 53 -- .../normalized-image-element-v2.0.20.md | 53 -- .../normalized-image-unit-v2.0.20.md | 53 -- ...-document-normalizer-settings-v2.2.3000.md | 179 +++++ ...simplified-document-normalizer-settings.md | 36 + programming/ios/index.md | 40 - programming/ios/release-notes/index.md | 21 - programming/ios/release-notes/ios-2.md | 148 ---- programming/ios/samples/helloworld.md | 24 - programming/ios/samples/index.md | 33 - .../ios/upgrade-instruction-v2.2.10.md | 193 ----- programming/ios/user-guide-v2.0.20.md | 575 -------------- programming/ios/user-guide-v2.2.10.md | 587 --------------- ...ide-v2.0.10.md => user-guide-v2.2.3000.md} | 133 ++-- programming/ios/user-guide.md | 131 ++-- 138 files changed, 506 insertions(+), 14207 deletions(-) delete mode 100644 _data/full_tree.yml delete mode 100644 _data/product_version.yml delete mode 100644 _includes/release-notes/product-highlight-1.0.0.md delete mode 100644 _includes/release-notes/product-highlight-2.0.0.md delete mode 100644 _includes/sidelist-full-tree.html delete mode 100644 _includes/sidelist-programming/programming-android-v1.0.30.html delete mode 100644 _includes/sidelist-programming/programming-android-v2.0.20.html delete mode 100644 _includes/sidelist-programming/programming-android.html delete mode 100644 _includes/sidelist-programming/programming-ios-v1.0.30.html delete mode 100644 _includes/sidelist-programming/programming-ios-v2.0.20.html delete mode 100644 _includes/sidelist-programming/programming-ios.html delete mode 100644 _includes/sidelist-programming/programming-xamarin.html delete mode 100644 _layouts/default-layout-OLD.html delete mode 100644 _layouts/home-page.html delete mode 100644 _layouts/search-page-OLD.html delete mode 100644 assets/js/ddnMobileVersionSearch.json delete mode 100644 programming-old/android/api-reference/auxiliary-index.md delete mode 100644 programming-old/android/api-reference/detect-result-listener.md delete mode 100644 programming-old/android/api-reference/detected-quad-result.md delete mode 100644 programming-old/android/api-reference/document-normalizer-exception.md delete mode 100644 programming-old/android/api-reference/document-normalizer-general.md delete mode 100644 programming-old/android/api-reference/document-normalizer-index-v1.0.0.md delete mode 100644 programming-old/android/api-reference/document-normalizer-index.md delete mode 100644 programming-old/android/api-reference/document-normalizer-init.md delete mode 100644 programming-old/android/api-reference/document-normalizer-normalizing.md delete mode 100644 programming-old/android/api-reference/document-normalizer-settings.md delete mode 100644 programming-old/android/api-reference/document-normalizer-video-v1.0.0.md delete mode 100644 programming-old/android/api-reference/document-normalizer-video.md delete mode 100644 programming-old/android/api-reference/image-data-v1.0.0.md delete mode 100644 programming-old/android/api-reference/image-data.md delete mode 100644 programming-old/android/api-reference/index-v1.0.0.md delete mode 100644 programming-old/android/api-reference/index-v1.0.30.md delete mode 100644 programming-old/android/api-reference/interface-index.md delete mode 100644 programming-old/android/api-reference/license-manager.md delete mode 100644 programming-old/android/api-reference/license-verification-listener.md delete mode 100644 programming-old/android/api-reference/normalized-image-result-v1.0.0.md delete mode 100644 programming-old/android/api-reference/normalized-image-result.md delete mode 100644 programming-old/android/api-reference/quadrilateral.md delete mode 100644 programming-old/android/index-v1.0.30.md delete mode 100644 programming-old/android/release-notes/android-1.md delete mode 100644 programming-old/android/samples/helloworld-v1.0.30.md delete mode 100644 programming-old/android/samples/index-v1.0.30.md delete mode 100644 programming-old/android/user-guide-v1.0.0.md delete mode 100644 programming-old/android/user-guide-v1.0.30.md delete mode 100644 programming-old/enumerations/error-code-v1.0.0.md delete mode 100644 programming-old/enumerations/error-code.md delete mode 100644 programming-old/enumerations/image-pixel-format.md delete mode 100644 programming-old/ios/api-reference/auxiliary-index.md delete mode 100644 programming-old/ios/api-reference/detect-result-listener.md delete mode 100644 programming-old/ios/api-reference/detected-quad-result.md delete mode 100644 programming-old/ios/api-reference/document-normalizer-general.md delete mode 100644 programming-old/ios/api-reference/document-normalizer-index-v1.0.0.md delete mode 100644 programming-old/ios/api-reference/document-normalizer-index.md delete mode 100644 programming-old/ios/api-reference/document-normalizer-init.md delete mode 100644 programming-old/ios/api-reference/document-normalizer-normalizing.md delete mode 100644 programming-old/ios/api-reference/document-normalizer-settings.md delete mode 100644 programming-old/ios/api-reference/document-normalizer-video-v1.0.0.md delete mode 100644 programming-old/ios/api-reference/document-normalizer-video.md delete mode 100644 programming-old/ios/api-reference/image-data-v1.0.0.md delete mode 100644 programming-old/ios/api-reference/image-data.md delete mode 100644 programming-old/ios/api-reference/index-v1.0.0.md delete mode 100644 programming-old/ios/api-reference/index-v1.0.30.md delete mode 100644 programming-old/ios/api-reference/interface-index.md delete mode 100644 programming-old/ios/api-reference/license-manager.md delete mode 100644 programming-old/ios/api-reference/license-verification-listener.md delete mode 100644 programming-old/ios/api-reference/normalized-image-result-v1.0.0.md delete mode 100644 programming-old/ios/api-reference/normalized-image-result.md delete mode 100644 programming-old/ios/api-reference/quadrilateral.md delete mode 100644 programming-old/ios/index-v1.0.30.md delete mode 100644 programming-old/ios/release-notes/ios-1.md delete mode 100644 programming-old/ios/samples/helloworld-v1.0.30.md delete mode 100644 programming-old/ios/samples/index-v1.0.30.md delete mode 100644 programming-old/ios/user-guide-v1.0.30.md delete mode 100644 programming-old/xamarin/api-reference/camera-enhancer.md delete mode 100644 programming-old/xamarin/api-reference/camera-view.md delete mode 100644 programming-old/xamarin/api-reference/detect-result-listener.md delete mode 100644 programming-old/xamarin/api-reference/detected-quad-result.md delete mode 100644 programming-old/xamarin/api-reference/document-normalizer.md delete mode 100644 programming-old/xamarin/api-reference/droid-camera-enhancer.md delete mode 100644 programming-old/xamarin/api-reference/droid-document-normalizer.md delete mode 100644 programming-old/xamarin/api-reference/droid-license-manager.md delete mode 100644 programming-old/xamarin/api-reference/enum-image-pixel-format.md delete mode 100644 programming-old/xamarin/api-reference/image-data.md delete mode 100644 programming-old/xamarin/api-reference/image-editor-view.md delete mode 100644 programming-old/xamarin/api-reference/index.md delete mode 100644 programming-old/xamarin/api-reference/ios-camera-enhancer.md delete mode 100644 programming-old/xamarin/api-reference/ios-document-normalizer.md delete mode 100644 programming-old/xamarin/api-reference/ios-license-manager.md delete mode 100644 programming-old/xamarin/api-reference/license-manager.md delete mode 100644 programming-old/xamarin/api-reference/license-verification-listener.md delete mode 100644 programming-old/xamarin/api-reference/normalized-image-result.md delete mode 100644 programming-old/xamarin/api-reference/quadrilateral.md delete mode 100644 programming-old/xamarin/index.md delete mode 100644 programming-old/xamarin/release-notes/index.md delete mode 100644 programming-old/xamarin/release-notes/xamarin-1.md delete mode 100644 programming-old/xamarin/user-guide.md delete mode 100644 programming/android/api-reference/candidate-quad-edges-unit-v2.0.20.md delete mode 100644 programming/android/api-reference/corners-unit-v2.0.20.md delete mode 100644 programming/android/api-reference/detected-quads-unit-v2.0.20.md delete mode 100644 programming/android/api-reference/index-v2.0.20.md delete mode 100644 programming/android/api-reference/index.md delete mode 100644 programming/android/api-reference/long-lines-unit-v2.0.20.md delete mode 100644 programming/android/api-reference/normalized-image-unit-v2.0.20.md rename programming/android/api-reference/{simplified-document-normalizer-settings-v2.2.10.md => simplified-document-normalizer-settings-v2.2.3000.md} (83%) delete mode 100644 programming/android/index.md delete mode 100644 programming/android/release-notes/android-2.md delete mode 100644 programming/android/release-notes/index.md delete mode 100644 programming/android/samples/helloworld.md delete mode 100644 programming/android/samples/index.md delete mode 100644 programming/android/upgrade-instruction-v2.0.20.md delete mode 100644 programming/android/user-guide-v2.0.10.md delete mode 100644 programming/android/user-guide-v2.0.20.md rename programming/android/{user-guide-v2.2.10.md => user-guide-v2.2.3000.md} (59%) delete mode 100644 programming/assets/dcv-ddn-dependency.png delete mode 100644 programming/ios/api-reference/candidate-quad-edges-unit-v2.0.20.md delete mode 100644 programming/ios/api-reference/corners-unit-v2.0.20.md delete mode 100644 programming/ios/api-reference/detected-quad-element-v2.0.20.md delete mode 100644 programming/ios/api-reference/detected-quads-unit-v2.0.20.md delete mode 100644 programming/ios/api-reference/index-v2.0.20.md delete mode 100644 programming/ios/api-reference/index.md delete mode 100644 programming/ios/api-reference/long-lines-unit-2.0.20.md delete mode 100644 programming/ios/api-reference/normalized-image-element-v2.0.20.md delete mode 100644 programming/ios/api-reference/normalized-image-unit-v2.0.20.md create mode 100644 programming/ios/api-reference/simplified-document-normalizer-settings-v2.2.3000.md delete mode 100644 programming/ios/index.md delete mode 100644 programming/ios/release-notes/index.md delete mode 100644 programming/ios/release-notes/ios-2.md delete mode 100644 programming/ios/samples/helloworld.md delete mode 100644 programming/ios/samples/index.md delete mode 100644 programming/ios/upgrade-instruction-v2.2.10.md delete mode 100644 programming/ios/user-guide-v2.0.20.md delete mode 100644 programming/ios/user-guide-v2.2.10.md rename programming/ios/{user-guide-v2.0.10.md => user-guide-v2.2.3000.md} (75%) diff --git a/_config.yml b/_config.yml index b14abdb..303c654 100644 --- a/_config.yml +++ b/_config.yml @@ -43,7 +43,8 @@ enumerations: /document-normalizer/docs/mobile/programming/enumerations/ js: /document-normalizer/docs/web/programming/javascript/ cpp: /document-normalizer/docs/server/programming/cplusplus/ -useVersionTree: true +useVersionTree: false +isDCV: true assets: /document-normalizer/docs/mobile/assets/ edit_icon: /document-normalizer/docs/mobile/assets/img-icon/edit-icon.png diff --git a/_data/full_tree.yml b/_data/full_tree.yml deleted file mode 100644 index 9907bc1..0000000 --- a/_data/full_tree.yml +++ /dev/null @@ -1,9 +0,0 @@ -tree_file_list: - - sidelist-full-tree.html - - sidelist-programming/programming-android.html - - sidelist-programming/programming-android-v2.0.20.html - - sidelist-programming/programming-android-v1.0.30.html - - sidelist-programming/programming-ios.html - - sidelist-programming/programming-ios-v2.0.20.html - - sidelist-programming/programming-ios-v1.0.30.html - - sidelist-programming/programming-xamarin.html diff --git a/_data/product_version.yml b/_data/product_version.yml deleted file mode 100644 index 883a139..0000000 --- a/_data/product_version.yml +++ /dev/null @@ -1,42 +0,0 @@ -useGroupedVersion: true - -version_info_list: - - value: latest version - - value: 2.x - child: - - 2.2.10 - - 2.0.20 - - 2.0.10_android - - 2.0.10_ios - - value: 1.x - child: - - 1.0.30_android - - 1.0.21_android - - 1.0.20_android - - 1.0.12_android - - 1.0.11_android - - 1.0.10_android - - 1.0.0_android - - 1.0.30_ios - - 1.0.21_ios - - 1.0.20_ios - - 1.0.12_ios - - 1.0.11_ios - - 1.0.10_ios - - 1.0.0_ios - - 1.0.5_xamarin - - 1.0.4_xamarin - - 1.0.3_xamarin - - 1.0.2_xamarin - - 1.0.1_xamarin - - 1.0.0_xamarin - -# version_info_list_xamarin: -# - value: latest version (1.0.5) -# - value: 1.x -# child: -# - 1.0.4 -# - 1.0.3 -# - 1.0.2 -# - 1.0.1 -# - 1.0.0 diff --git a/_includes/release-notes/product-highlight-1.0.0.md b/_includes/release-notes/product-highlight-1.0.0.md deleted file mode 100644 index 4fe4256..0000000 --- a/_includes/release-notes/product-highlight-1.0.0.md +++ /dev/null @@ -1,15 +0,0 @@ - -Dynamsoft Document Normalizer 1.0 version supports quad boundary detection and image correction features. - -- Detectable quads include but are not limited to: - - Document Pages - - Tables - - Cards like ID cards -- The following features are available when normalizing the image: - - Boundary cropping - - Deskew processing -- The following attributes of the output image can be adjusted: - - Colour mode - - Contrast - - Brightness - 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 03b0d47..0000000 --- a/_includes/release-notes/product-highlight-2.0.0.md +++ /dev/null @@ -1,16 +0,0 @@ - -`DynamsoftDocumentNormalizer` SDK has been revamped to integrate with `DynamsoftCaptureVision (DCV)` architecture, which is newly established to aggregate the features of functional products powered by Dynamsoft. The features are designed to be pluggable, customizable and interactable. In addition, the functional products share the computation so that their processing speed is much higher than working individually. - -* `DynamsoftCaptureVision` architecture consists of: - * `ImageSourceAdapter(ISA)`, the standard input interface for you to convert image data from different sources into the standard input image data. In addition, `ISA` incorporates an image buffer management system that allows instant access to the buffered image data. - * `CaptureVisionRouter (CVR)`, an engine for you to update templates, retrieve images from `ISA`, coordinate corresponding functional products and dispatch the results to the receivers. - * Functional products that perform image processing, content understanding and semantic processing. The functional products are pluggable and passively called by CVR when they are required. - * Result receiver interfaces. You can implement `CapturedResultReceiver (CRR)` to receive the `CapturedResults` that output when the processing on an image is finalized. You can also implement `IntermediateResultReceiver (IRR)` to get timely results from different stages of the workflow. -* The parameter template system has been comprehensively upgraded. - * Multiple algorithm task settings are available. You can define barcode decoding, label recognizing, document scanning and semantic processing tasks in one template file. - * Extended the feature of the ROI system. By configuring the `target ROI` parameters, you can not only specify an `ROI` on the original image but also define the dependencies of the algorithm tasks. This feature enables you to customize the workflow when processing complex scenarios. - * The image processing parameters are separated from the task parameters so that the template settings become more clear and concise. -* The `intermediate result` system has been improved. - * Achieved the `intermediate result` sharing between different functional products. The results that have the same image source and processing parameters are directly reused, which speeds up the image processing workflow. You don’t need to add any additional code to enable the `intermediate result` sharing. The library can recognize all the reusable results automatically based on the template file you uploaded. - * The readability and interactivity of the `intermediate results` are enhanced. `IntermediateResultReceiver` allows you to receive up to 27 different types of `Intermediate results`. You can clearly read which stage of the algorithm each result is output from. In addition, `IntermediateResultManager` allows you to intervene in the workflows by modifying the `intermediate results`. - diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html deleted file mode 100644 index 32dc2e3..0000000 --- a/_includes/sidelist-full-tree.html +++ /dev/null @@ -1,12 +0,0 @@ -
  • - iOS Edition Introduction -
    • -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-ios.html" -%} -
  • - Android Edition Introduction -
    • -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-android.html" -%} -
  • - Xamarin.Forms Edtion Introduction -
    • -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-xamarin.html" -%} \ No newline at end of file diff --git a/_includes/sidelist-programming/programming-android-v1.0.30.html b/_includes/sidelist-programming/programming-android-v1.0.30.html deleted file mode 100644 index 16d41a9..0000000 --- a/_includes/sidelist-programming/programming-android-v1.0.30.html +++ /dev/null @@ -1,52 +0,0 @@ -
  • DEVELOPMENT
    • - -
  • User Guide -
    • -
  • Demo & Samples - -
    • -
  • API Reference - -
    • - -
  • USEFUL RESOURCES
    • - -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-android-v2.0.20.html b/_includes/sidelist-programming/programming-android-v2.0.20.html deleted file mode 100644 index 81bff54..0000000 --- a/_includes/sidelist-programming/programming-android-v2.0.20.html +++ /dev/null @@ -1,216 +0,0 @@ -
  • DEVELOPMENT
    • -
  • User Guide - -
    • -
  • Samples - -
    • -
  • API Reference - -
    • - -
  • USEFUL RESOURCES
    • - -
  • Release Notes - -
    • - -
  • Upgrade Instructions
    • - diff --git a/_includes/sidelist-programming/programming-android.html b/_includes/sidelist-programming/programming-android.html deleted file mode 100644 index e84fdd1..0000000 --- a/_includes/sidelist-programming/programming-android.html +++ /dev/null @@ -1,219 +0,0 @@ -
  • DEVELOPMENT
    • -
  • User Guide - -
    • -
  • Samples - -
    • -
  • API Reference - -
    • - -
  • USEFUL RESOURCES
    • - -
  • Release Notes - -
    • - -
  • Upgrade Instructions
    • - diff --git a/_includes/sidelist-programming/programming-ios-v1.0.30.html b/_includes/sidelist-programming/programming-ios-v1.0.30.html deleted file mode 100644 index 2c4ca6a..0000000 --- a/_includes/sidelist-programming/programming-ios-v1.0.30.html +++ /dev/null @@ -1,51 +0,0 @@ -
  • DEVELOPMENT
    • - -
  • User Guide -
    • -
  • Demo & Samples - -
    • -
  • API Reference - -
    • -
  • USEFUL RESOURCES
    • - -
  • Release Notes - -
    • diff --git a/_includes/sidelist-programming/programming-ios-v2.0.20.html b/_includes/sidelist-programming/programming-ios-v2.0.20.html deleted file mode 100644 index cf8deef..0000000 --- a/_includes/sidelist-programming/programming-ios-v2.0.20.html +++ /dev/null @@ -1,212 +0,0 @@ -
  • DEVELOPMENT
    • - - -
  • User Guide - -
    • -
  • Samples - -
    • -
  • API Reference - -
    • -
  • USEFUL RESOURCES
    • - -
  • Release Notes - -
    • -
  • Upgrade Instructions
    • \ No newline at end of file diff --git a/_includes/sidelist-programming/programming-ios.html b/_includes/sidelist-programming/programming-ios.html deleted file mode 100644 index 23b46b3..0000000 --- a/_includes/sidelist-programming/programming-ios.html +++ /dev/null @@ -1,215 +0,0 @@ -
  • DEVELOPMENT
    • - - -
  • User Guide - -
    • -
  • Samples - -
    • -
  • API Reference - -
    • -
  • USEFUL RESOURCES
    • - -
  • Release Notes - -
    • -
  • Upgrade Instructions
    • \ No newline at end of file diff --git a/_includes/sidelist-programming/programming-xamarin.html b/_includes/sidelist-programming/programming-xamarin.html deleted file mode 100644 index 73e5d51..0000000 --- a/_includes/sidelist-programming/programming-xamarin.html +++ /dev/null @@ -1,58 +0,0 @@ -
  • DEVELOPMENT
    • -
  • User Guide -
    • - -
  • API Reference - -
    • - -
  • USEFUL RESOURCES
    • -
  • Release Notes - -
    • diff --git a/_layouts/default-layout-OLD.html b/_layouts/default-layout-OLD.html deleted file mode 100644 index f9cf5b8..0000000 --- a/_layouts/default-layout-OLD.html +++ /dev/null @@ -1,109 +0,0 @@ - - - -{%- include head.html -%} -{%- assign noTitleIndex = "" -%} -{%- if page.noTitleIndex or page.url contains 'release-notes' -%} - {%- assign noTitleIndex = "noTitleIndex" -%} -{%- endif -%} - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - - {%- include ddnNav.html -%} -
    Table of contents
    -
    -
    -
    -
    - {%- include main-page-head.html -%} -
    -
    -
    - {{ content }} - -
    -
    -
    -

    This page is compatible for:

    -

    Version 1.0

    -
    -
    -

    Is this page helpful?

    - YesYes - NoNo -
    -
    - {%- if page.needAutoGenerateSidebar -%} -

    In this article:

    -
    - {%- endif -%} -
    -
    - -
    - -
    -
    -
    -
    -
    - {%- include liquid_autoGenerateHistoryList.html -%} - {%- include auto-version-list.html -%} -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - - - {%- include livehelp.html -%} - - - - - - - - - - - - - diff --git a/_layouts/home-page.html b/_layouts/home-page.html deleted file mode 100644 index 89aa900..0000000 --- a/_layouts/home-page.html +++ /dev/null @@ -1,50 +0,0 @@ - - - -{%- include head.html -%} - - - - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - -
    -
    -
    - - {{ content }} -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - - - - diff --git a/_layouts/search-page-OLD.html b/_layouts/search-page-OLD.html deleted file mode 100644 index 4746d3d..0000000 --- a/_layouts/search-page-OLD.html +++ /dev/null @@ -1,210 +0,0 @@ - - - -{%- include head.html -%} - - - - {% assign url = 'https://www.dynamsoft.com/shared/head/' %} - {% remote_include {{ url }} %} - - {%- include ddnNav.html -%} -
    -
    -
    -
    -
    -
    -
    -

    Search

    - -
    -
    -
    -
    - -
    -
    -
    -
    -
    - {%- include page_footer.html -%} -
    - - - - {%- include livehelp.html -%} - - - \ No newline at end of file diff --git a/assets/js/ddnMobileVersionSearch.json b/assets/js/ddnMobileVersionSearch.json deleted file mode 100644 index f096358..0000000 --- a/assets/js/ddnMobileVersionSearch.json +++ /dev/null @@ -1,438 +0,0 @@ -[ - { - "version": "2.2.11", - "matchList": { - "android":{ - "dcvRepoMobile": [ - { - "path": "/programming/android/api-reference/utility", - "version": "1.2.20" - }, { - "path": "/programming/android/api-reference/license", - "version": "3.2.20" - }, { - "path": "/programming/android/api-reference/capture-vision-router", - "version": "2.2.30" - }, { - "path": "/programming/android/api-reference/core", - "version": "3.2.30" - }, { - "path": "/programming/android/api-reference/image-processing", - "version": "2.2.30" - } - ], - "dcvRepoCore": [ - { - "path": "/introduction/", - "version": "2.2.10" - }, { - "path": "/enums/capture-vision-router", - "version": "2.2.30" - }, { - "path": "/enums/core", - "version": "3.2.30" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.30" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.30" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.30" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.30" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.30" - } - ], - "dce": "4.2.10" - }, - "ios":{ - "dcvRepoMobile": [ - { - "path": "/programming/objectivec-swift/api-reference/utility", - "version": "1.2.20" - }, { - "path": "/programming/objectivec-swift/api-reference/license", - "version": "3.2.20" - }, { - "path": "/programming/objectivec-swift/api-reference/capture-vision-router", - "version": "2.2.30" - }, { - "path": "/programming/objectivec-swift/api-reference/core", - "version": "3.2.30" - }, { - "path": "/programming/objectivec-swift/api-reference/image-processing", - "version": "2.2.30" - } - ], - "dcvRepoCore": [ - { - "path": "/introduction/", - "version": "2.2.10" - }, { - "path": "/enums/capture-vision-router", - "version": "2.2.30" - }, { - "path": "/enums/core", - "version": "3.2.30" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.30" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.30" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.30" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.30" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.30" - } - ], - "dce": "4.2.10" - } - } - },{ - "version": "2.2.10", - "matchList": { - "android":{ - "dcvRepoMobile": [ - { - "path": "/programming/android/api-reference/utility", - "version": "1.2.10" - }, { - "path": "/programming/android/api-reference/license", - "version": "3.2.10" - }, { - "path": "/programming/android/api-reference/capture-vision-router", - "version": "2.2.10" - }, { - "path": "/programming/android/api-reference/core", - "version": "3.2.10" - }, { - "path": "/programming/android/api-reference/image-processing", - "version": "2.2.10" - } - ], - "dcvRepoCore": [ - { - "path": "/introduction/", - "version": "2.2.10" - }, { - "path": "/enums/capture-vision-router", - "version": "2.2.10" - }, { - "path": "/enums/core", - "version": "3.2.10" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.10" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.10" - } - ], - "dce": "4.2.0" - }, - "ios":{ - "dcvRepoMobile": [ - { - "path": "/programming/objectivec-swift/api-reference/utility", - "version": "1.2.10" - }, { - "path": "/programming/objectivec-swift/api-reference/license", - "version": "3.2.10" - }, { - "path": "/programming/objectivec-swift/api-reference/capture-vision-router", - "version": "2.2.10" - }, { - "path": "/programming/objectivec-swift/api-reference/core", - "version": "3.2.10" - }, { - "path": "/programming/objectivec-swift/api-reference/image-processing", - "version": "2.2.10" - } - ], - "dcvRepoCore": [ - { - "path": "/introduction/", - "version": "2.2.10" - }, { - "path": "/enums/capture-vision-router", - "version": "2.2.10" - }, { - "path": "/enums/core", - "version": "3.2.10" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.10" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.10" - } - ], - "dce": "4.2.0" - } - } - },{ - "version": "2.0.20", - "matchList": { - "android":{ - "dcvRepoMobile": [ - { - "path": "/programming/android/api-reference/utility", - "version": "1.0.21" - }, { - "path": "/programming/android/api-reference/license", - "version": "3.0.30" - }, { - "path": "/programming/android/api-reference/capture-vision-router", - "version": "2.0.21" - }, { - "path": "/programming/android/api-reference/core", - "version": "3.0.20" - }, { - "path": "/programming/android/api-reference/image-processing", - "version": "2.0.21" - } - ], - "dcvRepoCore": [ - { - "path": "/introduction/", - "version": "2.2.10" - }, { - "path": "/enums/capture-vision-router", - "version": "2.0.21" - }, { - "path": "/enums/core", - "version": "3.0.20" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.21" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.21" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.21" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.20" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.21" - } - ], - "dce": "4.0.2" - }, - "ios":{ - "dcvRepoMobile": [ - { - "path": "/programming/objectivec-swift/api-reference/utility", - "version": "1.0.21" - }, { - "path": "/programming/objectivec-swift/api-reference/license", - "version": "3.0.30" - }, { - "path": "/programming/objectivec-swift/api-reference/capture-vision-router", - "version": "2.0.21" - }, { - "path": "/programming/objectivec-swift/api-reference/core", - "version": "3.0.20" - }, { - "path": "/programming/objectivec-swift/api-reference/image-processing", - "version": "2.0.21" - } - ], - "dcvRepoCore": [ - { - "path": "/introduction/", - "version": "2.2.10" - }, { - "path": "/enums/capture-vision-router", - "version": "2.0.21" - }, { - "path": "/enums/core", - "version": "3.0.20" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.21" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.21" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.21" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.20" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.21" - } - ], - "dce": "4.0.2" - } - } - },{ - "version": "2.0.10", - "matchList": { - "android":{ - "dcvRepoMobile": [ - { - "path": "/programming/android/api-reference/utility", - "version": "1.0.10" - }, { - "path": "/programming/android/api-reference/license", - "version": "3.0.10" - }, { - "path": "/programming/android/api-reference/capture-vision-router", - "version": "2.0.10" - }, { - "path": "/programming/android/api-reference/core", - "version": "3.0.10" - }, { - "path": "/programming/android/api-reference/image-processing", - "version": "2.0.10" - } - ], - "dcvRepoCore": [ - { - "path": "/introduction/", - "version": "2.2.10" - }, { - "path": "/enums/capture-vision-router", - "version": "2.0.10" - }, { - "path": "/enums/core", - "version": "3.0.10" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.10" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.0.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.10" - } - ], - "dce": "4.0.0" - }, - "ios":{ - "dcvRepoMobile": [ - { - "path": "/programming/objectivec-swift/api-reference/utility", - "version": "1.0.10" - }, { - "path": "/programming/objectivec-swift/api-reference/license", - "version": "3.0.10" - }, { - "path": "/programming/objectivec-swift/api-reference/capture-vision-router", - "version": "2.0.10" - }, { - "path": "/programming/objectivec-swift/api-reference/core", - "version": "3.0.10" - }, { - "path": "/programming/objectivec-swift/api-reference/image-processing", - "version": "2.0.10" - } - ], - "dcvRepoCore": [ - { - "path": "/introduction/", - "version": "2.2.10" - }, { - "path": "/enums/capture-vision-router", - "version": "2.0.10" - }, { - "path": "/enums/core", - "version": "3.0.10" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.10" - },{ - "path": "/parameters/reference/document-normalizer-task-settings", - "version": "2.0.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.10" - } - ], - "dce": "4.0.0" - } - } - },{ - "version": "1.0.30", - "matchList": { - "android": { - "dce": "3.0.3" - }, - "ios": { - "dce": "3.0.3" - } - } - } -] - \ No newline at end of file diff --git a/programming-old/android/api-reference/auxiliary-index.md b/programming-old/android/api-reference/auxiliary-index.md deleted file mode 100644 index d1f69ca..0000000 --- a/programming-old/android/api-reference/auxiliary-index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - Auxiliary Class -description: This page shows all auxiliary classes of Dynamsoft Document Normalizer for Android SDK. -keywords: class, api reference, android -needAutoGenerateSidebar: true -breadcrumbText: Auxiliary Class -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/android/api-reference/auxiliary-index.html ---- - -# Auxiliary Classes - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -- [`Quadrilateral`](quadrilateral.md) -- [`ImageData`](image-data.md) -- [`LicenseManager`](license-manager.md) -- [`DetectedQuadResult`](detected-quad-result.md) -- [`NormalizedImageResult`](normalized-image-result.md) -- [`DocumentNormalizerException`](document-normalizer-exception.md) \ No newline at end of file diff --git a/programming-old/android/api-reference/detect-result-listener.md b/programming-old/android/api-reference/detect-result-listener.md deleted file mode 100644 index ea2ca7b..0000000 --- a/programming-old/android/api-reference/detect-result-listener.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - Interface DetectResultListener -description: This the interface DetectResultListener page of Dynamsoft Document Normalizer for Android SDK. -keywords: DetectResultListener, interface, android -needAutoGenerateSidebar: true -needGenerateH3Content: false -noTitleIndex: true -permalink: /programming/android/api-reference/detect-result-listener.html ---- - -# DetectResultListener - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -`DetectResultListener` is the interface to handle callbacks when the detection results are returned. - -```java -interface com.dynamsoft.ddn.DetectResultListener -``` - -| Method | Description | -| ------ | ----------- | -| `detectResultCallback` | The callback method to handle the detection results returned by the library. | - -## detectResultCallback - -The callback method to handle the detection results returned by the library. - -```java -void detectResultCallback(int frameId, ImageData imageData, DetectedQuadResult[] detectResults); -``` - -**Parameters** - -`[in] frameId`: The ID of the frame. -`[in] imgData`: The image data of frame. -`[in] detectResults`: Detected results of the frame. - -**Code Snippet** - -```java -DetectResultListener detectResultListener = new DetectResultListener() { - @Override - public void detectResultCallback(int frameId, ImageData imageData, DetectedQuadResult[] textResults) { - // Add your code - } -}; -``` diff --git a/programming-old/android/api-reference/detected-quad-result.md b/programming-old/android/api-reference/detected-quad-result.md deleted file mode 100644 index 2e2b54a..0000000 --- a/programming-old/android/api-reference/detected-quad-result.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - DetectedQuadResult Class -description: This page shows the DetectedQuadResult Class of Dynamsoft Document Normalizer for Android SDK. -keywords: DetectedQuadResult, class, api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference/detected-quad-result.html ---- - -# DetectedQuadResult - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -Stores the detected quad result. - -```java -class com.dynamsoft.ddn.DetectedQuadResult; -``` - -| Attribute | Type | Descriptions | -| --------- | ---- | ------------ | -| [`location`](#location) | [`Quadrilateral`](quadrilateral.md) | The location of the detected quad result. | -| [`confidenceAsDocumentBoundary`](#confidenceasdocumentboundary) | *int* | The confidence as document boundary. | - -## location - -The location of the detected quad result. - -```java -Quadrilateral location; -``` - -## confidenceAsDocumentBoundary - -The confidence as document boundary. - -```java -int confidenceAsDocumentBoundary; -``` diff --git a/programming-old/android/api-reference/document-normalizer-exception.md b/programming-old/android/api-reference/document-normalizer-exception.md deleted file mode 100644 index 776c07c..0000000 --- a/programming-old/android/api-reference/document-normalizer-exception.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - DocumentNormalizerException Class -description: This page shows the DocumentNormalizerException Class of Dynamsoft Document Normalizer for Android SDK. -keywords: DocumentNormalizerException, class, api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference/document-normalizer-exception.html ---- - -# DocumentNormalizerException - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -Exception for signalling document normalizer errors. - -```java -class com.dynamsoft.ddn.DocumentNormalizerException; -``` - -| Method | Type | Description | -|--------|------|-------------| -| [`getErrorCode`](#geterrorcode)| *int* | Get the error code | - -## getErrorCode - -**Return Value** - -This method returns the DDN error code. Please view more about the error code in [`EnumErrorCode`]({{site.enumerations}}error-code.html) - -**Code Snippet** - -```java -try { - DocumentNormalizer normalizer = new DocumentNormalizer(); - QuadDetectionResult[] results = normalizer.detect("Your file path"); -} catch (DocumentNormalizerException e) { - Log.i("Detect", "The error code is: " + e.getErrorCode()); -} -``` diff --git a/programming-old/android/api-reference/document-normalizer-general.md b/programming-old/android/api-reference/document-normalizer-general.md deleted file mode 100644 index 1afccca..0000000 --- a/programming-old/android/api-reference/document-normalizer-general.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - DocumentNormalizer General Methods -description: This page shows DocumentNormalizer general methods of Dynamsoft Document Normalizer for Android SDK. -keywords: getVersion, general methods, DocumentNormalizer, api reference, android -needAutoGenerateSidebar: true -noTitleIndex: true -permalink: /programming/android/api-reference/document-normalizer-general.html ---- - -# General Methods - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - - | Method | Description | - |----------------------|-------------| - | [`getVersion`](#getversion) | Get version information of SDK.| - - --- - -## getVersion - -Get version information of SDK. - -```java -static String getVersion() -``` - -**Return Value** - -The version information string. - -**Code Snippet** - -```java -String versionString = DocumentNormalizer.getVersion(); -``` diff --git a/programming-old/android/api-reference/document-normalizer-index-v1.0.0.md b/programming-old/android/api-reference/document-normalizer-index-v1.0.0.md deleted file mode 100644 index 932c116..0000000 --- a/programming-old/android/api-reference/document-normalizer-index-v1.0.0.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - DocumentNormalizer Methods -description: This page shows DocumentNormalizer methods of Dynamsoft Document Normalizer for Android SDK. -keywords: methods, DocumentNormalizer, api reference, android -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: DocumentNormalizer Class -pageStartVer: 1.0 -permalink: /programming/android/api-reference/document-normalizer-index-v1.0.0.html ---- - -# DocumentNormalizer Class - -This is the main class of Dynamsoft Document Normalizer(DDN) SDK. It supports quad detection and image normalization for still pictures and live video. - -Common detections include: - -- Document boundary detection -- Table boundary detection - -Common normalizations include: - -- Border crop -- Deskew -- Perspective correction -- Colour mode -- Brightness and Contrast - - -```java -class com.dynamsoft.ddn.DocumentNormalizer -``` - -## Initialize Methods - - | Method | Description | - |----------------------|-------------| - | [`DocumentNormalizer`](document-normalizer-init.md#documentnormalizer) | Initialization of `DocumentNormalizer` object.| - -## Video Detecting Methods - - | Method | Description | - |----------------------|-------------| - | [`setCameraEnhancer`](document-normalizer-video.md#setcameraenhancer) | Bind a Camera Enhancer instance to the Document Normalizer. | - | [`startDetecting`](document-normalizer-video.md#startdetecting) | Start the document quad detection thread in the video streaming scenario. | - | [`stopDetecting`](document-normalizer-video.md#stopdetecting) | Stop the document quad detection thread in the video streaming scenario. | - | [`setDetectResultListener`](document-normalizer-video.md#setdetectresultlistener) | Set callback interface to process detection results generated during frame detecting. | - -## Detect and Normalize Methods - - | Method | Description | - |----------------------|-------------| - | [`detectQuad(buffer)`](document-normalizer-normalizing.md#detectquadbuffer) | Detect quad from the memory buffer containing image pixels in defined format. | - | [`detectQuad(file)`](document-normalizer-normalizing.md#detectquadfile) | Detect quad from an image file. | - | [`detectQuad(bitmap)`](document-normalizer-normalizing.md#detectquadbitmap) | Detect quad from a bufferd image(bitmap). | - | [`normalize(buffer)`](document-normalizer-normalizing.md#normalizebuffer) | Normalize image from the memory buffer containing image pixels in defined format. | - | [`normalize(file)`](document-normalizer-normalizing.md#normalizefile) | Normalize an image file. | - | [`normalize(bitmap)`](document-normalizer-normalizing.md#normalizebitmap) | Normalize a buffered image(bitmap). | - -## Runtime Settings Methods - - | Method | Description | - |----------------------|-------------| - | [`initRuntimeSettingsFromFile`](document-normalizer-settings.md#initruntimesettingsfromfile) | Initialize runtime settings with the settings in a given JSON file. | - | [`initRuntimeSettingsFromString`](document-normalizer-settings.md#initruntimesettingsfromstring) | Initialize runtime settings with the settings in a given JSON string. | - | [`outputRuntimeSettingsToFile`](document-normalizer-settings.md#outputruntimesettingstofile) | Output runtime settings to a settings file (JSON file). | - | [`outputRuntimeSettings`](document-normalizer-settings.md#outputruntimesettings) | Output runtime settings to a string. | - -## General Methods - - | Method | Description | - |----------------------|-------------| - | [`getVersion`](document-normalizer-general.md#getversion) | Get version information of SDK.| diff --git a/programming-old/android/api-reference/document-normalizer-index.md b/programming-old/android/api-reference/document-normalizer-index.md deleted file mode 100644 index b008582..0000000 --- a/programming-old/android/api-reference/document-normalizer-index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - DocumentNormalizer Methods -description: This page shows DocumentNormalizer methods of Dynamsoft Document Normalizer for Android SDK. -keywords: methods, DocumentNormalizer, api reference, android -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: DocumentNormalizer Class -pageStartVer: 1.0 -permalink: /programming/android/api-reference/document-normalizer-index.html ---- - -# DocumentNormalizer Class - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -This is the main class of Dynamsoft Document Normalizer(DDN) SDK. It supports quad detection and image normalization for still pictures and live video. - -Common detections include: - -- Document boundary detection -- Table boundary detection - -Common normalizations include: - -- Border crop -- Deskew -- Perspective correction -- Colour mode -- Brightness and Contrast - - -```java -class com.dynamsoft.ddn.DocumentNormalizer -``` - -## Initialize Methods - - | Method | Description | - |----------------------|-------------| - | [`DocumentNormalizer`](document-normalizer-init.md#documentnormalizer) | Initialization of `DocumentNormalizer` object.| - -## Video Detecting Methods - - | Method | Description | - |----------------------|-------------| - | [`setImageSource`](document-normalizer-video.md#setimagesource) | Sets an instance of ImageSource to get images. | - | [`startDetecting`](document-normalizer-video.md#startdetecting) | Start the document quad detection thread in the video streaming scenario. | - | [`stopDetecting`](document-normalizer-video.md#stopdetecting) | Stop the document quad detection thread in the video streaming scenario. | - | [`setDetectResultListener`](document-normalizer-video.md#setdetectresultlistener) | Set callback interface to process detection results generated during frame detecting. | - -## Detect and Normalize Methods - - | Method | Description | - |----------------------|-------------| - | [`detectQuad(buffer)`](document-normalizer-normalizing.md#detectquadbuffer) | Detect quad from the memory buffer containing image pixels in defined format. | - | [`detectQuad(file)`](document-normalizer-normalizing.md#detectquadfile) | Detect quad from an image file. | - | [`detectQuad(bitmap)`](document-normalizer-normalizing.md#detectquadbitmap) | Detect quad from a bufferd image(bitmap). | - | [`normalize(buffer)`](document-normalizer-normalizing.md#normalizebuffer) | Normalize image from the memory buffer containing image pixels in defined format. | - | [`normalize(file)`](document-normalizer-normalizing.md#normalizefile) | Normalize an image file. | - | [`normalize(bitmap)`](document-normalizer-normalizing.md#normalizebitmap) | Normalize a buffered image(bitmap). | - -## Runtime Settings Methods - - | Method | Description | - |----------------------|-------------| - | [`initRuntimeSettingsFromFile`](document-normalizer-settings.md#initruntimesettingsfromfile) | Initialize runtime settings with the settings in a given JSON file. | - | [`initRuntimeSettingsFromString`](document-normalizer-settings.md#initruntimesettingsfromstring) | Initialize runtime settings with the settings in a given JSON string. | - | [`outputRuntimeSettingsToFile`](document-normalizer-settings.md#outputruntimesettingstofile) | Output runtime settings to a settings file (JSON file). | - | [`outputRuntimeSettings`](document-normalizer-settings.md#outputruntimesettings) | Output runtime settings to a string. | - -## General Methods - - | Method | Description | - |----------------------|-------------| - | [`getVersion`](document-normalizer-general.md#getversion) | Get version information of SDK.| diff --git a/programming-old/android/api-reference/document-normalizer-init.md b/programming-old/android/api-reference/document-normalizer-init.md deleted file mode 100644 index 7cc0b71..0000000 --- a/programming-old/android/api-reference/document-normalizer-init.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - DocumentNormalizer initialization -description: This page shows DocumentNormalizer initialization methods of Dynamsoft Document Normalizer for Android SDK. -keywords: DocumentNormalizer, initialization, api reference, android -needAutoGenerateSidebar: true -noTitleIndex: true -permalink: /programming/android/api-reference/document-normalizer-init.html ---- - -# Initialization Methods - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - - | Method | Description | - |----------------------|-------------| - | [`DocumentNormalizer`](#documentnormalizer) | Initialization of `DocumentNormalizer` object.| - ---- - -## DocumentNormalizer - -Initialization of `DocumentNormalizer` object. - -```java -DocumentNormalizer() throws DocumentNormalizerException -``` - -**Exceptions** - -[`DocumentNormalizerException`](document-normalizer-exception.md) - -**Code Snippet** - -```java -try { - DocumentNormalizer normalizer = new DocumentNormalizer(); -} catch (DocumentNormalizerException e) { - Log.i("DDN", "The error code is: " + e.getErrorCode()); -} -``` diff --git a/programming-old/android/api-reference/document-normalizer-normalizing.md b/programming-old/android/api-reference/document-normalizer-normalizing.md deleted file mode 100644 index e973a9a..0000000 --- a/programming-old/android/api-reference/document-normalizer-normalizing.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - DocumentNormalizer Detect and Normalize Methods -description: This page shows DocumentNormalizer Detect and Normalize methods of Dynamsoft Document Normalizer for Android SDK. -keywords: detectQuad, normalize, DocumentNormalizer, api reference, android -needAutoGenerateSidebar: true -noTitleIndex: true -needGenerateH3Content: false -permalink: /programming/android/api-reference/document-normalizer-normalizing.html ---- - - -# Detect and Normalize Methods - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -| Method | Description | -|----------------------|-------------| -| [`detectQuad(buffer)`](#detectquadbuffer) | Detect quad from the memory buffer containing image pixels in defined format. | -| [`detectQuad(file)`](#detectquadfile) | Detect quad from an image file. | -| [`detectQuad(bitmap)`](#detectquadbitmap) | Detect quad from a buffered image(bitmap). | -| [`normalize(buffer)`](#normalizebuffer) | Normalize image from the memory buffer containing image pixels in defined format. | -| [`normalize(file)`](#normalizefile) | Normalize an image file. | -| [`normalize(bitmap)`](#normalizebitmap) | Normalize a buffered image(bitmap). | - ---- - -## detectQuad(buffer) - -Detect quad from the memory buffer containing image pixels in defined format. - -```java -DetectedQuadResult[] detectQuad(ImageData buffer) throws DocumentNormalizerException -``` - -**Parameters** - -`[in] buffer`: The memory buffer containing image pixels in defined format. - -**Return Value** - -The detected quads in the raw image buffer. Refer [`DetectedQuadResult`](detected-quad-result.md). - -**Exceptions** - -[`DocumentNormalizerException`](document-normalizer-exception.md) - -There are several approaches for you to get a buffered image. - -### Get ImageData from DCEFrame - -You can import CameraEnhancer to acquire buffered video frames from `frameOutputCallback` or `videoBuffer` of DCE. - -**Code Snippet** - -```java -/*You can get frames from frame output call back if you import dynamsoft camera enhancer package.*/ -/*You can get all the required parameters of decodeBuffer from DCEFrame.*/ -import com.dynamsoft.dce.CameraEnhancer; - -DocumentNormalizer normalizer = new DocumentNormalizer(); -mCameraEnhancer.addListener(new DCEFrameListener() { - @Override - public void frameOutputCallback(DCEFrame dceFrame, long l) { - try { - ImageData buffer = new ImageData(dceFrame.getImageData(),dceFrame.getWidth(),dceFrame.getHeight(),dceFrame.getStrides()[0],dceFrame.getPixelFormat()); - - DetectedQuadResult[] quads = normalizer.detectQuad(buffer); - } catch (DocumentNormalizerException e) { - e.printStackTrace(); - } - } -}); -``` - -### Get ImageData from Android Camera2 - -When you are using Android Camera2, you can get video frames from ImageReader. - -**Code Snippet** - -```java -previewReader.setOnImageAvailableListener(new ImageReader.OnImageAvailableListener() { - @Override - public void onImageAvailable(ImageReader reader) { - Image mImage = reader.acquireLatestImage(); - ByteBuffer bufferY = mImage.getPlanes()[0].getBuffer(); - int strideY = mImage.getPlanes()[0].getRowStride() / mImage.getPlanes()[0].getPixelStride(); - ByteBuffer bufferU = mImage.getPlanes()[1].getBuffer(); - int strideU = mImage.getPlanes()[1].getRowStride() / mImage.getPlanes()[1].getPixelStride(); - ByteBuffer bufferV = mImage.getPlanes()[2].getBuffer(); - int strideV = mImage.getPlanes()[2].getRowStride() / mImage.getPlanes()[2].getPixelStride(); - int padingY = mImage.getPlanes()[0].getRowStride() - mImage.getWidth(); - int padingU = mImage.getPlanes()[1].getRowStride() - mImage.getWidth(); - byte[] newData = new byte[bufferY.limit()]; - newData = new byte[bufferY.limit() + bufferU.limit() + 1 + padingY + padingU]; - bufferV.get(newData, bufferY.limit() + padingY, 1); - bufferU.get(newData, bufferY.limit() + padingY + 1, bufferU.limit()); - bufferY.get(newData, 0, bufferY.limit()); - int[] strides = new int[]{strideY, strideU, strideV}; - try { - ImageData buffer = new ImageData(newData, strideY, mImage.getHeight(), strideY, 3); - - DetectedQuadResult[] quads = normalizer.detectQuad(buffer); - } catch (DocumentNormalizerException e) { - e.printStackTrace(); - } - } -},handler); -``` - -## detectQuad(file) - -Detect quad from an image file. - -```java -DetectedQuadResult[] detectQuad(String fileFullPath) throws DocumentNormalizerException -``` - -**Parameters** - -`[in] fileFullPath`: A string defining the file path. It supports BMP, TIFF, JPG, PNG files. - -**Return Value** - -The detected quads in the image file. Refer [`DetectedQuadResult`](detected-quad-result.md). - -**Exceptions** - -[`DocumentNormalizerException`](document-normalizer-exception.md) - -**Code Snippet** - -```java -try { - DocumentNormalizer normalizer = new DocumentNormalizer(); - DetectedQuadResult[] result = normalizer.detectQuad("your file path"); -} catch (DocumentNormalizerException e) { - e.printStackTrace(); -} -``` - -## detectQuad(bitmap) - -Detect quad from a buffered image (bitmap). - -```java -DetectedQuadResult[] detectQuad(Bitmap bitmap) throws DocumentNormalizerException -``` - -**Parameters** - -`[in] bitmap`: The android bitmap to be detected. - -**Return Value** - -The detected quads in the buffered image (bitmap). Refer [`DetectedQuadResult`](detected-quad-result.md). - -**Exceptions** - -[`DocumentNormalizerException`](document-normalizer-exception.md), IOException - -**Code Snippet** - -```java -try { - DocumentNormalizer normalizer = new DocumentNormalizer(); - - // user code: get bitmap from somewhere - Bitmap bitmap = GetBitmapFromSomeWhere(); - - DetectedQuadResult[] result = normalizer.detectQuad(bitmap); -} catch (DocumentNormalizerException e) { - e.printStackTrace(); -} -``` - -## normalize(buffer) - -Normalize image from the memory buffer containing image pixels in defined format. - -```java -NormalizedImageResult normalize(ImageData buffer, Quadrilateral quad) throws DocumentNormalizerException -``` - -**Parameters** - -`[in] buffer`: The memory buffer containing image pixels in defined format. -`[in] quad`: The detected quad for normalizing. - -**Return Value** - -The normalized image result. Refer [`NormalizedImageResult`](normalized-image-result.md) - -**Exceptions** - -[`DocumentNormalizerException`](document-normalizer-exception.md) - -There are several approaches for you to get a buffered image. - -- Refer [`here`](#get-imagedata-from-dceframe) to get the ImageData from DCEFrame. -- Refer [`here`](#get-imagedata-from-android-camera2) to get the ImageData from Android Camera2. - -**Code Snippet** - -```java -try { - DocumentNormalizer normalizer = new DocumentNormalizer(); - - // user code: get ImageData from somewhere - ImageData buffer = GetImageDataFromSomeWhere(); - - DetectedQuadResult[] quads = normalizer.detectQuad(buffer); - if(quads.length > 0) { - NormalizedImageResult normalizedImage = normalizer.normalize(buffer, quads[0].location); - } -} catch (DocumentNormalizerException e) { - e.printStackTrace(); -} -``` - -## normalize(file) - -Normalize an image file. - -```java -NormalizedImageResult normalize(String fileFullePath, Quadrilateral quad) throws DocumentNormalizerException -``` - -**Parameters** - -`[in] fileFullPath`: A string defining the file path. It supports BMP, TIFF, JPG, PNG files. -`[in] quad`: The detected quad for normalizing. - -**Return Value** - -The normalized image result. Refer [`NormalizedImageResult`](normalized-image-result.md) - -**Exceptions** - -[`DocumentNormalizerException`](document-normalizer-exception.md) - -**Code Snippet** - -```java -try { - DocumentNormalizer normalizer = new DocumentNormalizer(); - - String imageFilePath = "your file path"; - - DetectedQuadResult[] quads = normalizer.detectQuad(imageFilePath); - if(quads.length > 0) { - NormalizedImageResult normalizedImage = normalizer.normalize(imageFilePath, quads[0].location); - } -} catch (DocumentNormalizerException e) { - e.printStackTrace(); -} -``` - -## normalize(bitmap) - -Normalize a buffered image (bitmap). - -```java -NormalizedImageResult normalize(Bitmap bitmap, Quadrilateral quad) throws DocumentNormalizerException -``` - -**Parameters** - -`[in] bitmap`: The android bitmap to be normalized. -`[in] quad`: The detected quad for normalizing. - -**Return Value** - -The normalized image result. Refer [`NormalizedImageResult`](normalized-image-result.md) - -**Exceptions** - -[`DocumentNormalizerException`](document-normalizer-exception.md), IOException - -**Code Snippet** - -```java -try { - DocumentNormalizer normalizer = new DocumentNormalizer(); - - // user code: get bitmap from somewhere - Bitmap bitmap = GetBitmapFromSomeWhere(); - - DetectedQuadResult[] quads = normalizer.detectQuad(bitmap); - if(quads.length > 0) { - NormalizedImageResult normalizedImage = normalizer.normalize(bitmap, quads[0].location); - } -} catch (DocumentNormalizerException e) { - e.printStackTrace(); -} -``` diff --git a/programming-old/android/api-reference/document-normalizer-settings.md b/programming-old/android/api-reference/document-normalizer-settings.md deleted file mode 100644 index 023697d..0000000 --- a/programming-old/android/api-reference/document-normalizer-settings.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - DocumentNormalizer Runtime Settings Advanced Methods -description: This page shows DocumentNormalizer advanced runtime settings methods of Dynamsoft Document Normalizer for Android SDK. -keywords: initRuntimeSettingsFromFile, initRuntimeSettingsFromString, outputRuntimeSettingsToFile, outputRuntimeSettings, runtime settings advanced methods, DocumentNormalizer, api reference, android -needAutoGenerateSidebar: true -noTitleIndex: true -permalink: /programming/android/api-reference/document-normalizer-settings.html ---- - -# Runtime Settings Methods - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - - | Method | Description | - |----------------------|-------------| - | [`initRuntimeSettingsFromFile`](#initruntimesettingsfromfile) | Initialize runtime settings with the settings in a given JSON file. | - | [`initRuntimeSettingsFromString`](#initruntimesettingsfromstring) | Initialize runtime settings with the settings in a given JSON string. | - | [`outputRuntimeSettingsToFile`](#outputruntimesettingstofile) | Output runtime settings to a settings file (JSON file). | - | [`outputRuntimeSettings`](#outputruntimesettings) | Output runtime settings to a string. | - - --- - -## initRuntimeSettingsFromFile - -Initialize runtime settings from a given JSON file. - -```java -void initRuntimeSettingsFromFile(String filePath) throws DocumentNormalizerException -``` - -**Parameters** - -`[in] filePath`: The path of the settings file. - -**Exceptions** - -[`DocumentNormalizerException`](document-normalizer-exception.md) - -**Code Snippet** - -```java -DocumentNormalizer reader = new DocumentNormalizer(); -reader.initRuntimeSettingsFromFile("your template file path"); -``` - -## initRuntimeSettingsFromString - -Initialize runtime settings from a given JSON string. - -```java -void initRuntimeSettingsFromString(String content)throws DocumentNormalizerException -``` - -**Parameters** - -`[in] content`: A JSON string that represents the content of the settings. - -**Exceptions** - -[`DocumentNormalizerException`](document-normalizer-exception.md) - -**Code Snippet** - -```java -DocumentNormalizer reader = new DocumentNormalizer(); -reader.initRuntimeSettingsFromString("{\"Version\":\"3.0\", \"ImageParameter\":{\"Name\":\"IP1\"}}"); -``` - -## outputRuntimeSettingsToFile - -Output runtime settings to a settings file (JSON file). - -```java -void outputRuntimeSettingsToFile(String filePath, String settingsName) throws DocumentNormalizerException -``` - -**Parameters** - -`[in] filePath`: The output file path which stores runtime settings. -`[in] settingsName`: A unique name for declaring runtime settings. - -**Exceptions** - -[`DocumentNormalizerException`](document-normalizer-exception.md) - -**Code Snippet** - -```java -DocumentNormalizer reader = new DocumentNormalizer(); -reader.outputRuntimeSettingsToFile("your saving file path", ""); -``` - -## outputRuntimeSettings - -Output runtime settings to a JSON string. - -```java -String outputRuntimeSettings(String settingsName) throws DocumentNormalizerException -``` - -**Parameters** - -`[in] settingsName`: A unique name for declaring runtime settings. - -**Return Value** - -The output JSON string which stores the contents of runtime settings. - -**Code Snippet** - -```java -DocumentNormalizer reader = new DocumentNormalizer(); -String settingStr = reader.outputRuntimeSettings(""); -``` diff --git a/programming-old/android/api-reference/document-normalizer-video-v1.0.0.md b/programming-old/android/api-reference/document-normalizer-video-v1.0.0.md deleted file mode 100644 index f01a0e0..0000000 --- a/programming-old/android/api-reference/document-normalizer-video-v1.0.0.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - Camera Methods -description: This page shows Camera methods of Dynamsoft Document Normalizer for Android SDK. -keywords: Camera methods, DocumentNormalizer, api reference, android -needAutoGenerateSidebar: true -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/android/api-reference/document-normalizer-video-v1.0.0.html ---- - - -# Video Detecting Methods - -> Note: -> -> - You have to include `CameraEnhancer` when using **Video Detecting Methods**. -> - `CameraEnhancer` provide APIs that help you quickly deploy a camera module and capture video streaming for document normalizer. -> - Through **Video Detecting Methods** you can control whether to start video streaming document detecting and get the detection results. - -| Method | Description | -|--------|-------------| -| [`setCameraEnhancer`](#setcameraenhancer) | Bind a Camera Enhancer instance to the Document Normalizer. | -| [`startDetecting`](#startdetecting) | Start the document quad detection thread in the video streaming scenario. | -| [`stopDetecting`](#stopdetecting) | Stop the document quad detection thread in the video streaming scenario. | -| [`setDetectResultListener`](#setdetectresultlistener) | Set callback interface to process detection results generated during frame detecting. | - ---- - -## setCameraEnhancer - -Bind a `Dynamsoft Camera Enhancer` instance to the Document Normalizer. `Dynamsoft Camera Enhancer` is designed for video streaming processing scenarios. It can help the Document Normalizer to acquire video frames continuously for video streaming document normalizer. - -```java -void setCameraEnhancer(CameraEnhancer mCameraEnhancer) -``` - -**Parameters** - -`[in] mCameraEnhancer`: An instance of `Dynamsoft Camera Enhancer`. - -**Code Snippet** - -This code snippet displays a complete code on how to add CameraEnhancer to your project and start detecting and get detection results from the video streaming. - -```java -DocumentNormalizer normalizer; -CameraEnhancer mCameraEnhancer; - -@Override -protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - setContentView(R.layout.activity_main); - - // Be sure that you have added a cameraView in the layout file. - DCECameraView cameraView = findViewById(R.id.cameraView); - - try { - // Create an instance of Dynamsoft Document Normalizer. - normalizer = new DocumentNormalizer(); - } catch (DocumentNormalizerException e) { - e.printStackTrace(); - } - mCameraEnhancer = new CameraEnhancer(MainActivity.this); - mCameraEnhancer.setCameraView(cameraView); - - // Bind the Camera Enhancer instance to the Document Normalizer instance. - normalizer.setCameraEnhancer(mCameraEnhancer); - - // Result callback configurations - DetectResultListener mDetectResultListener = new DetectResultListener() { - // Obtain the detected quad detection results and display. - @Override - public void detectResultCallback(int id, ImageData imageData, DetectedQuadResult[] detectedResults) { - // Add your code to execute when quad detection results are returned. - } - }; - - normalizer.setDetectResultListener(mDetectResultListener); -} - -@Override -public void onResume() { - // Open the camera and start video quad detecting - try { - mCameraEnhancer.open(); - } catch (CameraEnhancerException e) { - e.printStackTrace(); - } - normalizer.startDetecting(); - super.onResume(); -} - -@Override -public void onPause() { - // Stop video quad detecting - try { - mCameraEnhancer.close(); - } catch (CameraEnhancerException e) { - e.printStackTrace(); - } - normalizer.stopDetecting(); - super.onPause(); -} -``` - -## startDetecting - -Start the document quad detection thread in the video streaming scenario. Please be sure that you have bound a Camera Enhancer to the document normalizer before you trigger `startDetecting`. - -```java -void startDetecting() -``` - -**Code Snippet** - -You can view the complete code snippet in [`setCameraEnhancer`](#setcameraenhancer). - -## stopDetecting - -Stop the document quad detection thread in the video streaming scenario. - -```java -void stopDetecting() -``` - -**Code Snippet** - -You can view the complete code snippet in [`setCameraEnhancer`](#setcameraenhancer). - -## setDetectResultListener - -Set the callback interface to process detection results generated during frame detecting. - -```java -void setDetectResultListener(DetectResultListener detectResultListener) -``` - -**Parameters** - -`[in] detectResultListener`: The Callback interface. - -**Code Snippet** - -You can view the complete code snippet in [`setCameraEnhancer`](#setcameraenhancer). diff --git a/programming-old/android/api-reference/document-normalizer-video.md b/programming-old/android/api-reference/document-normalizer-video.md deleted file mode 100644 index 984f1fb..0000000 --- a/programming-old/android/api-reference/document-normalizer-video.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - Camera Methods -description: This page shows Camera methods of Dynamsoft Document Normalizer for Android SDK. -keywords: Camera methods, DocumentNormalizer, api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/android/api-reference/document-normalizer-video.html ---- - - -# Video Detecting Methods - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -## How to Implement Video Detecting - -This code snippet displays a complete code on how to configure camera module, start detecting and get detection results from the video streaming. - -```java -DocumentNormalizer normalizer; -CameraEnhancer mCameraEnhancer; - -@Override -protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - setContentView(R.layout.activity_main); - - // Be sure that you have added a cameraView in the layout file. - DCECameraView cameraView = findViewById(R.id.cameraView); - - try { - // Create an instance of Dynamsoft Document Normalizer. - normalizer = new DocumentNormalizer(); - } catch (DocumentNormalizerException e) { - e.printStackTrace(); - } - mCameraEnhancer = new CameraEnhancer(MainActivity.this); - mCameraEnhancer.setCameraView(cameraView); - - // Bind the Camera Enhancer instance to the Document Normalizer instance. - normalizer.setImageSource(mCameraEnhancer); - - // Result callback configurations - DetectResultListener mDetectResultListener = new DetectResultListener() { - // Obtain the detected quad detection results and display. - @Override - public void detectResultCallback(int id, ImageData imageData, DetectedQuadResult[] detectedResults) { - // Add your code to execute when quad detection results are returned. - } - }; - - normalizer.setDetectResultListener(mDetectResultListener); -} - -@Override -public void onResume() { - // Open the camera and start video quad detecting - try { - mCameraEnhancer.open(); - } catch (CameraEnhancerException e) { - e.printStackTrace(); - } - normalizer.startDetecting(); - super.onResume(); -} - -@Override -public void onPause() { - // Stop video quad detecting - try { - mCameraEnhancer.close(); - } catch (CameraEnhancerException e) { - e.printStackTrace(); - } - normalizer.stopDetecting(); - super.onPause(); -} -``` - -> Note: -> -> - `DynamsoftCameraEnhancer` library is included when implementing **Video Quad Detecting**. It provides APIs that help you quickly deploy a camera module and capture video streaming for document normalizer. - -## Methods - -Use the following methods to control the start/stop of video streaming document detecting and get the detection results. - -| Method | Description | -|--------|-------------| -| [`setImageSource`](#setimagesource) | Sets an instance of ImageSource to get images. | -| [`startDetecting`](#startdetecting) | Start the document quad detection thread in the video streaming scenario. | -| [`stopDetecting`](#stopdetecting) | Stop the document quad detection thread in the video streaming scenario. | -| [`setDetectResultListener`](#setdetectresultlistener) | Set callback interface to process detection results generated during frame detecting. | - ---- - -### setImageSource - -Sets an instance of ImageSource to get images. `CameraEnhancer` is a specific implementation of ImageSource, which can help the Document Normalizer to acquire video frames continuously for recognition. - -```java -void setImageSource(ImageSource source) -``` - -**Parameters** - -`[in] source`: An instance of ImageSource. If you are using `Dynamsoft Camera Enhancer`(DCE) to capture camera frames, pass an instance of `CameraEnhancer`. - -**Code Snippet** - -```java -// Create an instance of DynamsoftCameraEnhancer and set it as the image source. -DCECameraView cameraView = findViewById(R.id.cameraView); -CameraEnhancer mCameraEnhancer; = new CameraEnhancer(MainActivity.this); -mCameraEnhancer.setCameraView(cameraView); -normalizer.setImageSource(mCameraEnhancer); -``` - -### startDetecting - -Start the document quad detection thread in the video streaming scenario. Please be sure that you have bound a Camera Enhancer to the document normalizer before you trigger `startDetecting`. - -```java -void startDetecting() -``` - -**Code Snippet** - -```java -normalizer.startDetecting(); -``` - -### stopDetecting - -Stop the document quad detection thread in the video streaming scenario. - -```java -void stopDetecting() -``` - -**Code Snippet** - -```java -normalizer.startDetecting(); -``` - -### setDetectResultListener - -Set the callback interface to process detection results generated during frame detecting. - -```java -void setDetectResultListener(DetectResultListener detectResultListener) -``` - -**Parameters** - -`[in] detectResultListener`: The Callback interface. - -**Code Snippet** - -```java -// Result callback configurations -DetectResultListener mDetectResultListener = new DetectResultListener() { - // Obtain the detected quad detection results and display. - @Override - public void detectResultCallback(int id, ImageData imageData, DetectedQuadResult[] detectedResults) { - // Add your code to execute when quad detection results are returned. - } -}; -normalizer.setDetectResultListener(mDetectResultListener); -``` diff --git a/programming-old/android/api-reference/image-data-v1.0.0.md b/programming-old/android/api-reference/image-data-v1.0.0.md deleted file mode 100644 index 8be10f1..0000000 --- a/programming-old/android/api-reference/image-data-v1.0.0.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Java Class - ImageData -description: This page shows the ImageData Class of Dynamsoft Core Android Edition v2.x. -keywords: ImageData, java -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference/image-data-v1.0.0.html ---- - -# ImageData - -Stores the image data. - -```java -class com.dynamsoft.core.ImageData -``` - -## Attributes - -| Attribute | Type | Description | -|---------- | ---- | ----------- | -| [`bytes`](#bytes) | *byte[]* | The array of bytes that stores the pixel buffer of the image. | -| [`width`](#width) | *int* | The width of the image in pixels. | -| [`height`](#height) | *int* | The height of the image in pixels. | -| [`stride`](#stride) | *int* | The stride is measured by the byte length of each line in the pixel buffer. | -| [`format`](#format) | *int* | The image pixel format used in the image byte array. View [`EnumImagePixelFormat`]({{ site.enumerations }}image-pixel-format.html?src=android) for all supported image pixel formats. | - -  - -### bytes - -The image data content in a byte array. - -```java -byte[] bytes -``` - -  - -### width - -The width of the image in pixels. - -```java -int width -``` - -  - -### height - -The height of the image in pixels. - -```java -int height -``` - -  - -### stride - -The stride (or scan width) of the image. - -```java -int stride -``` - -  - -### format - -The image pixel format used in the image byte array. - -```java -int format -``` - -## Methods - -| Method | Description | -| ------ | ----------- | -| `toBitmap` | Convert the `ImageData` object to a `Bitmap` object. | - -### toBitmap - -Convert the `ImageData` object to a `Bitmap` object. - -```java -Bitmap toBitmap() throws CoreException -``` - -**Return Value** - -A Bitmap object. diff --git a/programming-old/android/api-reference/image-data.md b/programming-old/android/api-reference/image-data.md deleted file mode 100644 index b0db9a0..0000000 --- a/programming-old/android/api-reference/image-data.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Java Class - ImageData -description: This page shows the ImageData Class of Dynamsoft Core Android edition v2.x. -keywords: ImageData, java -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference/image-data.html ---- - -# ImageData - -Stores the image data. - -```java -class com.dynamsoft.core.ImageData -``` - -## Attributes - -| Attribute | Type | Description | -|---------- | ---- | ----------- | -| [`bytes`](#bytes) | *byte[]* | The array of bytes that stores the pixel buffer of the image. | -| [`width`](#width) | *int* | The width of the image in pixels. | -| [`height`](#height) | *int* | The height of the image in pixels. | -| [`stride`](#stride) | *int* | The stride is measured by the byte length of each line in the pixel buffer. | -| [`format`](#format) | *int* | The image pixel format used in the image byte array. View [`EnumImagePixelFormat`]({{ site.enumerations }}image-pixel-format.html?src=android) for all supported image pixel formats. | -| [`orientation`](#orientation) | *int* | The orientation of the image buffer contained in this frame data. | - -## Methods - -| Method | Description | -| ------ | ----------- | -| [`toBitmap`](#tobitmap) | Convert the `ImageData` object to a `Bitmap` object. | - -  - -### bytes - -The image data content in a byte array. - -```java -byte[] bytes -``` - -  - -### width - -The width of the image in pixels. - -```java -int width -``` - -  - -### height - -The height of the image in pixels. - -```java -int height -``` - -  - -### stride - -The stride (or scan width) of the image. - -```java -int stride -``` - -  - -### format - -The image pixel format used in the image byte array. - -```java -int format -``` - -### orientation - -The orientation of the image buffer contained in this frame data. The value is the angle that the camera image needs to be rotated clockwise so it shows correctly on the display in its natural orientation. It is 0, 90, 180, or 270. A typical value for this is 90 as most camera modules record the frames in landscape right orientation. Rotating a landscape right frame by 90 degrees will show it correctly on the display in portrait orientation (which is the natural device orientation of most phones). - -```java -int orientation -``` - -### toBitmap - -Convert the `ImageData` object to a `Bitmap` object. - -```java -Bitmap toBitmap() throws CoreException -``` - -**Return Value** - -A Bitmap object. diff --git a/programming-old/android/api-reference/index-v1.0.0.md b/programming-old/android/api-reference/index-v1.0.0.md deleted file mode 100644 index 3bce607..0000000 --- a/programming-old/android/api-reference/index-v1.0.0.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - Main Page -description: This is the main page of Dynamsoft Document Normalizer for Android SDK API Reference. -keywords: api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -breadcrumbText: Android API Reference -noTitleIndex: true -permalink: /programming/android/api-reference/index-v1.0.0.html ---- - -# API Reference - Android - -## DocumentNormalizer Class - -This is the main class of Dynamsoft Document Normalizer(DDN) SDK. It supports quad detection and image normalization for still pictures and live video. - -Common detections include: - -- Document boundary detection -- Table boundary detection - -Common normalizations include: - -- Border crop -- Deskew -- Perspective correction -- Colour mode -- Brightness and Contrast - -```java -class com.dynamsoft.ddn.DocumentNormalizer -``` - -### Initialize Methods - - | Method | Description | - |----------------------|-------------| - | [`DocumentNormalizer`](document-normalizer-init.md#documentnormalizer) | Initialization of `DocumentNormalizer` object.| - -### Video Detecting Methods - - | Method | Description | - |----------------------|-------------| - | [`setCameraEnhancer`](document-normalizer-video.md#setcameraenhancer) | Bind a Camera Enhancer instance to the Document Normalizer. | - | [`startDetecting`](document-normalizer-video.md#startdetecting) | Start the document quad detection thread in the video streaming scenario. | - | [`stopDetecting`](document-normalizer-video.md#stopdetecting) | Stop the document quad detection thread in the video streaming scenario. | - | [`setDetectResultListener`](document-normalizer-video.md#setdetectresultlistener) | Set callback interface to process detection results generated during frame detecting. | - -### Detect and Normalize Methods - - | Method | Description | - |----------------------|-------------| - | [`detectQuad(buffer)`](document-normalizer-normalizing.md#detectquadbuffer) | Detect quad from the memory buffer containing image pixels in defined format. | - | [`detectQuad(file)`](document-normalizer-normalizing.md#detectquadfile) | Detect quad from an image file. | - | [`detectQuad(bitmap)`](document-normalizer-normalizing.md#detectquadbitmap) | Detect quad from a buffered image(bitmap). | - | [`normalize(buffer)`](document-normalizer-normalizing.md#normalizebuffer) | Normalize image from the memory buffer containing image pixels in defined format. | - | [`normalize(file)`](document-normalizer-normalizing.md#normalizefile) | Normalize an image file. | - | [`normalize(bitmap)`](document-normalizer-normalizing.md#normalizebitmap) | Normalize a buffered image(bitmap). | - -### Runtime Settings Methods - - | Method | Description | - |----------------------|-------------| - | [`initRuntimeSettingsFromFile`](document-normalizer-settings.md#initruntimesettingsfromfile) | Initialize runtime settings with the settings in a given JSON file. | - | [`initRuntimeSettingsFromString`](document-normalizer-settings.md#initruntimesettingsfromstring) | Initialize runtime settings with the settings in a given JSON string. | - | [`outputRuntimeSettingsToFile`](document-normalizer-settings.md#outputruntimesettingstofile) | Output runtime settings to a settings file (JSON file). | - | [`outputRuntimeSettings`](document-normalizer-settings.md#outputruntimesettings) | Output runtime settings to a string. | - -### General Methods - - | Method | Description | - |----------------------|-------------| - | [`getVersion`](document-normalizer-general.md#getversion) | Get version information of SDK.| - -## Auxiliary Classes - -- [`Quadrilateral`](quadrilateral.md) -- [`ImageData`](image-data.md) -- [`LicenseManager`](license-manager.md) -- [`DetectedQuadResult`](detected-quad-result.md) -- [`NormalizedImageResult`](normalized-image-result.md) -- [`DocumentNormalizerException`](document-normalizer-exception.md) - -## Interfaces - -- [`LicenseVerificationListener`](license-verification-listener.md) -- [`DetectResultListener`](detect-result-listener.md) - -## Enumerations - -- [`EnumImagePixelFormat`]({{ site.enumerations }}image-pixel-format.html?src=android) - -## Others - -View the [Error Codes]({{ site.enumerations }}error-code.html) diff --git a/programming-old/android/api-reference/index-v1.0.30.md b/programming-old/android/api-reference/index-v1.0.30.md deleted file mode 100644 index 28b50df..0000000 --- a/programming-old/android/api-reference/index-v1.0.30.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - Main Page -description: This is the main page of Dynamsoft Document Normalizer for Android SDK API Reference. -keywords: api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -breadcrumbText: Android API Reference -noTitleIndex: true -permalink: /programming/android/api-reference/index-v1.0.30.html ---- - -# API Reference - Android - -## DocumentNormalizer Class - -This is the main class of Dynamsoft Document Normalizer(DDN) SDK. It supports quad detection and image normalization for still pictures and live video. - -Common detections include: - -- Document boundary detection -- Table boundary detection - -Common normalizations include: - -- Border crop -- Deskew -- Perspective correction -- Colour mode -- Brightness and Contrast - -```java -class com.dynamsoft.ddn.DocumentNormalizer -``` - -### Initialize Methods - - | Method | Description | - |----------------------|-------------| - | [`DocumentNormalizer`](document-normalizer-init.md#documentnormalizer) | Initialization of `DocumentNormalizer` object.| - -### Video Detecting Methods - - | Method | Description | - |----------------------|-------------| - | [`setImageSource`](document-normalizer-video.md#setimagesource) | Sets an instance of ImageSource to get images. | - | [`startDetecting`](document-normalizer-video.md#startdetecting) | Start the document quad detection thread in the video streaming scenario. | - | [`stopDetecting`](document-normalizer-video.md#stopdetecting) | Stop the document quad detection thread in the video streaming scenario. | - | [`setDetectResultListener`](document-normalizer-video.md#setdetectresultlistener) | Set callback interface to process detection results generated during frame detecting. | - -### Detect and Normalize Methods - - | Method | Description | - |----------------------|-------------| - | [`detectQuad(buffer)`](document-normalizer-normalizing.md#detectquadbuffer) | Detect quad from the memory buffer containing image pixels in defined format. | - | [`detectQuad(file)`](document-normalizer-normalizing.md#detectquadfile) | Detect quad from an image file. | - | [`detectQuad(bitmap)`](document-normalizer-normalizing.md#detectquadbitmap) | Detect quad from a buffered image(bitmap). | - | [`normalize(buffer)`](document-normalizer-normalizing.md#normalizebuffer) | Normalize image from the memory buffer containing image pixels in defined format. | - | [`normalize(file)`](document-normalizer-normalizing.md#normalizefile) | Normalize an image file. | - | [`normalize(bitmap)`](document-normalizer-normalizing.md#normalizebitmap) | Normalize a buffered image(bitmap). | - -### Runtime Settings Methods - - | Method | Description | - |----------------------|-------------| - | [`initRuntimeSettingsFromFile`](document-normalizer-settings.md#initruntimesettingsfromfile) | Initialize runtime settings with the settings in a given JSON file. | - | [`initRuntimeSettingsFromString`](document-normalizer-settings.md#initruntimesettingsfromstring) | Initialize runtime settings with the settings in a given JSON string. | - | [`outputRuntimeSettingsToFile`](document-normalizer-settings.md#outputruntimesettingstofile) | Output runtime settings to a settings file (JSON file). | - | [`outputRuntimeSettings`](document-normalizer-settings.md#outputruntimesettings) | Output runtime settings to a string. | - -### General Methods - - | Method | Description | - |----------------------|-------------| - | [`getVersion`](document-normalizer-general.md#getversion) | Get version information of SDK.| - -## Auxiliary Classes - -- [`Quadrilateral`](quadrilateral.md) -- [`ImageData`](image-data.md) -- [`LicenseManager`](license-manager.md) -- [`DetectedQuadResult`](detected-quad-result.md) -- [`NormalizedImageResult`](normalized-image-result.md) -- [`DocumentNormalizerException`](document-normalizer-exception.md) - -## Interfaces - -- [`LicenseVerificationListener`](license-verification-listener.md) -- [`DetectResultListener`](detect-result-listener.md) - -## Enumerations - -- [`EnumImagePixelFormat`]({{ site.enumerations }}image-pixel-format.html?src=android) - -## Others - -View the [Error Codes]({{ site.enumerations }}error-code.html) diff --git a/programming-old/android/api-reference/interface-index.md b/programming-old/android/api-reference/interface-index.md deleted file mode 100644 index 60ab0e5..0000000 --- a/programming-old/android/api-reference/interface-index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - Interface -description: This page shows all interfaces of Dynamsoft Document Normalizer for Android SDK. -keywords: DetectResultListener, LicenseVerificationListener, interface, api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: false -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/android/api-reference/interface-index.html ---- - -# Interfaces - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -- [`LicenseVerificationListener`](license-verification-listener.md) -- [`DetectResultListener`](detect-result-listener.md) diff --git a/programming-old/android/api-reference/license-manager.md b/programming-old/android/api-reference/license-manager.md deleted file mode 100644 index 0c9b5b7..0000000 --- a/programming-old/android/api-reference/license-manager.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - LicenseManager class -description: This page shows LicenseManager class of Dynamsoft Document Normalizer for Android SDK. -keywords: initLicense, LicenseManager, DocumentNormalizer, api reference, android -needAutoGenerateSidebar: true -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/android/api-reference/license-manager.html ---- - -# LicenseManager - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -The LicenseManager class unlocks the Dynamsoft SDK with a purchased full license or a provided trial license to allow you to develop your application. - -```java -class com.dynamsoft.core.LicenseManager -``` - -## Methods - - | Method | Description | - |----------------------|-------------| - | [`initLicense`](#initlicense) | Read the license key and activate the SDK. | - - --- - -### initLicense - -Read the license key and activate the SDK. - -```java -static void initLicense(String license, android.content.Context context, LicenseVerificationListener listener) -``` - -**Parameters** - -`[in] license`: The license key. -`[in] context`: The interface to global information about an application environment. -`[in] listener`: The listener that handles callback when the license server returns. - -**Code Snippet** - -```java -LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", MainActivity.this, new LicenseVerificationListener() { - @Override - public void licenseVerificationCallback(boolean isSuccess, CoreException error) { - if(!isSuccess){ - error.printStackTrace(); - } - } -}); -``` diff --git a/programming-old/android/api-reference/license-verification-listener.md b/programming-old/android/api-reference/license-verification-listener.md deleted file mode 100644 index 5ddb451..0000000 --- a/programming-old/android/api-reference/license-verification-listener.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - Interface LicenseVerificationListener -description: This is the interface LicenseVerificationListener page of Dynamsoft Document Normalizer for Android SDK. -keywords: LicenseVerificationListener, interface, android -needAutoGenerateSidebar: true -needGenerateH3Content: false -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/android/api-reference/license-verification-listener.html ---- - -# LicenseVerificationListener - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -`LicenseVerificationListener` is the interface to handle callback when using [`initLicense`](license-manager.md#initlicense). - -```java -interface com.dynamsoft.core.LicenseVerificationListener -``` - -| Method | Description | -| ------ | ----------- | -| `licenseVerificationCallback` | The callback of license server. | - -## licenseVerificationCallback - -```java -void licenseVerificationCallback(boolean isSuccess, Exception error); -``` - -**Parameters** - -`[in] isSuccess`: Whether the license verification was successful. -`[in] error`: The error message from license server. - -**Code Snippet** - -```java -LicenseVerificationListener licenseListener = new LicenseVerificationListener() { - @Override - public void licenseVerificationCallback(boolean isSuccess, CoreException error) { - // Add your code - } -}; -``` diff --git a/programming-old/android/api-reference/normalized-image-result-v1.0.0.md b/programming-old/android/api-reference/normalized-image-result-v1.0.0.md deleted file mode 100644 index 5bae574..0000000 --- a/programming-old/android/api-reference/normalized-image-result-v1.0.0.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - NormalizedImageResult Class -description: This page shows the NormalizedImageResult Class of Dynamsoft Document Normalizer for Android SDK. -keywords: NormalizedImageResult, class, api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference/normalized-image-result-v1.0.0.html ---- - -# NormalizedImageResult - -Stores the detected quad result. - -```java -class com.dynamsoft.ddn.NormalizedImageResult; -``` - -| Attribute | Type | Descriptions | -| --------- | ---- | ------------ | -| [`image`](#image) | [`ImageData`](image-data.md) | The normalized image in ImageData structure. | - -## image - -The location of the detected quad result. - -```java -ImageData image; -``` diff --git a/programming-old/android/api-reference/normalized-image-result.md b/programming-old/android/api-reference/normalized-image-result.md deleted file mode 100644 index 42b65f9..0000000 --- a/programming-old/android/api-reference/normalized-image-result.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - NormalizedImageResult Class -description: This page shows the NormalizedImageResult Class of Dynamsoft Document Normalizer for Android SDK. -keywords: NormalizedImageResult, class, api reference, android -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference/normalized-image-result.html ---- - -# NormalizedImageResult - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -Stores the detected quad result. - -```java -class com.dynamsoft.ddn.NormalizedImageResult; -``` - -| Attribute | Type | Descriptions | -| --------- | ---- | ------------ | -| [`image`](#image) | [`ImageData`](image-data.md) | The normalized image in ImageData structure. | - -| Method | Descriptions | -| -------|------------ | -| [`saveToFile`](#savetofile) | Save the normalized image to a file. | - -## image - -The location of the detected quad result. - -```java -ImageData image; -``` - -## saveToFile - -Save the normalized image to a file. - -```java -void saveToFile(String filePath) throws DocumentNormalizerException -``` - -**Parameters** - -`[in] filePath`: The output file path of the normalized image. - -**Remarks** - -- This method supports exporting bmp, jpeg, png, pdf formats. -- For non-pdf formats, if the file path already exists, this method will overwrite the existing file -- For pdf format, if the file path already exists, this method will append a new page with the image to the existing pdf file. diff --git a/programming-old/android/api-reference/quadrilateral.md b/programming-old/android/api-reference/quadrilateral.md deleted file mode 100644 index d9cacef..0000000 --- a/programming-old/android/api-reference/quadrilateral.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Core Java Class - Quadrilateral -description: This page shows the Quadrilateral Class of Dynamsoft Document Normalizer Android edition v1.x. -keywords: Quadrilateral, java -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/android/api-reference/quadrilateral.html ---- - - -# Quadrilateral - -> You are viewing a history document page of Dynamsoft Document Normalizer v1.0.30. - -Stores the quadrilateral. - -```java -class com.dynamsoft.core.Quadrilateral -``` - -## Attributes - -| Attribute | Type | -|---------- | ---- | -| [`points`](#points) | `android.graphics.Point[]` | - -  - -### points - -Four vertexes in a clockwise direction of a quadrilateral. Index 0 represents the left-most vertex. - -```java -android.graphics.Point[] points -``` diff --git a/programming-old/android/index-v1.0.30.md b/programming-old/android/index-v1.0.30.md deleted file mode 100644 index 193dfa3..0000000 --- a/programming-old/android/index-v1.0.30.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for Android - Main Page -description: This is the main page of Dynamsoft Document Normalizer for Android SDK. -keywords: android -needAutoGenerateSidebar: false -breadcrumbText: Android -permalink: /programming/android/index-v1.0.30.html ---- - -# Documentation - Android - -Welcome to the Dynamsoft Document Normalizer Android SDK documentation. - -## Getting Started - -- [User Guide for Android](user-guide.html) - -## Samples and Demos - -- [Samples](samples/index.html) - - [HelloWorld](samples/helloworld.html) - -## API Reference - -- [class DocumentNormalizer](api-reference/document-normalizer-index.html) -- [Auxiliary classes](api-reference/auxiliary-index.html) -- [Interfaces](api-reference/interface-index.html) - -## Release Notes - -- [Version 1.x](release-notes/android-1.html) diff --git a/programming-old/android/release-notes/android-1.md b/programming-old/android/release-notes/android-1.md deleted file mode 100644 index 95acb14..0000000 --- a/programming-old/android/release-notes/android-1.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for Android SDK - Release Notes v7.6.1 and below -description: This is the release notes page of Dynamsoft Document Normalizer for Android SDK v7.6.1 and below. -keywords: release notes, android, -needAutoGenerateSidebar: true -needGenerateH3Content: false -noTitleIndex: true -permalink: /programming/android/release-notes/android-1.html ---- - -# Release Notes for Android SDK - v1.x - -## 1.0.30 (06/07/2023) - -### Fixed - -- Fixed a bug where document boundary might not be detected when scanning from the video streaming. - -## 1.0.21 (02/15/2023) - -### Fixed - -- Fixed a crash bug that might happen when triggering method [`toBitmap`](../api-reference/image-data.md#tobitmap). - -## 1.0.20 (02/02/2023) - -### Fixed - -- Fixed a bug that the colours of binarized images might be inverted when using [`LEM_MARGIN_BASED`]({{site.parameters}}reference/line-extraction-modes.html) mode for `LineExtractionModes`. -- Fixed a bug where the normalized image may have black borders when setting [`ColourMode`]({{site.parameters}}reference/colour-mode.html) of `NormalizerParameter` to `ICM_BINARY`. - -## 1.0.10 (09/29/2022) - -### New - -- Added a new method [`setImageSource`](../api-reference/document-normalizer-video.md#setimagesource) in `DocumentNormalizer` class to set up image source. -- Added a new method [`saveToFile`](../api-reference/normalized-image-result.md#savetofile) in class `NormalizedImageResult` to support saving the normalized image as a BMP/JPEG/PNG/PDF file. -- Added a new property [`orientation`](../api-reference/image-data.md#orientation) in class `ImageData`. - -### Changed - -- Updated [ErrorCode](../../enumerations/error-code.md) - - Added `DMERR_IMAGE_ORIENTATION_INVALID` (-10060). - - Change the value of `DDNERR_CONTENT_NOT_FOUND` from -10056 to -50001. - - Renamed `DDNERR_QUADRILATERAL_INVALID` to `DMERR_QUADRILATERAL_INVALID`. - -### Deprecated - -- Deprecated `setCameraEnhancer`. - -## 1.0.0 (06/21/2022) - -### Highlights - -{%- include release-notes/product-highlight-1.0.0.md -%} diff --git a/programming-old/android/samples/helloworld-v1.0.30.md b/programming-old/android/samples/helloworld-v1.0.30.md deleted file mode 100644 index 9c1f94f..0000000 --- a/programming-old/android/samples/helloworld-v1.0.30.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for Android - HelloWorld Sample -description: This is the HelloWorld Sample page of Dynamsoft Document Normalizer for Android SDK. -keywords: android, samples, HelloWorld -needAutoGenerateSidebar: false -breadcrumbText: HelloWorld -permalink: /programming/android/samples/helloworld-v1.0.30.html ---- - -# HelloWorld Sample - -The Android Helloworld sample illustrates how to create the simplest video streaming document normalizing app with Dynamsoft Document Normalizer (DDN) Android SDK. - -View the samples - -- Java (Android) HelloWorld - -For more details about how to get started with Dynamsoft Document Normalizer, please view the [user guide]({{ site.android }}user-guide.html). diff --git a/programming-old/android/samples/index-v1.0.30.md b/programming-old/android/samples/index-v1.0.30.md deleted file mode 100644 index 717c252..0000000 --- a/programming-old/android/samples/index-v1.0.30.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for Android - Demos & Samples -description: This is the Demos & Samples page of Dynamsoft Document Normalizer for Android SDK. -keywords: Android, samples -needAutoGenerateSidebar: true -breadcrumbText: Samples -permalink: /programming/android/samples/index-v1.0.30.html ---- - -# Demo and Samples - -## Samples - -| Sample Name | Description | -| ----------- | ----------- | -| [HelloWorld](helloworld.md) | The simplest video streaming document normalizer. | - - -Before you start viewing the samples, the following concepts may help you understand how to get started with Dynamsoft Document Normalizer. - -### License - -A network connection is required to verify the trial license in the samples. You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=ddn&utm_source=docs&package=android){:target="_blank"} link. If you download the [Installation Package](https://www.dynamsoft.com/document-normalizer/downloads/?product=ddn&utm_source=docs&package=android), it comes with a 30-day trial license by default. - -### Video Document Normalizing - -Most of the Dynamsoft Document Normalizer mobile samples are designed for video document normalizing. Dynamsoft Camera Enhancer (DCE) is applied to the video document scanning samples. The following features in the samples are powered by DCE: - -- Capture video frames for quadrilateral area detecting. -- Create a `Camera View` for displaying the video streaming and highlighting the real-time detected quadrilaterals. -- Create an `Image Editor View` for quadrilateral boundary editing. - -View the [API reference](../api-reference/camera-enhancer/index.md) for more details. diff --git a/programming-old/android/user-guide-v1.0.0.md b/programming-old/android/user-guide-v1.0.0.md deleted file mode 100644 index ad7b1bc..0000000 --- a/programming-old/android/user-guide-v1.0.0.md +++ /dev/null @@ -1,470 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for Android - User Guide -description: This is the user guide of Dynamsoft Document Normalizer for Android SDK. -keywords: user guide, android -needAutoGenerateSidebar: true -needGenerateH4Content: true -noTitleIndex: true -permalink: /programming/android/user-guide-v1.0.0.html ---- - -# Getting Started with Android - -## Requirements - -- Supported OS: Android 5.0 (API Level 21) or higher. -- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**. -- Development Environment: Android Studio 3.4+ (Android Studio 4.2+ recommended). - -## Build Your First Application - -In this section, let's see how to create a HelloWorld app for normalizing documents from camera video input. - ->Note: -> ->- Android Studio 4.2 is used here in this guide. ->- You can [get the source code of the HelloWorld app here](https://github.com/Dynamsoft/document-normalizer-mobile-samples/tree/main/android/java/HelloWorld). - -### Create a New Project - -1. Open Android Studio, select **File > New > New Project**. - -2. Choose the correct template for your project. In this sample, we use **Empty Activity**. - -3. When prompted, choose your app name 'HelloWorld' and set the **Save** location, **Language**, and **Minimum SDK** (we use 21 here). - > Note: - > - > - With **minSdkVersion** set to 21, your app is compatible with more than 94.1% of devices on the Google Play Store (last update: March 2021). - -### Add the SDK - -There are two ways to add the SDK into your project - **Manually** and **Maven**. - -#### Add the Library Manually - -1. Download the SDK package from the Dynamsoft website. After unzipping, You can find the following **aar** files under the **DynamsoftDocumentNormalizer\Libs** directory: - - | File | Description | - |---------|-------------| - | `DynamsoftDocumentNormalizer.aar` | The Dynamsoft Document Normalizer SDK, including document normalizer related APIs. | - | `DynamsoftCore.aar` | The core library of Dynamsoft's capture vision SDKs, including common basic structure and license related APIs. | - | `DynamsoftIntermediateResult.aar` | The common intermediate result library of Dynamsoft's capture vision SDKs, including all intermediate results produced in the process of decoding a barcode, recognizing a label or normalizing a document. | - | `DynamsoftImageProcessing.aar` | The image processing library of Dynamsoft's capture vision SDKs, including image processing algorithms and APIs. | - | `DynamsoftCameraEnhancer.aar` | The Dynamsoft Camera Enhancer SDK, including camera control and frame preprocessing APIs. | - -2. Copy the above five **aar** files to the target directory `HelloWorld\app\libs` - -3. Open the file `HelloWorld\app\build.gradle` and add reference in the dependencies: - - ```groovy - dependencies { - implementation fileTree(dir: 'libs', include: ['*.aar']) - - def camerax_version = '1.1.0-rc01' - implementation "androidx.camera:camera-core:$camerax_version" - implementation "androidx.camera:camera-camera2:$camerax_version" - implementation "androidx.camera:camera-lifecycle:$camerax_version" - implementation "androidx.camera:camera-view:$camerax_version" - } - ``` - - > Note: - > - > DCE 3.x is based on Android CameraX, so you need to add the CameraX dependency manually. - -4. Click **Sync Now**. After the synchronization completes, the SDK is added to the project. - -#### Add the Library via Maven - -1. Open the file `HelloWorld\app\build.gradle` and add the remote repository: - - ```groovy - repositories { - maven { - url "https://download2.dynamsoft.com/maven/aar" - } - } - ``` - -2. Add reference in the dependencies: - - ```groovy - dependencies { - implementation 'com.dynamsoft:dynamsoftdocumentnormalizer:1.0.0' - implementation 'com.dynamsoft:dynamsoftcameraenhancer:3.0.0' - } - ``` - -3. Click **Sync Now**. After the synchronization completes, the SDK is added to the project. - -### MainActivity for Realtime Detection of Quads - -#### Initialize License - -1. Import the `LicenseManager` class and initialize the license in the file `MainActivity.java`. - - ```java - import com.dynamsoft.core.LicenseManager; - import com.dynamsoft.core.LicenseVerificationListener; - import com.dynamsoft.core.CoreException; - - public class MainActivity extends AppCompatActivity { - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - setContentView(R.layout.activity_main); - - LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", MainActivity.this, new LicenseVerificationListener() { - @Override - public void licenseVerificationCallback(boolean isSuccess, CoreException error) { - if(!isSuccess){ - error.printStackTrace(); - } - } - }); - } - } - ``` - - >Note: - > - >- Network connection is required for the license to work. - >- The license string here will grant you a time-limited trial license. - >- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=ddn&utm_source=guide&package=android){:target="_blank"} link - -#### Initialize Camera Module - -1. In the Project window, open **app > res > layout > `activity_main.xml`** and create a DCE camera view section under the root node. - - ```xml - - - ``` - -2. Import the dynamsoft camera module, initialize the camera view and bind to the created Camera Enhancer instance in the file `MainActivity.java`. - - ```java - ... - - import com.dynamsoft.dce.DCECameraView; - import com.dynamsoft.dce.CameraEnhancer; - import com.dynamsoft.dce.CameraEnhancerException; - - public class MainActivity extends AppCompatActivity { - private CameraEnhancer mCameraEnhancer; - - @Override - protected void onCreate(Bundle savedInstanceState) { - - ... - - DCECameraView cameraView = findViewById(R.id.camera_view); - - mCameraEnhancer = new CameraEnhancer(MainActivity.this); - mCameraEnhancer.setCameraView(cameraView); - } - } - ``` - -#### Initialize Document Normalizer - -1. Import and initialize the document normalizer, bind to the created Camera Enhancer instance. - - ```java - ... - - import com.dynamsoft.ddn.DocumentNormalizer; - import com.dynamsoft.ddn.DocumentNormalizerException; - - public class MainActivity extends AppCompatActivity { - - ... - - public static DocumentNormalizer mNormalizer; - - @Override - protected void onCreate(Bundle savedInstanceState) { - - ... - - try { - mNormalizer = new DocumentNormalizer(); - } catch (DocumentNormalizerException e) { - e.printStackTrace(); - } - - mNormalizer.setCameraEnhancer(mCameraEnhancer); - } - } - ``` - -2. Create a detect result listener and register with the document normalizer instance to get detected quad results. - - ```java - ... - - import com.dynamsoft.core.ImageData; - import com.dynamsoft.ddn.DetectedQuadResult; - import com.dynamsoft.ddn.DetectResultListener; - - public class MainActivity extends AppCompatActivity { - - ... - - public static ImageData mImageData; - public static DetectedQuadResult[] mQuadResults; - private boolean startEditing; - - @Override - protected void onCreate(Bundle savedInstanceState) { - - ... - - mNormalizer.setDetectResultListener(new DetectResultListener() { - @Override - public void detectResultCallback(int id, ImageData imageData, DetectedQuadResult[] results) { - if (results != null && results.length > 0 && startEditing) { - startEditing = false; - - mImageData = imageData; - mQuadResults = results; - - Intent intent = new Intent(MainActivity.this, QuadEditActivity.class); - startActivity(intent); - } - } - }); - } - } - ``` - -3. Override the `MainActivity.onResume` and `MainActivity.onPause` functions to start/stop video quad detecting. After detecting starts, the Document Normalizer will automatically invoke the `detectQuad` API to process the video frames from the Camera Enhancer, then send the detected quad results to the detected result callback. - - ```java - public class MainActivity extends AppCompatActivity { - - ... - - @Override - protected void onResume() { - mNormalizer.startDetecting(); - try { - mCameraEnhancer.open(); - } catch (CameraEnhancerException e) { - e.printStackTrace(); - } - super.onResume(); - } - - - @Override - protected void onPause() { - mNormalizer.stopDetecting(); - try { - mCameraEnhancer.close(); - } catch (CameraEnhancerException e) { - e.printStackTrace(); - } - super.onPause(); - } - } - ``` - -#### Additional Steps in `MainActivity` - -1. In the Project window, open **app > res > layout > `activity_main.xml`**, create a button under the root node to capture the quads detected on the image. - - ```xml - ... - - - - -``` - -In the **.xaml.cs** file, add the following code. You can get `imageData` and `DetectedQuadResult[]` from [`DetectQuad`](document-normalizer.md#detectquadfile) methods or [`IDetectResultListener`](detect-result-listener.md) - -```csharp -namespace DDNDemo -{ - public partial class QuadEditorPage : ContentPage - { - ImageData data; - DetectedQuadResult[] results; - public QuadEditorPage(ImageData imageData, DetectedQuadResult[] results) - { - InitializeComponent(); - data = imageData; - this.results = results; - } - - protected override void OnAppearing() - { - base.OnAppearing(); - if (data != null) { - imageEditor.OriginalImage = data; - } - if (results != null) { - imageEditor.DetectedQuadResults = results; - } - } - - void onNormalizeClicked(object sender, EventArgs e) { - var quad = imageEditor.getSelectedQuadResult(); - var result = App.ddn.Normalize(data, quad); - Navigation.PushAsync(new ResultPage(result.image)); - } - } -} -``` diff --git a/programming-old/xamarin/api-reference/index.md b/programming-old/xamarin/api-reference/index.md deleted file mode 100644 index dd8f18b..0000000 --- a/programming-old/xamarin/api-reference/index.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Xamarin.Forms API Reference - Main Page -description: This is the main page of Dynamsoft Document Normalizer for Xamarin.Forms SDK API Reference. -keywords: api reference, Xamarin.Forms -needAutoGenerateSidebar: true -needGenerateH3Content: true -breadcrumbText: Xamarin.Forms API Reference -noTitleIndex: true -permalink: /programming/xamarin/api-reference/index.html ---- - -# API Reference - Xamarin.Forms - -## namespace DDNXamarin - -### Primary Interfaces - -| Interface | Description | -| --------------- | ----------- | -| [`Interface IDocumentNormalizer`](document-normalizer.md) | The interface that includes document boundary detecting and image normalizing methods. | -| [`Interface ICameraEnhancer`](camera-enhancer.md) | The interface that includes camera control methods. | - -### Auxiliary Classes/Interfaces - -| Class/Interface | Description | -| --------------- | ----------- | -| [`Class Quadrilateral`](quadrilateral.md) | The class that stores the information of quadrilateral coordinates. | -| [`Class ImageData`](image-data.md) | The class that stores image data. | -| [`Class DetectedQuadResult`](detected-quad-result.md) | The class that stores the information of the detected quads. | -| [`Class NormalizedImageResult`](normalized-image-result.md) | The class that stores the information of normalized results. | -| [`Class DCVCameraView`](camera-view.md) | A view class that enables users to display video streaming. | -| [`Class DCVImageEditorView`](image-editor-view.md) | A view class for users to add editable UI elements on a static image. | -| [`Interface ILicenseManager`](license-manager.md) | The interface that includes license activation methods. | -| [`Interface ILicenseVerificationListener`](license-verification-listener.md) | The interface that handles callback when license server returns. | -| [`Interface IDetectResultListener`](detect-result-listener.md) | The interface that handles callback when quad results are detected. | - -### Enumerations - -| Enumeration | Description | -| ----------- | ----------- | -| [`EnumImagePixelFormat`](enum-image-pixel-format.md) | The enumeration that indicates the image pixel format. | - -## namespace DCVXamarin.Droid - -| Class | Description | -| --------------- | ----------- | -| [`Class DocumentNormalizer`](droid-document-normalizer.md) | The class that implements `IDocumentNormalizer` methods on Android end. | -| [`Class CameraEnhancer`](droid-camera-enhancer.md) | The class that implements `ICameraEnhancer` methods on Android end. | -| [`Class LicenseManager`](droid-license-manager.md) | The class that implements `ILicenseManager` methods on Android end. | - -## namespace DCVXamarin.iOS - -| Class | Description | -| --------------- | ----------- | -| [`Class DocumentNormalizer`](ios-document-normalizer.md) | The class that implements `IDocumentNormalizer` methods on iOS end. | -| [`Class CameraEnhancer`](ios-camera-enhancer.md) | The class that implements `ICameraEnhancer` methods on iOS end. | -| [`Class LicenseManager`](ios-license-manager.md) | The class that implements `ILicenseManager` methods on iOS end. | diff --git a/programming-old/xamarin/api-reference/ios-camera-enhancer.md b/programming-old/xamarin/api-reference/ios-camera-enhancer.md deleted file mode 100644 index 82d7321..0000000 --- a/programming-old/xamarin/api-reference/ios-camera-enhancer.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default-layout -title: Class DCVCameraEnhancer (iOS) - Dynamsoft Document Normalizer Xamarin.Forms API Reference -description: This is the page of iOS Class DCVCameraEnhancer of Dynamsoft Document Normalizer Xamarin.Forms SDK. -keywords: initLicense, DCVCameraEnhancer, api reference, Xamarin.Forms -needAutoGenerateSidebar: true -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/xamarin/api-reference/ios-camera-enhancer.html ---- - -# DDNXamarin.iOS.DCVCameraEnhancer - -The class that implements interface [`ICameraEnhancer`](camera-enhancer.md) on iOS end. - -## How to Use - -Add the following code in the **AppDelegate.cs** of your project to implement `ICameraEnhancer` with `DCVCameraEnhancer`. - -```csharp -public override bool FinishedLaunching(UIApplication app, NSDictionary options) -{ - LoadApplication(new App(new DCVCameraEnhancer(), new DCVDocumentNormalizer(), new DCVLicenseManager())); -} -``` - -## Methods Summary - -| Method | Description | -|--------|-------------| -| [`Open`](camera-enhancer.md#open) | Turn on the current selected camera. | -| [`Close`](camera-enhancer.md#close) | Turn off the current selected camera. | -| [`TurnOnTorch`](camera-enhancer.md#turnontorch) | Turn on the torch. | -| [`TurnOffTorch`](camera-enhancer.md#turnofftorch) | Turn off the torch. | diff --git a/programming-old/xamarin/api-reference/ios-document-normalizer.md b/programming-old/xamarin/api-reference/ios-document-normalizer.md deleted file mode 100644 index d9154aa..0000000 --- a/programming-old/xamarin/api-reference/ios-document-normalizer.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default-layout -title: Class DCVDocumentNormalizer (iOS) - Dynamsoft Document Normalizer Xamarin.Forms API Reference -description: This is the page of iOS Class DCVDocumentNormalizer of Dynamsoft Document Normalizer Xamarin.Forms SDK. -keywords: initLicense, DCVDocumentNormalizer, api reference, Xamarin.Forms -needAutoGenerateSidebar: true -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/xamarin/api-reference/ios-document-normalizer.html ---- - -# DDNXamarin.iOS.DCVDocumentNormalizer - -The class that implements interface [`IDocumentNormalizer`](license-manager.md) on iOS end. - -## How to Use - -Add the following code in the **AppDelegate.cs** of your project to implement `IDocumentNormalizer` with `DCVDocumentNormalizer`. - -```csharp -public override bool FinishedLaunching(UIApplication app, NSDictionary options) -{ - LoadApplication(new App(new DCVCameraEnhancer(), new DCVDocumentNormalizer(), new DCVLicenseManager())); -} -``` - -## Methods Summary - -| Method | Description | -|--------|-------------| -| [`SetCameraEnhancer`](document-normalizer.md#setcameraenhancer) | Sets an instance of ImageSource to get images. | -| [`StartDetecting`](document-normalizer.md#startdetecting) | Start the document quad detection thread in the video streaming scenario. | -| [`StopDetecting`](document-normalizer.md#stopdetecting) | Stop the document quad detection thread in the video streaming scenario. | -| [`AddResultListener`](document-normalizer.md#addresultlistener) | Set callback interface to process detection results generated during frame detecting. | -| [`DetectQuad(ImageData)`](document-normalizer.md#detectquadimagedata) | Detect quad from the memory buffer containing image pixels in defined format. | -| [`DetectQuad(File)`](document-normalizer.md#detectquadfile) | Detect quad from an image file. | -| [`Normalize(ImageData)`](document-normalizer.md#normalizeimagedata) | Normalize image from the memory buffer containing image pixels in defined format. | -| [`Normalize(File)`](document-normalizer.md#normalizefile) | Normalize an image file. | -| [`InitRuntimeSettingsFromFile`](document-normalizer.md#initruntimesettingsfromfile) | Initialize runtime settings with the settings in a given JSON file. | -| [`InitRuntimeSettings`](document-normalizer.md#initruntimesettings) | Initialize runtime settings with the settings in a given JSON string. | -| [`OutputRuntimeSettingsToFile`](document-normalizer.md#outputruntimesettingstofile) | Output runtime settings to a settings file (JSON file). | -| [`OutputRuntimeSettings`](document-normalizer.md#outputruntimesettings) | Output runtime settings to a string. | -| [`SaveToFile`](document-normalizer.md#savetofile) | Save a `NormalizedImageResult` to the targeting file path. | -| [`GetVersion`](document-normalizer.md#getversion) | Get version information of SDK. | diff --git a/programming-old/xamarin/api-reference/ios-license-manager.md b/programming-old/xamarin/api-reference/ios-license-manager.md deleted file mode 100644 index 951869c..0000000 --- a/programming-old/xamarin/api-reference/ios-license-manager.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default-layout -title: Class DCVLicenseManager (iOS) - Dynamsoft Document Normalizer Xamarin.Forms API Reference -description: This is the page of iOS Class DCVLicenseManager of Dynamsoft Document Normalizer Xamarin.Forms SDK. -keywords: initLicense, DCVLicenseManager, DocumentNormalizer, api reference, Xamarin.Forms -needAutoGenerateSidebar: true -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/xamarin/api-reference/ios-license-manager.html ---- - -# DDNXamarin.iOS.DCVLicenseManager - -The class that implements interface [`ILicenseManager`](license-manager.md) on iOS end. - -## How to Use - -Add the following code in the **AppDelegate.cs** of your project to implement `ILicenseManager` with `DCVLicenseManager`. - -```csharp -public override bool FinishedLaunching(UIApplication app, NSDictionary options) -{ - LoadApplication(new App(new DCVCameraEnhancer(), new DCVDocumentNormalizer(), new DCVLicenseManager())); -} -``` - -## Methods Summary - -| Method | Description | -|----------------------|-------------| -| [`InitLicense`](license-manager.md#initlicense) | Read the license key and activate the SDK. | diff --git a/programming-old/xamarin/api-reference/license-manager.md b/programming-old/xamarin/api-reference/license-manager.md deleted file mode 100644 index f2e98d6..0000000 --- a/programming-old/xamarin/api-reference/license-manager.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -layout: default-layout -title: Interface ILicenseManager - Dynamsoft Document Normalizer Xamarin.Forms API Reference -description: This is the page of interface ILicenseManager of Dynamsoft Document Normalizer Xamarin.Forms SDK. -keywords: initLicense, ILicenseManager, DocumentNormalizer, api reference, Xamarin.Forms -needAutoGenerateSidebar: true -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/xamarin/api-reference/license-manager.html ---- - -# Interface ILicenseManager - -The interface `ILicenseManager` unlocks the Dynamsoft SDK with a purchased full license or a provided trial license to allow you to develop your application. - -```csharp -interface DDNXamarin.ILicenseManager -``` - -## Methods - -| Method | Description | -|----------------------|-------------| -| [`InitLicense`](#initlicense) | Read the license key and activate the SDK. | - ---- - -### InitLicense - -Read the license key and activate the SDK. - -```csharp -void InitLicense(string license, ILicenseVerificationListener licenseListener); -``` - -**Parameters** - -`[in] license`: The license key. -`[in] licenseListener`: The listener that handles callback when the license server returns. - -**Code Snippet** - -```csharp -public partial class App : Application, ILicenseVerificationListener -{ - public App(ICameraEnhancer enhancer, IDocumentNormalizer normalizer, ILicenseManager manager) - { - ... - licenseManager = manager; - licenseManager.InitLicense("Put your license here.", this); - ... - } - public void LicenseVerificationCallback(bool isSuccess, string msg) - { - // Add code to execute when license server returns. - } -} -``` diff --git a/programming-old/xamarin/api-reference/license-verification-listener.md b/programming-old/xamarin/api-reference/license-verification-listener.md deleted file mode 100644 index 6cb0f8c..0000000 --- a/programming-old/xamarin/api-reference/license-verification-listener.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -layout: default-layout -title: Interface ILicenseVerificationListener - Dynamsoft Document Normalizer Xamarin.Forms API Reference -description: This is the page of interface ILicenseVerificationListener of Dynamsoft Document Normalizer Xamarin.Forms SDK. -keywords: ILicenseVerificationListener, interface, Xamarin.Forms -needAutoGenerateSidebar: true -needGenerateH3Content: false -noTitleIndex: true -pageStartVer: 1.0 -permalink: /programming/xamarin/api-reference/license-verification-listener.html ---- - -# ILicenseVerificationListener - -`ILicenseVerificationListener` is the interface to handle callback when using [`initLicense`](license-manager.md#initlicense). - -```csharp -interface DDNXamarin.ILicenseVerificationListener -``` - -| Method | Description | -| ------ | ----------- | -| `LicenseVerificationCallback` | The callback of license server. | - -## LicenseVerificationCallback - -```csharp -void LicenseVerificationCallback(bool isSuccess, string msg); -``` - -**Parameters** - -`[in] isSuccess`: Whether the license verification was successful. -`[in] msg`: The error message from license server. - -**Code Snippet** - -```csharp -public partial class App : Application, ILicenseVerificationListener -{ - public App(ICameraEnhancer enhancer, IDocumentNormalizer normalizer, ILicenseManager manager) - { - ... - licenseManager = manager; - licenseManager.InitLicense("Put your license here.", this); - ... - } - public void LicenseVerificationCallback(bool isSuccess, string msg) - { - // Add code to execute when license server returns. - } -} -``` diff --git a/programming-old/xamarin/api-reference/normalized-image-result.md b/programming-old/xamarin/api-reference/normalized-image-result.md deleted file mode 100644 index 4242b03..0000000 --- a/programming-old/xamarin/api-reference/normalized-image-result.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default-layout -title: Class NormalizedImageResult - Dynamsoft Document Normalizer Xamarin.Forms API Reference -description: This is the page of class NormalizedImageResult of Dynamsoft Document Normalizer Xamarin.Forms SDK. -keywords: NormalizedImageResult, class, api reference, Xamarin.Forms -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/xamarin/api-reference/normalized-image-result.html ---- - -# NormalizedImageResult - -Stores the detected quad result. - -```csharp -class DDNXamarin.NormalizedImageResult - -``` - -## Attributes - -| Attribute | Type | Description | -|---------- | ---- | ----------- | -| [`Image`](#image) | `ImageData` | The ImageData of the normalized image. | - -  - -### Image - -The ImageData of the normalized image. - -```csharp -ImageData Image; -``` diff --git a/programming-old/xamarin/api-reference/quadrilateral.md b/programming-old/xamarin/api-reference/quadrilateral.md deleted file mode 100644 index 4f78c54..0000000 --- a/programming-old/xamarin/api-reference/quadrilateral.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -layout: default-layout -title: Class Quadrilateral - Dynamsoft Document Normalizer Xamarin.Forms edition -description: This is the page of class Quadrilateral of Dynamsoft Document Normalizer Xamarin.Forms SDK. -keywords: Quadrilateral, Xamarin.Forms -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true -permalink: /programming/xamarin/api-reference/quadrilateral.html ---- - - -# Quadrilateral - -Stores the quadrilateral. - -```csharp -class DDNXamarin.Quadrilateral -``` - -## Attributes Summary - -| Attribute | Type | Description | -|---------- | ---- | ----------- | -| [`Points`](#points) | `Xamarin.Forms.Point[]` | Four vertexes in a clockwise direction of a quadrilateral. Index 0 represents the left-most vertex. | - -## Methods Summary - -| Method | Description | -|---------- | ----------- | -| [`GetBoundingRect`](#points) | Get the bounding rectangle of the quadrilateral. | - -## Attributes and Methods Details - -### Points - -Four vertexes in a clockwise direction of a quadrilateral. Index 0 represents the left-most vertex. - -```csharp -Xamarin.Forms.Point[] points -``` - -### getBoundingRect - -Get the bounding rectangle of the quadrilateral. - -```csharp -Rect getBoundingRect(); -``` - -**Return Value** - -The bounding rectangle of the quadrilateral. diff --git a/programming-old/xamarin/index.md b/programming-old/xamarin/index.md deleted file mode 100644 index f7afca1..0000000 --- a/programming-old/xamarin/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for Xamarin.Forms - Main Page -description: This is the main page of Dynamsoft Document Normalizer for Xamarin.Forms SDK. -keywords: Xamarin.Forms -needAutoGenerateSidebar: false -breadcrumbText: Xamarin.Forms -permalink: /programming/xamarin/index.html ---- - -# Documentation - Xamarin.Forms - -Welcome to the Dynamsoft Document Normalizer Xamarin.Forms SDK documentation. - -## Getting Started - -- [User Guide for Xamarin.Forms](user-guide.md) - -## API Reference - -- [API Reference](api-reference/index.md) - -## Release Notes - -- [Version 1.x](release-notes/xamarin-1.md) diff --git a/programming-old/xamarin/release-notes/index.md b/programming-old/xamarin/release-notes/index.md deleted file mode 100644 index 24a35a9..0000000 --- a/programming-old/xamarin/release-notes/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Xamarin.Forms SDK - Release Notes -description: This is the release notes page of Dynamsoft Document Normalizer for Xamarin.Forms SDK. -keywords: release notes, Xamarin.Forms -needAutoGenerateSidebar: false -breadcrumbText: Release Notes -permalink: /programming/xamarin/release-notes/index.html ---- - -# Release Notes - Xamarin.Forms Edition - -- [1.0.5 (09/13/2023)](xamarin-1.md#105-09132023) -- [1.0.4 (06/07/2023)](xamarin-1.md#104-06072023) -- [1.0.3 (05/24/2023)](xamarin-1.md#103-05242023) -- [1.0.2 (02/15/2023)](xamarin-1.md#102-02152023) -- [1.0.1 (11/11/2022)](xamarin-1.md#101-11112022) -- [1.0.0 (10/28/2022)](xamarin-1.md#100-10282022) diff --git a/programming-old/xamarin/release-notes/xamarin-1.md b/programming-old/xamarin/release-notes/xamarin-1.md deleted file mode 100644 index 9c7060c..0000000 --- a/programming-old/xamarin/release-notes/xamarin-1.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for xamarin SDK - Release Notes -description: This is the release notes page of Dynamsoft Document Normalizer for xamarin SDK. -keywords: release notes, xamarin, -needAutoGenerateSidebar: true -needGenerateH3Content: false -noTitleIndex: true -permalink: /programming/xamarin/release-notes/xamarin-1.html ---- - -# Release Notes for Xamarin SDK - -## 1.0.5 (09/13/2023) - -### Fixed - -- Fixed a crash bug by updated the internal dependencies. - -## 1.0.4 (06/07/2023) - -### Fixed - -- Fixed a bug where document boundary might not be detected when scanning from the video streaming. - -## 1.0.3 (05/24/2023) - -### Fixed - -- Fixed a `DetectedQuadResult` display bug. The edge of a quadrilateral might be wrongly linked when the `ImageEditorView` -is reopened. - -## 1.0.2 (02/15/2023) - -### Fixed - -- Fixed a crash bug that might happen when triggering method [`toImageSource`](../api-reference/image-data.md#toimagesource). - -## 1.0.1 (11/11/2022) - -### Fixed - -- Fixed a crash bug when triggering [`getSelectedQuadResult`](../api-reference/image-editor-view.md#getselectedquadresult) on `DCVImageEditorView` without selecting any quad. - -## 1.0.0 (10/28/2022) - -### Highlights - -{%- include release-notes/product-highlight-1.0.0.md -%} diff --git a/programming-old/xamarin/user-guide.md b/programming-old/xamarin/user-guide.md deleted file mode 100644 index ae1b11c..0000000 --- a/programming-old/xamarin/user-guide.md +++ /dev/null @@ -1,374 +0,0 @@ ---- -layout: default-layout -title: User Guide - Dynamsoft Document Normalizer Xamarin.Forms edition -description: This is the user guide of Dynamsoft Document Normalizer Xamarin.Forms SDK. -keywords: Guide, Xamarin.Forms, Document -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: false -permalink: /programming/xamarin/user-guide.html ---- - -# Dynamsoft Document Normalizer - Xamarin.Forms User Guide - -## Table of Contents - -- [System Requirements](#system-requirements) -- [Installation](#installation) -- [Build Your First Application](#build-your-first-application) - - [Set up Development Environment](#set-up-development-environment) - - [Initialize the Project](#initialize-the-project) - - [Include the Library](#include-the-library) - - [Initialize IDocumentNormalizer and ICameraEnhancer](#initialize-idocumentnormalizer-and-icameraenhancer) - - [MainPage for Realtime Quadrilateral Detection](#mainpage-for-realtime-quadrilateral-detection) - - [QuadEditorPage for Interactive Editing of Quads](#quadeditorpage-for-interactive-editing-of-quads) - - [ResultPage for Displaying the Normalized Image](#resultpage-for-displaying-the-normalized-image) - - [Add Camera Permission](#add-camera-permission) - - [Run the Project](#run-the-project) - -## System Requirements - -**Xamarin** - -- Dependency - - NETStandard.Library 2.0+ - - Xamarin.Forms 5.0.0.2515+ - - Xamarin.Essentials: 1.3.1+ (1.4.0+ Recommended) -- Develop environment: Visual Studio/Visual Studio for mac 2019 or higher. - -**Android** - -- Supported OS: **Android 5.0** (API Level 21) or higher. -- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**. -- JDK: 1.8+ -- Compile using Android version (Target Framework): Android 12.0(s) or higher. - -**iOS** - -- Supported OS: **iOS 9.0** or higher. -- Supported ABI: **arm64** and **x86_64**. -- Development Environment: Xcode 10 and above. - -## Installation - -Open the **Nuget Package Manager** of your project, search for **Dynamsoft.DocumentNormalizer.Xamarin.Forms**. Select all the modules of your project and click install. - -## Build Your First Application - -Now you will learn how to create a simple document scanner using Dynamsoft Document Normalizer Xamarin.Forms SDK. - -> Note: You can get the full source code of a similar project: Document Normalizer Xamarin.Forms Sample. - -### Set up Development Environment - -If you are a beginner with Xamarin, please follow the guide on the Xamarin official website to set up the development environment. - -### Initialize the Project - -**Visual Studio** - -1. Open the Visual Studio and select **Create a new project**. -2. Select **Mobile App (Xamarin.Forms)** and click **Next**. -3. Name the project **SimpleDocumentScanner**. Select a location for the project and click **Create**. -4. Select **Blank** and click **Create**. - -**Visual Studio for Mac** - -1. Open Visual Studio and select **New**. -2. Select **Multiplatform > App > Blank App > C#** and click **Next**. -3. Name the project **SimpleDocumentScanner** and click **Next**. -4. Select a location for the project and click **Create**. - -### Include the Library - -Add NuGet package **Dynamsoft.DocumentNormalizer.Xamarin.Forms** to your project. You can view the [installation section](#installation) on how to add the library. - -### Initialize IDocumentNormalizer and ICameraEnhancer - -You have to initialize the following two interfaces to scan document pages with the library. - -- `IDocumentNormalizer`: The interface that defines quadrilateral detecting and image normalizing methods. -- `ICameraEnhancer`: The interface that defines camera controlling APIs. It supports the quadrilateral detecion from video streaming. - -In **App.xaml.cs**, add the following code to initialize the `IDocumentNormalizer` and `ICameraEnhancer` objects. - -```csharp -using DDNXamarin; - -namespace SimpleDocumentScanner -{ - public partial class App : Application, ILicenseVerificationListener - { - public static ICameraEnhancer dce; - public static IDocumentNormalizer ddn; - public static ILicenseManager licenseManager; - - public App(ICameraEnhancer enhancer, IDocumentNormalizer normalizer, ILicenseManager manager) - { - InitializeComponent(); - dce = enhancer; - ddn = normalizer; - licenseManager = manager; - licenseManager.InitLicense("Put your license here.", this); - MainPage = new NavigationPage(new MainPage()); - } - - public void LicenseVerificationCallback(bool isSuccess, string msg) - { - - } - ... - } -} -``` - -Add the following code in **MainActivity.cs** of **SimpleDocumentScanner.Android**: - -```csharp -protected override void OnCreate(Bundle savedInstanceState) -{ - ... - LoadApplication(new App(new DCVCameraEnhancer(this), new DCVDocumentNormalizer(), new DCVLicenseManager(this))); -} -``` - -Add the following code in **AppDelegate.cs** of **SimpleDocumentScanner.iOS**: - -```csharp -public override bool FinishedLaunching(UIApplication app, NSDictionary options) -{ - ... - LoadApplication(new App(new DCVCameraEnhancer(), new DCVDocumentNormalizer(), new DCVLicenseManager())); - ... -} -``` - -### MainPage for Realtime Quadrilateral Detection - -On the **MainPage** of the project, we will implement realtime quad detecting features. - -Add 2 two elements in **MainPage.xaml**: - -- `DCVCameraView`: A build-in view of Dynamsoft Document Normalizer Xamarin.Forms edition that supports realtime detected quad previewing. -- `Button`: Confirm the detecting and move to quad editing. - -```xml - - - - - - - - - -``` - -Add code in **MainPage.cs** to support detected quad previewing. - -```csharp -using DDNXamarin; - -namespace SimpleDocumentScanner -{ - public partial class MainPage : ContentPage, IDetectResultListener - { - public MainPage() - { - InitializeComponent(); - App.ddn.SetCameraEnhancer(App.dce); - App.ddn.AddResultListener(this); - } - - public void DetectResultCallback(int id, ImageData imageData, DetectedQuadResult[] quadResults) - { - if (imageData != null && quadResults != null) - { - Device.BeginInvokeOnMainThread(async () => { - await Navigation.PushAsync(new QuadEditorPage(imageData, quadResults)); - }); - } - } - protected override void OnAppearing() - { - - base.OnAppearing(); - App.dce.Open(); - App.ddn.StartDetecting(); - } - - protected override void OnDisappearing() - { - base.OnDisappearing(); - App.dce.Close(); - App.ddn.StopDetecting(); - - } - void OnButtonClicked(object sender, EventArgs e) - { - App.ddn.EnableReturnImageOnNextCallback(); - } - } -} -``` - -### QuadEditorPage for Interactive Editing of Quads - -Create a new content page and name it `QuadEditorPage`. On this page, we will implement quad editing features. - -Add 2 two elements in **QuadEditorPage.Xaml**: - -- `DCVImageEditorView`: A build-in view of Dynamsoft Document Normalizer Xamarin.Forms edition that supports quad editing features. -- `Button`: Confirm the editing and start normalizing the image with the edited quad. - -```xml - - - - - - - - - - - -``` - -Add code in **QuadEditorPage.xaml.cs** to support the quad editing. - -```csharp -using DDNXamarin; - -namespace SimpleDocumentScanner -{ - public partial class QuadEditorPage : ContentPage - { - ImageData data; - DetectedQuadResult[] results; - public QuadEditorPage(ImageData imageData, DetectedQuadResult[] results) - { - InitializeComponent(); - data = imageData; - this.results = results; - } - - protected override void OnAppearing() - { - base.OnAppearing(); - if (data != null) { - imageEditor.OriginalImage = data; - } - if (results != null) { - imageEditor.DetectedQuadResults = results; - } - } - - void onNormalizeClicked(object sender, EventArgs e) - { - var quad = imageEditor.getSelectedQuadResult(); - var result = App.ddn.Normalize(data, quad); - Navigation.PushAsync(new ResultPage(result.image)); - } - } -} -``` - -### ResultPage for Displaying the Normalized Image - -Create a new content page and name it **ResultPage**. **ResultPage** is where we display the image of normalized results. - -```csharp -using DDNXamarin; - -namespace SimpleDocumentScanner -{ - [XamlCompilation(XamlCompilationOptions.Compile)] - public partial class ResultPage : ContentPage - { - public ResultPage(ImageData data) - { - Image image = new Image { Source = data.toImageSource() }; - if (Device.RuntimePlatform == Device.iOS) - { - image.RotateTo(data.orientation); - } - Content = new StackLayout - { - Margin = new Thickness(20), - HorizontalOptions = LayoutOptions.FillAndExpand, - VerticalOptions = LayoutOptions.FillAndExpand, - Children = { - image - } - }; - } - } -} -``` - -### Add Camera Permission - -**Android** - -Add the following code in **MainActivity.cs** for requesting camera permission on Android devices. - -```csharp -using Xamarin.Essentials; -namespace SimpleBarcodeScanner.Droid -{ - ... - public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompatActivity - { - protected override void OnCreate(Bundle savedInstanceState) - { - ... - // Add camera permission. - Permissions.RequestAsync(); - } - public override void OnRequestPermissionsResult(int requestCode, string[] permissions, [GeneratedEnum] Android.Content.PM.Permission[] grantResults) - { - ... - base.OnRequestPermissionsResult(requestCode, permissions, grantResults); - } - } -} -``` - -**iOS** - -Add **Privacy - Camera Usage Description** and your message to the **info.plist** of your project. - -### Run the Project - -**Run Android on Windows** - -Select **SimpleBarcodeScanner.Android** and select your device. Run the project. - -
    -

    run

    -

    Run Your Project

    -
    - -**Run iOS & Android on macOS** - -1. Right click on the **SimpleBarcodeReader.iOS** or **SimpleBarcodeReader.Android** and select **Set As Startup Project**. -2. In the menu, select and click **Run > Start Debugging**. diff --git a/programming/android/api-reference/candidate-quad-edges-unit-v2.0.20.md b/programming/android/api-reference/candidate-quad-edges-unit-v2.0.20.md deleted file mode 100644 index 932f5f0..0000000 --- a/programming/android/api-reference/candidate-quad-edges-unit-v2.0.20.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: CandidateQuadEdgesUnit - Dynamsoft Document Normalizer Android SDK API Reference -description: The class CandidateQuadEdgesUnit represents an intermediate result unit whose type is candidate quad edges. -keywords: candidate quad edges, intermediate result unit, java, kotlin -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# CandidateQuadEdgesUnit - -The `CandidateQuadEdgesUnit` class represents an intermediate result unit whose type is candidate quad edges. - -## Definition - -*Namespace:* com.dynamsoft.ddn.intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer.aar - -```java -class CandidateQuadEdgesUnit extends IntermediateResultUnit -``` - -## Methods - -| Methods | Description | -| ------- | ----------- | -| [`getCandidateQuadEdges`](#getcandidatequadedges) | Get an array of edges. It includes all edges that candidate quadrilaterals assembling. | - -### getCandidateQuadEdges - -Get an array of edges. It includes all edges that candidate quadrilaterals assembling. - -```java -Edge[] getCandidateQuadEdges(); -``` - -**Return Value** - -Get an array of [`Edge`]({{site.dcv_android_api}}core/basic-structures/edge.html). diff --git a/programming/android/api-reference/corners-unit-v2.0.20.md b/programming/android/api-reference/corners-unit-v2.0.20.md deleted file mode 100644 index ff2bcf5..0000000 --- a/programming/android/api-reference/corners-unit-v2.0.20.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: CornersUnit - Dynamsoft Document Normalizer Android SDK API Reference -description: The class CornersUnit represents an intermediate result unit whose type is corners. -keywords: corners unit, java, kotlin -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# CornersUnit - -The `CornersUnit` class represents an intermediate result unit whose type is corners. - -## Definition - -*Namespace:* com.dynamsoft.ddn.intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer.aar - -```java -class CornersUnit extends IntermediateResultUnit -``` - -## Methods - -| Methods | Description | -| ------- | ----------- | -| [`getCorners`](#getcorners) | Get an array of corners. It includes all corners that participate quadrilaterals assembling. | - -### getCorners - -Get an array of corners. It includes all corners that participate quadrilaterals assembling. - -```java -Corner[] getCorners(); -``` - -**Return Value** - -Get an array of [`Corner`]({{site.dcv_android_api}}core/basic-structures/corner.html). \ No newline at end of file diff --git a/programming/android/api-reference/detected-quads-unit-v2.0.20.md b/programming/android/api-reference/detected-quads-unit-v2.0.20.md deleted file mode 100644 index 198352c..0000000 --- a/programming/android/api-reference/detected-quads-unit-v2.0.20.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: DetectedQuadsUnit - Dynamsoft Document Normalizer Android SDK API Reference -description: The class DetectedQuadsUnit represents an intermediate result unit whose type is detected quads. It is inherited from the IntermediateResultUnit class. -keywords: detected quads, java, kotlin -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# DetectedQuadsUnit - -The `DetectedQuadsUnit` class represents an intermediate result unit whose type is detected quads. It is inherited from the `IntermediateResultUnit` class. - -## Definition - -*Namespace:* com.dynamsoft.ddn.intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer.aar - -```java -class DetectedQuadsUnit extends IntermediateResultUnit -``` - -## Methods - -| Methods | Description | -| ---------- | ----------- | -| [`getDetectedQuads`](#getdetectedquads) | Gets an array of `DetectedQuadElement` objects, each containing the information of a single detected quadrilateral. | - -### getDetectedQuads - -Gets an array of `DetectedQuadElement` objects, each containing the information of a single detected quadrilateral. - -```java -DetectedQuadElement[] getDetectedQuads() -``` - -**Return Value** - -The array of [`DetectedQuadElement`](./detected-quad-element.md). diff --git a/programming/android/api-reference/index-v2.0.20.md b/programming/android/api-reference/index-v2.0.20.md deleted file mode 100644 index 3cf02b2..0000000 --- a/programming/android/api-reference/index-v2.0.20.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - Main Page -description: This is the main page of Dynamsoft Document Normalizer SDK API Reference for Android. -keywords: api reference, Android -permalink: /programming/android/api-reference/index-v2.0.20.html ---- - -# API Reference - Android - -## DynamsoftCaptureVisionRouter - -### CaptureVisionRouter Class - -- [`CaptureVisionRouter`]({{ site.dcv_android_api }}capture-vision-router/capture-vision-router.html) - -### Auxiliary Classes - -- [`CaptureVisionRouterModule`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/capture-vision-router-module.html) -- [`SimplifiedCaptureVisionSettings`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html) - -### Interfaces - -- [`CaptureStateListener`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/capture-state-listener.html) -- [`ImageSourceStateListener`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/image-source-state-listener.html) - -### Enumerations - -- [`EnumCaptureState`]({{ site.dcv_enumerations }}capture-vision-router/capture-state.html?lang=android) -- [`EnumPresetTemplate`]({{ site.dcv_enumerations }}capture-vision-router/preset-template.html?lang=android) - -## DynamsoftDocumentNormalizer - -- [`CandidateQuadEdgesUnit`]({{ site.ddn_android_api }}candidate-quad-edges-unit.html) -- [`CornersUnit`]({{ site.ddn_android_api }}corners-unit.html) -- [`DetectedQuadElement`]({{ site.ddn_android_api }}detected-quad-element.html) -- [`DetectedQuadResultItem`]({{ site.ddn_android_api }}detected-quad-result-item.html) -- [`DetectedQuadsResult`]({{ site.ddn_android_api }}detected-quads-result.html) -- [`DetectedQuadsUnit`]({{ site.ddn_android_api }}detected-quads-unit.html) -- [`DocumentNormalizerModule`]({{ site.ddn_android_api }}document-normalizer-module.html) -- [`LongLinesUnit`]({{ site.ddn_android_api }}long-lines-unit.html) -- [`NormalizedImageElement`]({{ site.ddn_android_api }}normalized-image-element.html) -- [`NormalizedImageResultItem`]({{ site.ddn_android_api }}normalized-image-result-item.html) -- [`NormalizedImagesResult`]({{ site.ddn_android_api }}normalized-images-result.html) -- [`NormalizedImageUnit`]({{ site.ddn_android_api }}normalized-image-unit.html) - -## DynamsoftCore - -### Classes - -- [`BinaryImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/binary-image-unit.html) -- [`CapturedResultFilter`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html) -- [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html) -- [`CapturedResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) -- [`CapturedResult`]({{ site.dcv_android_api }}core/basic-structures/captured-result.html) -- [`ColourImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/colour-image-unit.html) -- [`ContoursUnit`]({{ site.dcv_android_api }}core/intermediate-results/contours-unit.html) -- [`Contour`]({{ site.dcv_android_api }}core/basic-structures/contour.html) -- [`CoreModule`]({{ site.dcv_android_api }}core/basic-structures/core-module.html) -- [`Corner`]({{ site.dcv_android_api }}core/basic-structures/corner.html) -- [`DSRect`]({{ site.dcv_android_api }}core/basic-structures/rect.html) -- [`Edge`]({{ site.dcv_android_api }}core/basic-structures/edge.html) -- [`EnhancedGrayscaleImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/enhanced-grayscale-image-unit.html) -- [`FileImageTag`]({{ site.dcv_android_api }}core/basic-structures/file-image-tag.html) -- [`GrayscaleImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/grayscale-image-unit.html) -- [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) -- [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/basic-structures/image-source-adapter.html) -- [`ImageTag`]({{ site.dcv_android_api }}core/basic-structures/image-tag.html) -- [`IntermediateResultExtraInfo`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-extra-info.html) -- [`IntermediateResultManager`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) -- [`IntermediateResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) -- [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html) -- [`IntermediateResult`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result.html) -- [`LineSegmentsUnit`]({{ site.dcv_android_api }}core/intermediate-results/line-segments-unit.html) -- [`LineSegment`]({{ site.dcv_android_api }}core/basic-structures/line-segment.html) -- [`ObservationParameters`]({{ site.dcv_android_api }}core/intermediate-results/observation-parameters.html) -- [`OriginalImageResultItem`]({{ site.dcv_android_api }}core/basic-structures/original-image-result-item.html) -- [`PredetectedRegionElement`]({{ site.dcv_android_api }}core/intermediate-results/predetected-region-element.html) -- [`PredetectedRegionsUnit`]({{ site.dcv_android_api }}core/intermediate-results/predetected-regions-unit.html) -- [`Quadrilateral`]({{ site.dcv_android_api }}core/basic-structures/quadrilateral.html) -- [`RegionObjectElement`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html) -- [`ScaledDownColourImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/scaled-down-colour-image-unit.html) -- [`TextRemovedBinaryImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/text-removed-binary-image-unit.html) -- [`TextureDetectionResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/texture-detection-result-unit.html) -- [`TextureRemovedBinaryImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/texture-removed-binary-image-unit.html) -- [`TextureRemovedGrayscaleImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/texture-removed-grayscale-image-unit.html) -- [`TextZonesUnit`]({{ site.dcv_android_api }}core/intermediate-results/text-zones-unit.html) -- [`TransformedGrayscaleImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/transformed-grayscale-image-unit.html) -- [`Vector4`]({{ site.dcv_android_api }}core/basic-structures/vector4.html) -- [`VideoFrameTag`]({{ site.dcv_android_api }}core/basic-structures/video-frame-tag.html) - -### Interfaces - -- [`ImageSourceErrorListener`]({{ site.dcv_android_api }}core/basic-structures/image-source-error-listener.html) - -### Enumerations - -- [`BufferOverflowProtectionMode`]({{ site.dcv_enumerations }}core/buffer-overflow-protection-mode.html?lang=android) -- [`CapturedResultItemType`]({{ site.dcv_enumerations }}core/captured-result-item-type.html?lang=android) -- [`ColourChannelUsageType`]({{ site.dcv_enumerations }}core/colour-channel-usage-type.html?lang=android) -- [`CornerType`]({{ site.dcv_enumerations }}core/corner-type.html?lang=android) -- [`ErrorCode`]({{ site.dcv_enumerations }}core/error-code.html?lang=android) -- [`GrayscaleEnhancementMode`]({{ site.dcv_enumerations }}core/grayscale-enhancement-mode.html?lang=android) -- [`GrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=android) -- [`ImageCaptureDistanceMode`]({{ site.dcv_enumerations }}core/image-capture-distance-mode.html?lang=android) -- [`ImagePixelFormat`]({{ site.dcv_enumerations }}core/image-pixel-format.html?lang=android) -- [`ImageSourceState`]({{ site.dcv_enumerations }}core/image-source-state.html?lang=android) -- [`ImageTagType`]({{ site.dcv_enumerations }}core/image-tag-type.html?lang=android) -- [`IntermediateResultUnitType`]({{ site.dcv_enumerations }}core/intermediate-result-unit-type.html?lang=android) -- [`LogMode`]({{ site.dcv_enumerations }}core/log-mode.html?lang=android) -- [`RegionObjectElementType`]({{ site.dcv_enumerations }}core/region-object-element-type.html?lang=android) -- [`SectionType`]({{ site.dcv_enumerations }}core/section-type.html?lang=android) -- [`TransformMatrixType`]({{ site.dcv_enumerations }}core/transform-matrix-type.html?lang=android) -- [`VideoFrameQuality`]({{ site.dcv_enumerations }}core/video-frame-quality.html?lang=android) - -## DynamsoftUtility - -- [`DirectoryFetcher`]({{ site.dcv_android_api }}utility/directory-fetcher.html) -- [`FileFetcher`]({{ site.dcv_android_api }}utility/file-fetcher.html) -- [`MultiFrameResultCrossFilter`]({{ site.dcv_android_api }}utility/multi-frame-result-cross-filter.html) -- [`UtilityModule`]({{ site.dcv_android_api }}utility/utility-module.html) - -## DynamsoftCameraEnhancer - -### Classes - -- [`CameraEnhancer`]({{ site.dce_android_api }}primary-api/camera-enhancer.html) -- [`CameraEnhancerModule`]({{ site.dce_android_api }}auxiliary-api/camera-enhancer-module.html) -- [`CameraView`]({{ site.dce_android_api }}auxiliary-api/dcecameraview.html) -- [`Capabilities`]({{ site.dce_android_api }}auxiliary-api/capabilities.html) -- [`DrawingItem`]({{ site.dce_android_api }}auxiliary-api/drawingitem.html) -- [`DrawingLayer`]({{ site.dce_android_api }}auxiliary-api/dcedrawinglayer.html) -- [`DrawingStyleManager`]({{ site.dce_android_api }}auxiliary-api/drawingstylemanager.html) -- [`DrawingStyle`]({{ site.dce_android_api }}auxiliary-api/drawingstyle.html) -- [`Feedback`]({{ site.dce_android_api }}auxiliary-api/dcefeedback.html) -- [`ImageEditorView`]({{ site.dce_android_api }}auxiliary-api/dceimageeditorview.html) -- [`LineDrawingItem`]({{ site.dce_android_api }}auxiliary-api/drawingitem-line.html) -- [`Note`]({{ site.dce_android_api }}auxiliary-api/note.html) -- [`QuadDrawingItem`]({{ site.dce_android_api }}auxiliary-api/drawingitem-quad.html) -- [`RectDrawingItem`]({{ site.dce_android_api }}auxiliary-api/drawingitem-rect.html) -- [`TextDrawingItem`]({{ site.dce_android_api }}auxiliary-api/drawingitem-text.html) -- [`TipConfig`]({{ site.dce_android_api }}auxiliary-api/tip-config.html) - -### Interfaces - -- [`CameraStateListener`]({{ site.dce_android_api }}auxiliary-api/protocol-dcecamerastatelistener.html) -- [`PhotoListener`]({{ site.dce_android_api }}auxiliary-api/protocol-dcephotolistener.html) -- [`VideoFrameListener`]({{ site.dce_android_api }}auxiliary-api/protocol-dceframelistener.html) - -### Enumerations - -- [`CameraPosition`]({{ site.dce_enumerations }}camera-position.html?lang=objc,swift) -- [`CameraState`]({{ site.dce_enumerations }}camera-state.html?lang=objc,swift) -- [`CoordinateBase`]({{ site.dce_enumerations }}coordinate-base.html?lang=objc,swift) -- [`DrawingItemMediaType`]({{ site.dce_enumerations }}drawing-item-media-type.html?lang=objc,swift) -- [`DrawingItemState`]({{ site.dce_enumerations }}drawing-item-state.html?lang=objc,swift) -- [`EnhancedFeatures`]({{ site.dce_enumerations }}enhanced-features.html?lang=objc,swift) -- [`FocusMode`]({{ site.dce_enumerations }}focus-mode.html?lang=objc,swift) -- [`Resolution`]({{ site.dce_enumerations }}resolution.html?lang=objc,swift) - -## DynamsoftImageProcessing - -- [`ImageProcessingModule`]({{ site.dcv_android_api }}image-processing/image-processing-module.html) - -## DynamsoftLicense - -- [`LicenseManger`]({{ site.dcv_android_api }}license/license-manager.html) -- [`LicenseModule`]({{ site.dcv_android_api }}license/license-module.html) diff --git a/programming/android/api-reference/index.md b/programming/android/api-reference/index.md deleted file mode 100644 index 5c88f15..0000000 --- a/programming/android/api-reference/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android API Reference - Main Page -description: This is the main page of Dynamsoft Document Normalizer SDK API Reference for Android Language. -keywords: Document Normalizer, api reference, Android ---- - -# SDK Overview: Modules and Main APIs - -This page provides an overview of the various modules and highlights the most essential APIs that form the backbone of Dynamsoft Document Normalizer SDK. - -## Modules Summary - -The Dynamsoft Document Normalizer (DDN) SDK is built on the Dynamsoft Capture Vision (DCV) framework, which includes multiple modules working together to achieve boundary detection or document normalization. The hierarchical structure diagram below illustrates the various modules of the DDN SDK (with modules at the top depending on those below). - -
    -

    region-def

    -

    Modules hierarchical of the DDN SDK

    -
    - -The table below describes details the functionalities of these modules: - -| Module | Description | Mandatory/Optional | -|:-------|:------------|:-------------------| -| `DynamsoftDocumentNormalizer.aar`(DDN) | The Dynamsoft Document Normalizer module extracts structural information from document images, including document boundaries, shadow areas, and text areas. It uses this information to generate normalized document images through processes such as deskewing, shadow removal, and distortion correction. | Mandatory | -| `DynamsoftCore.aar`(Core) | The Dynamsoft Core module lays the foundation for Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. It encapsulates the basic classes, interfaces, and enumerations shared by these SDKs. | Mandatory | -| `DynamsoftCaptureVisionRouter.aar`(CVR) | The Dynamsoft Capture Vision Router module is the cornerstone of the Dynamsoft Capture Vision (DCV) architecture. It focuses on coordinating batch image processing and provides APIs for setting up image sources and result receivers, configuring workflows with parameters, and controlling processes. | Mandatory | -| `DynamsoftImageProcessing.aar`(DIP) | The Dynamsoft Image Processing module facilitates digital image processing and supports operations for other modules, including the Barcode Reader, Label Recognizer, and Document Normalizer. | Mandatory | -| `DynamsoftLicense.aar`(License) | The Dynamsoft License module manages the licensing aspects of Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. | Mandatory | -| `DynamsoftCameraEnhancer.aar`(DCE) | The [Dynamsoft Camera Enhancer]({{ site.dce_android_api }}){:target="_blank"} module controls the camera, transforming it into an image source for the DCV (Dynamsoft Capture Vision) architecture through ISA implementation. It also enhances image quality during acquisition and provides basic viewers for user interaction. | Mandatory | -| `DynamsoftUtility.aar`(Utility) | The Dynamsoft Utility module defines auxiliary classes, including the ImageManager, and implementations of the CRF (Captured Result Filter) and ISA (Image Source Adapter) . These are shared by all Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. | Optional | - -## Main APIs - -### Capture Vision Router - -The main class [`CaptureVisionRouter`]({{ site.dcv_android_api }}capture-vision-router/capture-vision-router.html) acts as the SDK entry point and provides the following essential APIs: - -- [Set input]({{ site.dcv_android_api }}capture-vision-router/multiple-file-processing.html#setinput) -- [Config capture settings]({{ site.dcv_android_api }}capture-vision-router/settings.html) -- [Add result receiver]({{ site.dcv_android_api }}capture-vision-router/multiple-file-processing.html#addresultreceiver) -- [Start video stream boundary detection or document normalization]({{ site.dcv_android_api }}capture-vision-router/multiple-file-processing.html#startcapturing) - -### Image Source Adapter - -The [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/basic-structures/image-source-adapter.html) class is an abstract class representing an adapter for image sources, providing a framework for fetching, buffering, and managing images from various sources. It serves as the input for the [`CaptureVisionRouter`]({{ site.dcv_android_api }}capture-vision-router/capture-vision-router.html). You can either use the typical implementations of [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/basic-structures/image-source-adapter.html) or implement your own. - -Class [`CameraEnhancer`]({{ site.dce_android_api }}primary-api/camera-enhancer.html) is one of the typical implementations of [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/basic-structures/image-source-adapter.html). It is a class that not only implements the video frame obtaining APIs but also enable you to improve the video quality by adjusting the camera settings. - -### Captured Result Receiver - -To receive the results of video streaming boundary detecting or document normalizing, you need to implement the [`CapturedResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) with [`onDetectedQuadsReceived`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#ondetectedquadsreceived) or [`onNormalizedImagesReceived`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#onnormalizedimagesreceived). - -Boundary detection related APIs: - -- [`onDetectedQuadsReceived`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#ondetectedquadsreceived): The callback method for you to receive the boundary detetction results with a [`DetectedQuadsResult`](detected-quads-result.md) object. -- [`DetectedQuadsResult`](detected-quads-result.md): An object that contains all the [`DetectedQuadResultItem`](detected-quad-result-item.md) that obtained from a video frame. -- [`DetectedQuadResultItem`](detected-quad-result-item.md): The basic item that represents a single detected boundary as an quadrilateral with additional information. - -Document Normalization related APIs: - -- [`onNormalizedImagesReceived`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html#onnormalizedimagesreceived): The callback method for you to receive the normalized image results with a [`NormalizedImagesResult`](normalized-images-result.md) object. -- [`NormalizedImagesResult`](normalized-images-result.md): An object that contains all the [`NormalizedImageResultItem`](normalized-image-result-item.md) that obtained from a video frame. -- [`NormalizedImageResultItem`](normalized-image-result-item.md): The basic item that represents a single normalized image with the image data and other information. - -### Camera View - -[`CameraView`]({{ site.dce_android_api }}auxiliary-api/dcecameraview.html) is a view class that design for visualizing the real time video streaming and the boundary detection result. If the [`CameraEnhancer`]({{ site.dce_android_api }}primary-api/camera-enhancer.html) is set as the input of your CVR, the detected boundaries will be highlighted automatically on the [`CameraView`]({{ site.dce_android_api }}auxiliary-api/dcecameraview.html). diff --git a/programming/android/api-reference/long-lines-unit-v2.0.20.md b/programming/android/api-reference/long-lines-unit-v2.0.20.md deleted file mode 100644 index 1cc7c3a..0000000 --- a/programming/android/api-reference/long-lines-unit-v2.0.20.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: LongLinesUnit - Dynamsoft Document Normalizer Android SDK API Reference -description: The class LongLinesUnit represents an intermediate result unit whose type is long lines. Line segments that are located in the same line are extended and merged to form a long line. -keywords: long lines, intermediate result unit, java, kotlin -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# LongLinesUnit - -The `LongLinesUnit` class represents an intermediate result unit whose type is long lines. Line segments that are located in the same line are extended and merged to form a long line. - -## Definition - -*Namespace:* com.dynamsoft.ddn.intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer.aar - -```java -class LongLinesUnit extends IntermediateResultUnit -``` - -## Methods - -| Methods | Description | -| ---------- | ----------- | -| [`getLongLines`](#getlonglines) | Get an array of [`LineSegment`]({{site.dcv_android_api}}core/basic-structures/line-segment.html) as the long lines. | - -### getLongLines - -Get an array of [`LineSegment`]({{site.dcv_android_api}}core/basic-structures/line-segment.html) as the long lines. - -```java -LineSegment[] getLongLines(); -``` - -**Return Value** - -The array of [`LineSegment`]({{site.dcv_android_api}}core/basic-structures/line-segment.html) as the long lines. diff --git a/programming/android/api-reference/normalized-image-unit-v2.0.20.md b/programming/android/api-reference/normalized-image-unit-v2.0.20.md deleted file mode 100644 index 29a22b5..0000000 --- a/programming/android/api-reference/normalized-image-unit-v2.0.20.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: NormalizedImagesUnit - Dynamsoft Document Normalizer Android SDK API Reference -description: The class NormalizedImagesUnit represents an intermediate result unit whose type is normalized images. -keywords: normalized images, java, kotlin -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# NormalizedImagesUnit - -The `NormalizedImagesUnit` class represents an intermediate result unit whose type is normalized images. - -## Definition - -*Namespace:* com.dynamsoft.ddn.intermediate_results - -*Assembly:* DynamsoftDocumentNormalizer.aar - -```java -class NormalizedImagesUnit extends IntermediateResultUnit -``` - -## Methods - -| Methods | Description | -| ---------- | ----------- | -| [`getNormalizedImages`](#getnormalizedimages) | Gets an array of [`NormalizedImageElement`](./normalized-image-element.md). | - -### getNormalizedImages - -Gets an array of [`NormalizedImageElement`](./normalized-image-element.md). - -```java -NormalizedImageElement[] getNormalizedImages(); -``` - -**Return Value** - -The array of [`NormalizedImageElement`](./normalized-image-element.md). diff --git a/programming/android/api-reference/simplified-document-normalizer-settings-v2.2.10.md b/programming/android/api-reference/simplified-document-normalizer-settings-v2.2.3000.md similarity index 83% rename from programming/android/api-reference/simplified-document-normalizer-settings-v2.2.10.md rename to programming/android/api-reference/simplified-document-normalizer-settings-v2.2.3000.md index c8e90ad..0e73c87 100644 --- a/programming/android/api-reference/simplified-document-normalizer-settings-v2.2.10.md +++ b/programming/android/api-reference/simplified-document-normalizer-settings-v2.2.3000.md @@ -22,7 +22,7 @@ The `SimplifiedDocumentNormalizerSettings` class represents a series of simple s class SimplifiedDocumentNormalizerSettings ``` -## Attributes +## Methods & Attributes | Attributes | Type | Description | | ---------- | ---- | ----------- | @@ -35,6 +35,10 @@ class SimplifiedDocumentNormalizerSettings | [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | The maximum number of threads in one task. | | [`scaleDownThreshold`](#scaledownthreshold) | *int* | The scale down threshold. | +| Methods | Description | +| [`toJson`](#tojson) | Generate a JSON string from this `SimplifiedDocumentNormalizerSettings` object. | +| [`fromJson`](#fromjson) | Create a `SimplifiedDocumentNormalizerSettings` object from a JSON string. | + ### grayscaleTransformationModes Defines the grayscale transformation modes with an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=android) items. This parameter is important when working with inverted documents, and must be used in order to locate the inverted document boundary. @@ -98,3 +102,31 @@ If the original image size is quite large, then the `scaledownThreshold` can be ```java int scaleDownThreshold; ``` + +### toJson + +Generate a JSON string from this `SimplifiedDocumentNormalizerSettings` object. + +```java +String toJson() +``` + +**Return Value** + +A JSON string that contains all the information of this object. + +### fromJson + +Create a `SimplifiedDocumentNormalizerSettings` object from a JSON string. + +```java +static SimplifiedDocumentNormalizerSettings fromJson(String json); +``` + +**Parameters** + +* `json`: A JSON string that contains all `SimplifiedDocumentNormalizerSettings` required information. + +**Return Value** + +A `SimplifiedDocumentNormalizerSettings` object. diff --git a/programming/android/api-reference/simplified-document-normalizer-settings.md b/programming/android/api-reference/simplified-document-normalizer-settings.md index 0e73c87..1c070db 100644 --- a/programming/android/api-reference/simplified-document-normalizer-settings.md +++ b/programming/android/api-reference/simplified-document-normalizer-settings.md @@ -34,6 +34,8 @@ class SimplifiedDocumentNormalizerSettings | [`contrast`](#contrast) | *int* | The contrast. | | [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | The maximum number of threads in one task. | | [`scaleDownThreshold`](#scaledownthreshold) | *int* | The scale down threshold. | +| [`minQuadrilateralAreaRatio`](#minquadrilateralarearatio) | *int* | The minimum ratio between the target document area and the total image area. Only those exceeding this value will be outputted (measured in percentages). | +| [`expectedDocumentsCount`](#expecteddocumentscount) | *int* | The number of documents expected to be detected. | | Methods | Description | | [`toJson`](#tojson) | Generate a JSON string from this `SimplifiedDocumentNormalizerSettings` object. | @@ -103,6 +105,22 @@ If the original image size is quite large, then the `scaledownThreshold` can be int scaleDownThreshold; ``` +### minQuadrilateralAreaRatio + +The minimum ratio between the target document area and the total image area. Only those exceeding this value will be outputted (measured in percentages). + +```java +int minQuadrilateralAreaRatio; +``` + +### expectedDocumentsCount + +The number of documents expected to be detected. + +```java +int expectedDocumentsCount; +``` + ### toJson Generate a JSON string from this `SimplifiedDocumentNormalizerSettings` object. diff --git a/programming/android/index.md b/programming/android/index.md deleted file mode 100644 index 85098ac..0000000 --- a/programming/android/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default-layout -title: Introduction - Dynamsoft Document Normalizer Android Edition -description: This page introduces the Android edition of Dynamsoft Document Normalizer -keywords: android, documentation -needAutoGenerateSidebar: false -breadcrumbText: Android -permalink: /programming/android/index.html ---- - -# Dynamsoft Document Normalizer Documentation for Android Edition - -Dynamsoft Document Normalizer (DDN) SDK Android Edition is a document normalization SDK designed specifically for Android developers. - -DDN Android Edition provides rich APIs for developers to easily integrate document normalization functionality into your Android applications. Please take a look at [API Reference](api-reference/index.md) to see the details. - -As one of the functional products of the Dynamsoft Capture Vision (DCV) framework, DDN is also designed to seamlessly integrate with other DCV components and provide developers with a comprehensive set of image processing tools, which cover image capturing, content understanding, result parsing, and interactive workflow. If you are building such a document capturing and processing solution, take a look at Introduction to Dynamsoft Capture Vision. - -Furthermore, DDN provides a powerful parameter system in order to cope with various scenarios. Read Parameter Reference for details. - -## Getting Started with DDN Android Edition - -The best way to start with the Dynamsoft Document Normalizer Android Edition is by following the [User Guide](user-guide.md) to build your first document normalization application. - -## License Subscription - -To develop and run your application with Dynamsoft Document Normalizer SDK, you need an active license key: -* Request a 30-day free trial license - -## Other Edition - -DDN is designed to provide document border detection and document normalization functionality for web, desktop, and mobile applications. If you are developing with other programming languages, please check out the following editions: - -* Dynamsoft Document Normalizer Documentation for iOS -* Dynamsoft Document Normalizer Documentation for Xamarin.Forms -* Dynamsoft Document Normalizer Documentation for JavaScript -* Dynamsoft Document Normalizer Documentation for C++ - -## Contact Us - -Feel free to contact us if you have any questions. diff --git a/programming/android/release-notes/android-2.md b/programming/android/release-notes/android-2.md deleted file mode 100644 index 5851c05..0000000 --- a/programming/android/release-notes/android-2.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for Android SDK - Release Notes -description: This is the release notes page of Dynamsoft Document Normalizer for Android SDK 2.x. -keywords: release notes, android -needAutoGenerateSidebar: true -needGenerateH3Content: false -noTitleIndex: true -permalink: /programming/android/release-notes/android-2.html ---- - -# Release Notes for Android SDK - v2.x - -## 2.2.11 (05/15/2024) - -- Added new methods `toJson` & `fromJson` to the [`SimplifiedDocumentNormalizerSettings`]({{ site.dbr_android_api }}simplified-document-normalizer-settings.html) class. - -## 2.2.10 (03/07/2024) - -### New - -- Updated the template system - - Added `ReferenceTaskNameArray` under [`Location.ReferenceObjectFilter`]({{ site.dcv_parameters }}reference/target-roi-def/location.html){:target="_blank"} to filter the reference objects generated by the task name. - - Added the support of the [`OutputTaskSetting`]({{ site.dcv_parameters }}reference/output-task-setting/index.html){:target="_blank"} definition. The following subparameters are available in `OutputTaskSetting` object: - - [`OutputCondition`]({{ site.dcv_parameters }}reference/output-task-setting/output-condition.html){:target="_blank"} - - [`TaskResultArray`]({{ site.dcv_parameters }}reference/output-task-setting/output-condition.html#taskresultarray){:target="_blank"} - - [`TargetROIDefName`]({{ site.dcv_parameters }}reference/target-roi-def/index.html#targetroidefname){:target="_blank"} - - [`TaskSettingNameArray`]({{ site.dcv_parameters }}reference/output-task-setting/output-condition.html#tasksettingnamearray){:target="_blank"} - - [`BackwardReferenceOutput`]({{ site.dcv_parameters }}reference/output-task-setting/output-condition.html#backwardreferenceoutput){:target="_blank"} - - `ReferenceTaskNameArray` - - `ReferenceResultTypeArray` - - [`Operator`]({{ site.dcv_parameters }}reference/output-task-setting/output-condition.html){:target="_blank"} - - [`Name`]({{ site.dcv_parameters }}reference/output-task-setting/name.html){:target="_blank"} - - [`Offset`]({{ site.dcv_parameters }}reference/target-roi-def/location.html#offset){:target="_blank"} parameter is optimized. - - Added `ReferenceObjectType` to specify whether the reference object is an atomic object or the whole image. - - Added `ReferenceXAxis` & `ReferenceYAxis` to define the X & Y axis. - - Modified `FirstPoint`, `SecondPoint`, `ThirdPoint` & `FourthPoint`. You can specify whether the X or Y coordinate of the point is measured by percentage. - - Deprecated `ReferenceObjectSize` Type. -- The following classes are migrated from `DynamsoftCore.aar` into `DynamsoftCaptureVision.aar`: - - [`CapturedResult`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result.html) - - [`IntermediateResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) - - [`CapturedResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) - - [`CapturedResultFilter`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html) - - [`IntermediateResultManager`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) -- Added a new call back method [`onShortLinesUnitReceived`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html#onshortlinesunitreceived) to the [`IntermediateResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/intermediate-result-receiver.html) class. -- Added methods [`pauseCapturing`]({{ site.dcv_android_api }}capture-vision-router/multiple-file-processing.html#pausecapturing) and [`resumeCapturing`]({{ site.dcv_android_api }}capture-vision-router/multiple-file-processing.html#resumecapturing). Two new enumeration members, `CapturedStatePaused` and `CapturedStateResumed`, are added to [`CapturedState`]({{ site.dcv_enumerations }}capture-vision-router/capture-state.html?lang=android) as well. -- Added a new property [`documentSettings`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html#documentsettings) to class [`SimplifiedCaptureVisionSettings`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html). The corresponding class [`SimplifiedDocumentNormalizerSettings`]({{ site.ddn_android_api }}simplified-document-normalizer-settings.html) is added to the `DynamsoftDocumentNormalizer.aar` to store the `documentSettings`. -- Added a new prop the following methods to the [`ObservationParameters`]({{ site.dcv_android_api }}core/intermediate-results/observation-parameters.html) class to specify the `input only` result unit. - - `setResultUnitTypesOnlyForInput` - - `getResultUnitTypesOnlyForInput` -- Added the following methods to the [`RegionObjectElement`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html) class to support the intermediate result modification. - - `setLocation` - - `clone` - - `retain` - - `release` -- Added a new method `replace` to the [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html) class to support the replacement of intermediate result units. -- Added `setImageData` methods to the following classes: - - [`ColourImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/colour-image-unit.html) - - [`ScaledDownColourImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/scaled-down-colour-image-unit.html) - - [`GrayscaleImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/grayscale-image-unit.html) - - [`TransformedGrayscaleImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/transformed-grayscale-image-unit.html) - - [`EnhancedGrayscaleImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/enhanced-grayscale-image-unit.html) - - [`BinaryImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/binary-image-unit.html) - - [`TextureRemovedGrayscaleImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/texture-removed-grayscale-image-unit.html) - - [`TextureRemovedBinaryImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/texture-removed-binary-image-unit.html) - - [`TextRemovedBinaryImageUnit`]({{ site.dcv_android_api }}core/intermediate-results/text-removed-binary-image-unit.html) -- Added new methods to the [`PredetectedRegionsUnit`]({{ site.dcv_android_api }}core/intermediate-results/predetected-regions-unit.html) class to add, remove or set the predetected regions. -- Added new methods to the [`LineSegmentsUnit`]({{ site.dcv_android_api }}core/intermediate-results/line-segments-unit.html) class to add, remove or set the line segments. -- Added new methods to the [`TextZonesUnit`]({{ site.dcv_android_api }}core/intermediate-results/text-zones-unit.html) class to add, remove or set the text zones. Added a new class CTextZone to store the information of a single text zone. -- Added a new method `setContours` to the [`ContourUnit`]({{ site.dcv_android_api }}core/intermediate-results/contour-unit.html) class. -- Added new methods to the [`TextureDetectionResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/texture-detection-result-unit.html) class to set the X & Y spacing. -- Added a new intermediate result unit, [`ShortLinesUnit`]({{ site.dcv_android_api }}core/intermediate-results/short-lines-unit.html), to output the detected short lines. The corresponding enumeration member `IntermediateResultUnitTypeShortLines` is added to the [`IntermediateResultUnitType`]({{ site.dcv_enumerations }}core/intermediate-result-unit-type.html?lang=android). -- Added the following methods to the [`CapturedResultItem`]({{ site.dcv_android_api }}core/basic-structures/captured-result-item.html) class - - `getTargetROIDefName` - - `getTaskName` - - `retain` - - `release` -- Added the following new error codes - - `EC_IMAGE_SIZE_NOT_MATCH` - - `EC_IMAGE_PIXEL_FORMAT_NOT_MATCH` - - `EC_SECTION_LEVEL_RESULT_IRREPLACEABLE` - - `EC_AXIS_DEFINITION_INCORRECT` - - `EC_TEXT_LINE_GROUP_LAYOUT_CONFLICT` - - `EC_TEXT_LINE_GROUP_REGEX_CONFLICT` -- Added the following methods to the [`CapturedResult`]({{ site.dcv_android_api }}core/basic-structures/captured-result.html) class. - - `retain` - - `release` -- Added a new supported image pixel format, binary 8 inverted. The corresponding enumeration member is added to the [`ImagePixelFormat`]({{ site.dcv_enumerations }}core/image-pixel-format.html?lang=android). -- Added return value for the `retain` method of the [`IntermediateResultUnit`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-unit.html) class. The method will return the pointer of the current `IntermediateResultUnit`. - -### Breaking Changes - -- Changed the logic of the [`stopCapturing`]({{ site.dcv_android_api }}capture-vision-router/multiple-file-processing.html#stopCapturing) method. - - [`CaptureResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) will not receive results after `stopCapturing` is triggered with `waitForRemainingTasks` false. - - Support stop capturing after the [`pauseCapturing`]({{ site.dcv_android_api }}capture-vision-router/multiple-file-processing.html#pauseCapturing) method is triggered. -- Changed the logic of the [`capturedResultItemTypes`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html#capturedresultitemtypes) setting of `SimplifiedCaptureVisionSettings`: - - If the result item types don't match the specified template, the method [`updateSettings`]({{ site.dcv_android_api }}capture-vision-router/settings.html#updatesettings) will return the error code `EC_PARAMETER_VALUE_INVALID` with the message "The captured result item types do not match the task configurations in the template". - - Based on the `capturedResultItemTypes` setting, the irrelevant tasks will be removed from the template. - - The `capturedResultItemTypes` should include at least one of the `CRIT_BARCODE`, `CRIT_TEXT_LINE`, `CRIT_DETECTED_QUAD`, `CRIT_NORMALIZED_IMAGE`. Otherwise, the method `updateSettings` will return the error code `EC_PARAMETER_VALUE_INVALID` with the message "The captured result item types should contain at least one task result type". -- Refactored the [`Contour`]({{ site.dcv_android_api }}core/basic-structures/contour.html) class. Please view API reference - [`Contour`]({{ site.dcv_android_api }}core/basic-structures/contour.html) class for more information. - -### Fixed - -- Fixed a crash bug that might happen when triggering the [`setNextImageToReturn`]({{ site.dcv_android_api }}core/basic-structures/image-source-adapter.html#setnextimagetoreturn) method of the `ImageSourceAdapter` class. - -## 2.0.20 (12/12/2023) - -### New - -- Added parameter `Page` to `ImageSource` object. -- Added a new method `setPages` to the class `DirectoryFetcher` and class `FileFetcher`. -- Added `ImageSourceErrorListener` to receive the errors from an image source. -- Added method `setErrorListener` to class `ImageSourceAdapter` to add the `ImageSourceErrorListener`. -- Added a new parameter `minImageCaptureInterval` which can be set via the class `SimplifiedCaptureVisionSettings` or the `CaptureVisionTemplate` object of a JSON template file. -- Added "UNKNOWN" as a supported value of the `TextDetectionMode.direction` parameter. Changed the default value of `direction` to "UNKNOWN". -- Added the following error codes: - - EC_FILE_ALREADY_EXISTS - - EC_CREATE_FILE_FAILED - - EC_IMGAE_DATA_INVALID - -### Improved - -- The class `DirectoryFetcher` and `FileFetcher` will be able to return error codes via `ImageSourceErrorListener` -- Updated the error codes of the method `saveToFile` of the class `ImageManager`. -- Optimize the logic to support calling `IntermediateResultManager.addResultReceiver` and `IntermediateResultManager.removeResultReceiver` after `startCapturing`. -- Added ability to output all templates via methods `outputSettings` and `outputSettingsToFile` by specifying "*" for the parameter `templateName`. - -### Fixed - -- Small fixes and tweaks. - -### Changed - -- Updated the internal package dependencies rules. -- Changed the upper limit to the `duplicateForgetTime`, which is 3 minutes. -- Changed the timing of `onOriginalImageResultReceived` so that it is triggered immediately after receiving the image. - -## 2.0.10 (08/10/2023) - -{%- include release-notes/product-highlight-2.0.0.md -%} diff --git a/programming/android/release-notes/index.md b/programming/android/release-notes/index.md deleted file mode 100644 index ecbc1f1..0000000 --- a/programming/android/release-notes/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer Android SDK - Release Notes -description: This is the release notes page of Dynamsoft Document Normalizer for Android SDK. -keywords: release notes, android -needAutoGenerateSidebar: false -breadcrumbText: Release Notes -permalink: /programming/android/release-notes/index.html ---- - -# Release Notes - Android Edition - -- [2.2.11 (05/15/2024)]({{ site.android_release_notes }}android-2.html#2211-05152024) -- [2.2.10 (03/07/2024)]({{ site.android_release_notes }}android-2.html#2210-03072024) -- [2.0.20 (12/12/2023)]({{ site.android_release_notes }}android-2.html#2020-12122023) -- [2.0.10 (08/10/2023)]({{ site.android_release_notes }}android-2.html#2010-08102023) -- [1.0.30 (06/07/2023)]({{ site.android_release_notes }}android-1.html#1030-06072023) -- [1.0.21 (02/15/2023)]({{ site.android_release_notes }}android-1.html#1021-02152023) -- [1.0.20 (02/02/2023)]({{ site.android_release_notes }}android-1.html#1020-02022023) -- [1.0.10 (09/29/2022)]({{ site.android_release_notes }}android-1.html#1010-09292022) -- [1.0.0 (06/21/2022)]({{ site.android_release_notes }}android-1.html#100-06212022) diff --git a/programming/android/samples/helloworld.md b/programming/android/samples/helloworld.md deleted file mode 100644 index 6bbb81c..0000000 --- a/programming/android/samples/helloworld.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for Android - HelloWorld Sample -description: This is the HelloWorld Sample page of Dynamsoft Document Normalizer for Android SDK. -keywords: android, samples, HelloWorld -needAutoGenerateSidebar: false -breadcrumbText: HelloWorld -permalink: /programming/android/samples/helloworld.html ---- - -# HelloWorld Sample - -The Android HelloWorld sample illustrates how to create the simplest video streaming document normalizing app with Dynamsoft Document Normalizer (DDN) Android SDK. - -View the samples - -- Java HelloWorld Samples: - - [AutoNormalize](https://github.com/Dynamsoft/document-normalizer-mobile-samples/tree/main/android/HelloWorld/AutoNormalize){:target="_blank"}. - - [EditAndNormalize](https://github.com/Dynamsoft/document-normalizer-mobile-samples/tree/main/android/HelloWorld/EditAndNormalize){:target="_blank"}. -- Kotlin HelloWorld Samples: - - [AutoNormalizeKt](https://github.com/Dynamsoft/document-normalizer-mobile-samples/tree/main/android/HelloWorld/AutoNormalizeKt){:target="_blank"}. - - [EditAndNormalizeKt](https://github.com/Dynamsoft/document-normalizer-mobile-samples/tree/main/android/HelloWorld/EditAndNormalizeKt){:target="_blank"}. - -For more details about how to get started with Dynamsoft Document Normalizer, please view the [`user guide`]({{ site.android }}user-guide.html). diff --git a/programming/android/samples/index.md b/programming/android/samples/index.md deleted file mode 100644 index e1bcbf2..0000000 --- a/programming/android/samples/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for Android - Demos & Samples -description: This is the Demos & Samples page of Dynamsoft Document Normalizer for Android SDK. -keywords: android, samples -needAutoGenerateSidebar: true -breadcrumbText: Samples -permalink: /programming/android/samples/index.html ---- - -# Demo and Samples - -## Samples - -| Sample Name | Description | -| ----------- | ----------- | -| [HelloWorld](helloworld.md) | The simplest video streaming document normalizer. | - -Before you start viewing the samples, the following concepts may help you understand how to get started with Dynamsoft Document Normalizer. - -### License - -A network connection is required to verify the trial license in the samples. You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=ddn&utm_source=docs&package=android){:target="_blank"} link. If you download the [Installation Package](https://www.dynamsoft.com/document-normalizer/downloads/?product=ddn&utm_source=docs&package=android), it comes with a 30-day trial license by default. - -### Video Document Normalizing - -Most of the Dynamsoft Document Normalizer mobile samples are designed for video document normalizing. Dynamsoft Camera Enhancer (DCE) is applied to the video document scanning samples. The following features in the samples are powered by DCE: - -- Capture video frames for quadrilateral area detecting. -- Create a `Camera View` for displaying the video streaming and highlighting the real-time detected quadrilaterals. -- Create an `Image Editor View` for quadrilateral boundary editing. - -View the [API reference]({{site.dce_android }}primary-api/camera-enhancer.html) for more details. diff --git a/programming/android/upgrade-instruction-v2.0.20.md b/programming/android/upgrade-instruction-v2.0.20.md deleted file mode 100644 index 8babc7c..0000000 --- a/programming/android/upgrade-instruction-v2.0.20.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -layout: default-layout -title: Upgrade Instructions - Dynamsoft Document Normalizer Android Edition -keywords: android, document normalizer, upgrade -description: This page introduces how to upgrade Dynamsoft Document Normalizer Android Edition from 1.x to 2.x -needAutoGenerateSidebar: false -permalink: /programming/android/upgrade-instruction.html ---- - -# How to Upgrade - -## From version 1.x to 2.x - -`DynamsoftDocumentNormalizer` SDK has been revamped to integrate with `DynamsoftCaptureVision (DCV)` architecture. To upgrade from version 1.x to 2.x, we recommend that you follow the [`User Guide`](user-guide.md) and re-write your code to match what is in the guide. - -Here are some of the main actions you may take: - -### Update the Dependencies - -Since the SDK architecture has changed, you have to change your `build.gradle` to include the following libraries: - -```groovy -dependencies { - implementation 'com.dynamsoft:dynamsoftcapturevisionrouter:{version-number}' - implementation 'com.dynamsoft:dynamsoftdocumentnormalizer:{version-number}' - implementation 'com.dynamsoft:dynamsoftcameraenhancer:{version-number}' - implementation 'com.dynamsoft:dynamsoftcore:{version-number}' - implementation 'com.dynamsoft:dynamsoftlicense:{version-number}' - implementation 'com.dynamsoft:dynamsoftimageprocessing:{version-number}' - implementation 'com.dynamsoft:dynamsoftutility:{version-number}' -} -``` - ->Note: Please view [user guide](user-guide.md#add-the-library-via-maven) for the most up-to-date version number. - -### Migrate from Class DocumentNormalizer to Class CaptureVisionRouter - -The `CaptureVisionRouter` class serves as the central class of DCV's execution flow. It encompasses the following functionalities: - -- Retrieving images from the `ImageSourceAdapter`. -- Updating templates and configuring settings. -- Dynamically loading the `DynamsoftDocumentNormalizer` module for document detection and normalization. -- Dispatching the results to registered receivers of type `CapturedResultReceiver`. - -### Convert Parameter Templates - -The parameter system has been restructured and the template you used for v1.x cannot be directly recognized by v2.x (and beyond). Please contact us to upgrade your parameter template. - -### Update Your Codes - -#### Single Image Processing - -You should now utilize the provided `capture` API methods instead of the previous `detectQuad` and `normalize` API methods. These `capture` API methods directly return results for boundary detection or document normalization. - -```java -CapturedResult capture(String filePath, String templateName) throws CaptureVisionRouterException -CapturedResult capture(byte[] fileBytes, String templateName) throws CaptureVisionRouterException -CapturedResult capture(Bitmap bitmap, String templateName) throws CaptureVisionRouterException -CapturedResult capture(ImageData imageData, String templateName) throws CaptureVisionRouterException -``` - -#### Batch Image Processing - -The DCV architecture allows you to conveniently and continuously obtain frames from the `CameraEnhancer`, and then detect or normalize them. The key steps are as follows: - -- Set a `CameraEnhancer` object as the input of the `CaptureVisionRouter` object via the `setInput` API method. -- Register a `CapturedResultReceiver` object as the output of the `CaptureVisionRouter` object via the `addResultReceiver` API method. -- Open/Close camera via `CameraEnhancer.open` and `CameraEnhancer.close` API methods. -- Start/Stop capturing via `CaptureVisionRouter.startCapturing` and `CaptureVisionRouter.stopCapturing` API methods. - -```java -public class MainActivity extends AppCompatActivity { - - private CaptureVisionRouter mRouter; - private CameraView mCameraView; - private CameraEnhancer mCamera; - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - setContentView(R.layout.activity_main); - - // Add camera view for previewing video. - mCameraView = findViewById(R.id.camera_view); - - // Create an instance of Dynamsoft Camera Enhancer for video streaming. - mCamera = new CameraEnhancer(mCameraView, this); - - PermissionUtil.requestCameraPermission(MainActivity.this); - - // Create an instance of Capture Vision Router. - mRouter = new CaptureVisionRouter(this); - - try { - mRouter.setInput(mCamera); - } catch (CaptureVisionRouterException e) { - e.printStackTrace(); - } - - mRouter.addResultReceiver(new CapturedResultReceiver() { - @Override - public void onNormalizedImagesReceived(NormalizedImagesResult result) { - //TODO:... - } - }); - } - - @Override - public void onResume() { - super.onResume(); - try { - mCamera.open(); - mRouter.startCapturing(EnumPresetTemplate.PT_DETECT_AND_NORMALIZE_DOCUMENT); - } catch (CameraEnhancerException | CaptureVisionRouterException e) { - e.printStackTrace(); - } - } - - @Override - public void onPause() { - super.onPause(); - try { - mCamera.close(); - } catch (CameraEnhancerException e) { - e.printStackTrace(); - } - - mRouter.stopCapturing(); - } -} -``` diff --git a/programming/android/user-guide-v2.0.10.md b/programming/android/user-guide-v2.0.10.md deleted file mode 100644 index 72b2575..0000000 --- a/programming/android/user-guide-v2.0.10.md +++ /dev/null @@ -1,411 +0,0 @@ ---- -layout: default-layout -title: Dynamsoft Document Normalizer for Android - User Guide -description: This is the user guide of Dynamsoft Document Normalizer for Android SDK. -keywords: user guide, android -needAutoGenerateSidebar: true -needGenerateH4Content: true -noTitleIndex: true -permalink: /programming/android/user-guide-v2.0.10.html ---- - -# Getting Started with Android - -In this guide, you will learn step by step on how to build a document normalization application with Dynamsoft Document Normalizer Android SDK. - -> Read more on [Dynamsoft Document Normalizer Features](https://www.dynamsoft.com/document-normalizer/docs/core/introduction/index.html) - -- [Getting Started with Android](#getting-started-with-android) - - [Requirements](#requirements) - - [Build Your First Application](#build-your-first-application) - - [Create a New Project](#create-a-new-project) - - [Add the SDK](#add-the-sdk) - - [Add the Library Manually](#add-the-library-manually) - - [Add the Library via Maven](#add-the-library-via-maven) - - [Initialize License](#initialize-license) - - [MainActivity for Realtime Document Normalization](#mainactivity-for-realtime-document-normalization) - - [Initialize Camera Module](#initialize-camera-module) - - [Initialize Capture Vision Router](#initialize-capture-vision-router) - - [Add a Captured Result Receiver and Filter](#add-a-captured-result-receiver-and-filter) - - [Start and Stop Video Document Normalization](#start-and-stop-video-document-normalization) - - [Additional Steps in MainActivity](#additional-steps-in-mainactivity) - - [ResultActivity for Displaying the Normalized Image](#resultactivity-for-displaying-the-normalized-image) - - [Display the Normalized Image](#display-the-normalized-image) - - [Build and Run the Project](#build-and-run-the-project) - -## Requirements - -- Supported OS: Android 5.0 (API Level 21) or higher. -- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**. -- Development Environment: Android Studio 2022.2.1 or higher. - -## Build Your First Application - -In this section, let's see how to create a HelloWorld app for normalizing documents from camera video input. - ->Note: -> -> - Android Studio 2022.2.1 is used here in this guide. -> - You can get the source code of the HelloWorld app from the following link -> - [Java](https://github.com/Dynamsoft/document-normalizer-mobile-samples/tree/main/android/HelloWorld/AutoNormalize){:target="_blank"}. -> - [Kotlin](https://github.com/Dynamsoft/document-normalizer-mobile-samples/tree/main/android/HelloWorld/AutoNormalizeKt){:target="_blank"}. - -### Create a New Project - -1. Open Android Studio, select **File > New > New Project**. - -2. Choose the correct template for your project. In this sample, we use **Empty Activity**. - -3. When prompted, choose your app name 'HelloWorld' and set the **Save** location, **Language**, and **Minimum SDK** (we use 21 here). - > Note: - > - > - With **minSdkVersion** set to 21, your app is compatible with more than 94.1% of devices on the Google Play Store (last update: March 2021). - -### Add the SDK - -There are two ways to add the SDK into your project - **Manually** and **Maven**. - -#### Add the Library Manually - -1. Download the SDK package from the Dynamsoft website. After unzipping, You can find the following **aar** files under the **Dynamsoft\Libs** directory: - - | File | Description | Mandatory/Optional | - |:-----|:------------|:-------------------| - | `DynamsoftDocumentNormalizer.aar` | The Dynamsoft Document Normalizer module extracts structural information from document images, including document boundaries, shadow areas, and text areas. It uses this information to generate normalized document images through processes such as deskewing, shadow removal, and distortion correction. | Mandatory | - | `DynamsoftCore.aar` | The Dynamsoft Core module lays the foundation for Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. It encapsulates the basic classes, interfaces, and enumerations shared by these SDKs. | Mandatory | - | `DynamsoftCaptureVisionRouter.aar` | The Dynamsoft Capture Vision Router module is the cornerstone of the Dynamsoft Capture Vision (DCV) architecture. It focuses on coordinating batch image processing and provides APIs for setting up image sources and result receivers, configuring workflows with parameters, and controlling processes. | Mandatory | - | `DynamsoftImageProcessing.aar` | The Dynamsoft Image Processing module facilitates digital image processing and supports operations for other modules, including the Barcode Reader, Label Recognizer, and Document Normalizer. | Mandatory | - | `DynamsoftLicense.aar` | The Dynamsoft License module manages the licensing aspects of Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. | Mandatory | - | `DynamsoftCameraEnhancer.aar` | The [Dynamsoft Camera Enhancer]({{ site.dce_android_api }}){:target="_blank"} module controls the camera, transforming it into an image source for the DCV (Dynamsoft Capture Vision) architecture through ISA implementation. It also enhances image quality during acquisition and provides basic viewers for user interaction. | Mandatory | - | `DynamsoftUtility.aar` | The Dynamsoft Utility module defines auxiliary classes, including the ImageManager, and implementations of the CRF (Captured Result Filter) and ISA (Image Source Adapter) . These are shared by all Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. | Optional | - -2. Copy the above five **aar** files to the target directory `HelloWorld\app\libs` - -3. Open the file `HelloWorld\app\build.gradle` and add reference in the dependencies: - - ```groovy - dependencies { - implementation fileTree(dir: 'libs', include: ['*.aar']) - - def camerax_version = '1.1.0' - implementation "androidx.camera:camera-core:$camerax_version" - implementation "androidx.camera:camera-camera2:$camerax_version" - implementation "androidx.camera:camera-lifecycle:$camerax_version" - implementation "androidx.camera:camera-view:$camerax_version" - } - ``` - - > Note: - > - > DCE 4.x is based on Android CameraX, so you need to add the CameraX dependency manually. - -4. Click **Sync Now**. After the synchronization completes, the SDK is added to the project. - -#### Add the Library via Maven - -1. Open the file `HelloWorld\app\build.gradle` and add the remote repository: - - ```groovy - repositories { - maven { - url "https://download2.dynamsoft.com/maven/aar" - } - } - ``` - -2. Add reference in the dependencies: - - ```groovy - dependencies { - implementation 'com.dynamsoft:dynamsoftcapturevisionrouter:2.0.10' - implementation 'com.dynamsoft:dynamsoftdocumentnormalizer:2.0.10' - implementation 'com.dynamsoft:dynamsoftcameraenhancer:4.0.0' - implementation 'com.dynamsoft:dynamsoftutility:1.0.10' - } - ``` - -3. Click **Sync Now**. After the synchronization completes, the SDK is added to the project. - -### Initialize License - -1. Import the `LicenseManager` class and initialize the license in the file `MyApplication.java`. - - ```java - import com.dynamsoft.license.LicenseManager; - - public class MyApplication extends Application { - private static final String TAG = "MyApplication"; - private static final String LICENSE = "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9"; - - @Override - public void onCreate() { - super.onCreate(); - LicenseManager.initLicense(LICENSE, this, (isSuccess, error) -> { - if (!isSuccess) { - Log.e(TAG, "InitLicense Error: " + error); - } - }); - } - } - ``` - - >Note: - > - >- Network connection is required for the license to work. - >- The license string here will grant you a time-limited trial license. - >- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=ddn&utm_source=guide&package=android){:target="_blank"} link - -### MainActivity for Realtime Document Normalization - -#### Initialize Camera Module - -1. In the Project window, open **app > res > layout > `activity_main.xml`** and create a DCE camera view section under the root node. - - ```xml - - - ``` - -2. Import the camera module, initialize the camera view and bind to the created Camera Enhancer instance in the file `MainActivity.java`. - - ```java - ... - - import com.dynamsoft.dce.CameraView; - import com.dynamsoft.dce.CameraEnhancer; - import com.dynamsoft.dce.CameraEnhancerException; - import com.dynamsoft.dce.utils.PermissionUtil; - - public class MainActivity extends AppCompatActivity { - private CameraEnhancer mCamera; - - @Override - protected void onCreate(Bundle savedInstanceState) { - - ... - - CameraView cameraView = findViewById(R.id.camera_view); - mCamera = new CameraEnhancer(cameraView, MainActivity.this); - - PermissionUtil.requestCameraPermission(MainActivity.this); - } - } - ``` - -#### Initialize Capture Vision Router - -1. Import and initialize the capture vision router, and set the created Camera Enhancer instance as the input image source. - - ```java - ... - - import com.dynamsoft.cvr.CaptureVisionRouter; - import com.dynamsoft.cvr.CaptureVisionException; - - public class MainActivity extends AppCompatActivity { - - ... - - private CaptureVisionRouter mRouter; - - @Override - protected void onCreate(Bundle savedInstanceState) { - - ... - - mRouter = new CaptureVisionRouter(MainActivity.this); - try { - mRouter.setInput(mCamera); - } catch (CaptureVisionRouterException e) { - e.printStackTrace(); - } - } - } - ``` - -#### Add a Captured Result Receiver and Filter - -1. Add a result receiver to get the normalized image results. - - ```java - ... - - import com.dynamsoft.core.basic_structures.CapturedResultReceiver; - import com.dynamsoft.core.basic_structures.ImageData; - import com.dynamsoft.cvr.EnumPresetTemplate; - import com.dynamsoft.ddn.NormalizedImagesResult; - - public class MainActivity extends AppCompatActivity { - - ... - - public static ImageData mNormalizedImageData; - private boolean mJumpToOtherActivity = false; - - @Override - protected void onCreate(Bundle savedInstanceState) { - - ... - - mRouter.addResultReceiver(new CapturedResultReceiver() { - @Override - public void onNormalizedImagesReceived(NormalizedImagesResult result) { - if (mJumpToOtherActivity && result.getItems().length > 0) { - mJumpToOtherActivity = false; - - mNormalizedImageData = result.getItems()[0].getImageData(); - - Intent intent = new Intent(MainActivity.this, ResultActivity.class); - startActivity(intent); - } - } - }); - } - } - ``` - -2. Add a result cross filter to validate the normalized image result across multiple frames. - - ```java - ... - - import com.dynamsoft.utility.MultiFrameResultCrossFilter; - - public class MainActivity extends AppCompatActivity { - - ... - - @Override - protected void onCreate(Bundle savedInstanceState) { - - ... - - MultiFrameResultCrossFilter filter = new MultiFrameResultCrossFilter(); - filter.enableResultCrossVerification(CRIT_NORMALIZED_IMAGE, true); - mRouter.addResultFilter(filter); - } - } - ``` - -#### Start and Stop Video Document Normalization - -1. Override the `MainActivity.onResume` function to open camera and start video document normalization, override the `MainActivity.onPause` function to close camera and stop video document normalization. - - ```java - public class MainActivity extends AppCompatActivity { - - ... - - @Override - public void onResume() { - super.onResume(); - try { - mCamera.open(); - mRouter.startCapturing(EnumPresetTemplate.PT_DETECT_AND_NORMALIZE_DOCUMENT); - } catch (CameraEnhancerException | CaptureVisionRouterException e) { - e.printStackTrace(); - } - } - - @Override - public void onPause() { - super.onPause(); - try { - mCamera.close(); - } catch (CameraEnhancerException e) { - e.printStackTrace(); - } - - mRouter.stopCapturing(); - } - } - ``` - -2. Add `onCaptureBtnClick` function to start the video document normalization. After start capturing, the SDK will process the video frames from the Camera Enhancer, then send the normalized image results to the registered result receiver. - - ```java - public class MainActivity extends AppCompatActivity { - - ... - - public void onCaptureBtnClick(View v) { - mJumpToOtherActivity = true; - } - } - ``` - -#### Additional Steps in MainActivity - -1. In the Project window, open **app > res > layout > `activity_main.xml`**, create a button under the root node to capture the quads detected on the image. - - ```xml - ... - -