Merge pull request #51 from dynamsoft-docs/preview

Preview

Author: Dynamsoft-Jerson

_includes/api-reference/drawing-item-ios.md

@@ -6,29 +6,56 @@
 
 The property that identifies the ID of the `DrawingStyle`.
 
+<div class="sample-code-prefix"></div>
+>- Objective-C
+>- Swift
+>
+>1. 
 ```objc
 @property (assign, nonatomic) NSInteger drawingStyleId;
 ```
+2. 
+```swift
+var drawingStyleId: Int { get set }
+```
 
 &nbsp;
 
 ## state
 
 The property that indicates the state of the `DrawingItem`. View all available `DrawingItem` states in [`EnumDrawingItemState`]({{ site.ios_camera_enhancer }}enum-drawing-item-state.html).
 
+<div class="sample-code-prefix"></div>
+>- Objective-C
+>- Swift
+>
+>1. 
 ```objc
 @property (assign, nonatomic) EnumDrawingItemState state;
 ```
+2. 
+```swift
+var state: EnumDrawingItemState { get set }
+```
 
 &nbsp;
 
 ## getMediaType
 
 Get the media type of the `DrawingItem`.
 
+<div class="sample-code-prefix"></div>
+>- Objective-C
+>- Swift
+>
+>1. 
 ```objc
 - (EnumDrawingItemMediaType) getMediaType;
 ```
+2. 
+```swift
+func getMediaType() -> EnumDrawingItemMediaType
+```
 
 **Return Value**
 

assets/visible-region.png

@@ -321,7 +321,7 @@ Get the visible region of the video streaming.
 When the shape of your camera view is quite different from the shape of the video streaming, there might exist a large area that is invisible. You can use this method to get the region of this invisible area.
 
 <div align="center">
-    <p><img src="../../assets/visible-region.png" width="30%" alt="visible-region"></p>
+    <p><img src="../../../../assets/visible-region.png" width="30%" alt="visible-region"></p>
     <p>What's Visible Region</p>
 </div>
 

programming/android/api-reference/camera-enhancer/dcecameraview.md

@@ -209,7 +209,7 @@ try {
 
     DetectedQuadResult[] quads = normalizer.detectQuad(buffer);
     if(quads.length > 0) {
-      NormalizedImageResult normalizedImage = normalizer.normalize(buffer, quads[0]);
+      NormalizedImageResult normalizedImage = normalizer.normalize(buffer, quads[0].location);
     }
 } catch (DocumentNormalizerException e) {
     e.printStackTrace();
@@ -247,7 +247,7 @@ try {
 
     DetectedQuadResult[] quads = normalizer.detectQuad(imageFilePath);
     if(quads.length > 0) {
-      NormalizedImageResult normalizedImage = normalizer.normalize(imageFilePath, quads[0]);
+      NormalizedImageResult normalizedImage = normalizer.normalize(imageFilePath, quads[0].location);
     }
 } catch (DocumentNormalizerException e) {
     e.printStackTrace();
@@ -286,7 +286,7 @@ try {
 
     DetectedQuadResult[] quads = normalizer.detectQuad(bitmap);
     if(quads.length > 0) {
-      NormalizedImageResult normalizedImage = normalizer.normalize(bitmap, quads[0]);
+      NormalizedImageResult normalizedImage = normalizer.normalize(bitmap, quads[0].location);
     }
 } catch (DocumentNormalizerException e) {
     e.printStackTrace();

programming/android/api-reference/document-normalizer-normalizing.md

@@ -108,5 +108,5 @@ The output JSON string which stores the contents of runtime settings.
 
 ```java
 DocumentNormalizer reader = new DocumentNormalizer();
-String settingStr = reader.outputSettingsToString("");
+String settingStr = reader.outputRuntimeSettings("");
 ```

programming/android/api-reference/document-normalizer-settings.md

@@ -4,43 +4,17 @@ 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
 ---
 
 
 # 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 |
-|--------|-------------|
-| [`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
+## How to Implement Video Detecting
 
-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**
-
-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.
+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;
@@ -103,7 +77,46 @@ public void onPause() {
 }
 ```
 
-## startDetecting
+> 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`.
 
@@ -113,9 +126,11 @@ void startDetecting()
 
 **Code Snippet**
 
-You can view the complete code snippet in [`setImageSource`](#setimagesource).
+```java
+normalizer.startDetecting();
+```
 
-## stopDetecting
+### stopDetecting
 
 Stop the document quad detection thread in the video streaming scenario.
 
@@ -125,9 +140,11 @@ void stopDetecting()
 
 **Code Snippet**
 
-You can view the complete code snippet in [`setImageSource`](#setimagesource).
+```java
+normalizer.startDetecting();
+```
 
-## setDetectResultListener
+### setDetectResultListener
 
 Set the callback interface to process detection results generated during frame detecting.
 
@@ -141,4 +158,14 @@ void setDetectResultListener(DetectResultListener detectResultListener)
 
 **Code Snippet**
 
-You can view the complete code snippet in [`setImageSource`](#setimagesource).
+```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);
+```

programming/android/api-reference/document-normalizer-video.md

@@ -664,7 +664,7 @@ let frameRate = dce.getFrameRate()
 Input one of the preset resolution value in Enumeration `Resolution`. The camera enhancer will try to set the resolution to the target value or the closest available value below the target value.
 
 ```objc
-- (Void)setResolution:(Resolution)resolution;
+- (void)setResolution:(Resolution)resolution;
 ```
 
 **Parameters**
@@ -722,7 +722,7 @@ let resolution = dce.getResolution()
 Set the zoom factor. Once `setZoom` is triggered and approved, the zoom factor of the activated camera will immediately become the input value.
 
 ```objc
-- (Void)setZoom:(CGFloat)factor
+- (void)setZoom:(CGFloat)factor
 ```
 
 **Parameters**
@@ -751,7 +751,7 @@ dce.setZoom(3.0)
 Set the focus position (value range from 0.0f to 1.0f) and trigger a focus at the configured position.
 
 ```objc
-- (Void)setFocus:(CGPoint)focusPosition;
+- (void)setFocus:(CGPoint)focusPosition;
 ```
 
 **Parameters**

programming/ios/api-reference/camera-enhancer/camera-enhancer-v3.0.0.md

@@ -225,7 +225,11 @@ Select the camera position (front-facing or back-facing).
 ```
 2. 
 ```swift
-try? dce.selectCameraWithPosition(EnumCameraPosition.back)
+do{
+   try dce.selectCameraWithPosition(EnumCameraPosition.back)
+}catch{
+   // Add your code to deal with the exceptions.
+}
 ```
 
  
@@ -283,7 +287,11 @@ Select camera by `cameraID`. The camera will be selected and further camera cont
 ```
 2. 
 ```swift
-try? dce.selectCamera("BACK_FACING_CAMERA")
+do{
+   try dce.selectCamera("BACK_FACING_CAMERA")
+catch{
+   // Add your code to deal with the exceptions.
+}
 ```
 
 **Remarks**
@@ -684,7 +692,11 @@ The `EnumEnhancerFeatures` members:
 ```
 2. 
 ```swift
-try? dce.enableFeatures(EnumEnhancerFeature.EnumFRAME_FILTER.rawValue)
+do{
+   try dce.enableFeatures(EnumEnhancerFeature.EnumFRAME_FILTER.rawValue)
+catch{
+   // Add your code to deal with the exceptions.
+}
 ```
 
 **Remarks**
@@ -800,7 +812,7 @@ let frameRate = dce.getFrameRate()
 Input one of the preset resolution value in Enumeration `Resolution`. The camera enhancer will try to set the resolution to the target value or the closest available value below the target value.
 
 ```objc
-- (Void)setResolution:(Resolution)resolution;
+- (void)setResolution:(Resolution)resolution;
 ```
 
 **Parameters**
@@ -858,7 +870,7 @@ let resolution = dce.getResolution()
 Set the zoom factor. Once `setZoom` is triggered and approved, the zoom factor of the activated camera will immediately become the input value.
 
 ```objc
-- (Void)setZoom:(CGFloat)factor
+- (void)setZoom:(CGFloat)factor
 ```
 
 **Parameters**
@@ -916,7 +928,7 @@ let maxZoomFactor = dce.getMaxZoomFactor()
 Set the focus position (value range from 0.0f to 1.0f) and trigger a focus at the configured position.
 
 ```objc
-- (Void)setFocus:(CGPoint)focusPosition;
+- (void)setFocus:(CGPoint)focusPosition;
 ```
 
 **Parameters**
@@ -978,7 +990,11 @@ scanRegion.regionBottom = 75
 scanRegion.regionLeft = 25
 scanRegion.regionRight = 75
 scanRegion.regionMeasuredByPercentage = 1
-try? dce.setScanRegion(scanRegion)
+do{
+   try dce.setScanRegion(scanRegion)
+catch{
+   // Add your code to deal with the exceptions.
+}
 ```
 
 **Remarks**
@@ -1058,7 +1074,11 @@ Update the advanced camera controlling and video streaming processing parameters
 ```
 2. 
 ```swift
-try? dce.updateAdvancedSettingsFromFile("Put your JSON file path here.")
+do{
+   try dce.updateAdvancedSettingsFromFile("Put your JSON file path here.")
+catch{
+   // Add your code to deal with the exceptions.
+}
 ```
 
 **Remarks**
@@ -1091,5 +1111,9 @@ Update the advanced camera controlling and video streaming processing parameters
 ```
 2. 
 ```swift
-try? dce.updateAdvancedSettingsFromString("Put your stringified JSON data here.")
+do{
+   try dce.updateAdvancedSettingsFromString("Put your stringified JSON data here.")
+catch{
+   // Add your code to deal with the exceptions.
+}
 ```