Skip to content

Commit 4193c45

Browse files
Dynamsoft-HenryDynamsoft-Henry
committed
Updating side list, contents
1 parent b14a4b3 commit 4193c45

2 files changed

Lines changed: 66 additions & 162 deletions

File tree

‎_includes/sidelist-programming/programming-android.html‎

Lines changed: 66 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,56 +4,60 @@
44
<ul lang="android">
55
<li lang="android"><a href="{{ site.android }}user-guide/license-activation.html" class="otherLinkColour">License Initialization</a></li>
66
<li lang="android"><a href="{{ site.android }}user-guide.html" class="otherLinkColour">Quick Start</a></li>
7-
<li lang="android"><a href="{{ site.android }}foundational-guide.html" class="otherLinkColour">Full-Feature Development</a></li>
8-
</ul>
9-
</li>
10-
11-
<li lang="android"><a href="{{ site.android }}user-guide/concept/capture-vision-architecture.html" class="otherLinkColour">Core Concepts</a></li>
12-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/index.html" class="otherLinkColour">Functionality & Capabilities</a>
13-
<ul>
14-
<li lang="android"><a class="otherLinkColour">Input Management</a>
15-
<ul lang="android">
16-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/read-from-camera.html" class="otherLinkColour">Read from Camera</a></li>
17-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/read-from-an-image.html" class="otherLinkColour">Read from Image</a></li>
18-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/camera-control.html" class="otherLinkColour">Camera Control</a></li>
19-
</ul>
20-
</li>
21-
<li lang="android"><a class="otherLinkColour">Scanning Control</a>
22-
<ul lang="android">
23-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/barcode-formats.html" class="otherLinkColour">Configure Barcode Format</a></li>
24-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/single-multiple.html" class="otherLinkColour">Switch Single & Multiple</a></li>
25-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/read-specific-area.html" class="otherLinkColour">Read a specific area/region</a></li>
26-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/config-simplified-settings.html" class="otherLinkColour">Configure Simplified Settings</a></li>
27-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/init-customized-template.html" class="otherLinkColour">Initialize Customized Template</a></li>
28-
</ul>
29-
</li>
30-
<li lang="android"><a class="otherLinkColour">Result Handling</a>
31-
<ul lang="android">
32-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/receive-results.html" class="otherLinkColour">Receive Results</a></li>
33-
<li lang="android"><a href="{{ site.features }}filter-and-sort.html?lang=android" class="otherLinkColour">Parameter Based Result Filter</a></li>
34-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/get-original-image.html" class="otherLinkColour">Get Original Image</a></li>
35-
<li lang="android"><a href="{{ site.features }}get-detailed-info.html?lang=android" class="otherLinkColour">Get Detailed Barcode Information</a></li>
36-
<li lang="android"><a href="{{ site.features }}get-confidence-rotation.html?lang=android" class="otherLinkColour">Get Barcode Confidence and Rotation</a></li>
37-
<li lang="android"><a href="{{ site.features }}get-barcode-location.html?lang=android" class="otherLinkColour">Get Barcode Location</a></li>
38-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/multi-frame-cross-filter.html" class="otherLinkColour">Multi-Frame Cross Filter</a></li>
39-
</ul>
40-
</li>
41-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/customize-ui-index.html" class="otherLinkColour">UI & UX Customization</a>
42-
<ul lang="android">
43-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/add-functional-buttons.html" class="otherLinkColour">Add Functional Buttons</a></li>
44-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/add-graphics.html" class="otherLinkColour">Customize Overly with DrawingItems</a></li>
45-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/scan-region-style.html" class="otherLinkColour">Scan Region Style</a></li>
46-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/feedback.html" class="otherLinkColour">User Feedback</a></li>
47-
</ul>
48-
</li>
49-
<li lang="android"><a class="otherLinkColour">Data Parsing</a>
7+
<li lang="android"><a class="otherLinkColour">Full-Feature Development</a>
508
<ul lang="android">
51-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/parse-drivers-license.html" class="otherLinkColour">Parse Drivers' License</a></li>
52-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/parse-gs1.html" class="otherLinkColour">Parse GS1 AI</a></li>
9+
<li lang="android"><a href="{{ site.android }}foundational-guide.html" class="otherLinkColour">Build Your First APP</a>
10+
<li lang="android"><a href="{{ site.android }}user-guide/concept/capture-vision-architecture.html" class="otherLinkColour">Core Concepts</a></li>
11+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/index.html" class="otherLinkColour">Functionality & Capabilities</a>
12+
<ul>
13+
<li lang="android"><a class="otherLinkColour">Input Management</a>
14+
<ul lang="android">
15+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/read-from-camera.html" class="otherLinkColour">Read from Camera</a></li>
16+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/read-from-an-image.html" class="otherLinkColour">Read from Image</a></li>
17+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/camera-control.html" class="otherLinkColour">Camera Control</a></li>
18+
</ul>
19+
</li>
20+
<li lang="android"><a class="otherLinkColour">Scanning Control</a>
21+
<ul lang="android">
22+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/barcode-formats.html" class="otherLinkColour">Configure Barcode Format</a></li>
23+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/single-multiple.html" class="otherLinkColour">Switch Single & Multiple</a></li>
24+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/read-specific-area.html" class="otherLinkColour">Read a specific area/region</a></li>
25+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/config-simplified-settings.html" class="otherLinkColour">Configure Simplified Settings</a></li>
26+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/init-customized-template.html" class="otherLinkColour">Initialize Customized Template</a></li>
27+
</ul>
28+
</li>
29+
<li lang="android"><a class="otherLinkColour">Result Handling</a>
30+
<ul lang="android">
31+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/receive-results.html" class="otherLinkColour">Receive Results</a></li>
32+
<li lang="android"><a href="{{ site.features }}filter-and-sort.html?lang=android" class="otherLinkColour">Parameter Based Result Filter</a></li>
33+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/get-original-image.html" class="otherLinkColour">Get Original Image</a></li>
34+
<li lang="android"><a href="{{ site.features }}get-detailed-info.html?lang=android" class="otherLinkColour">Get Detailed Barcode Information</a></li>
35+
<li lang="android"><a href="{{ site.features }}get-confidence-rotation.html?lang=android" class="otherLinkColour">Get Barcode Confidence and Rotation</a></li>
36+
<li lang="android"><a href="{{ site.features }}get-barcode-location.html?lang=android" class="otherLinkColour">Get Barcode Location</a></li>
37+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/multi-frame-cross-filter.html" class="otherLinkColour">Multi-Frame Cross Filter</a></li>
38+
</ul>
39+
</li>
40+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/customize-ui-index.html" class="otherLinkColour">UI & UX Customization</a>
41+
<ul lang="android">
42+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/add-functional-buttons.html" class="otherLinkColour">Add Functional Buttons</a></li>
43+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/add-graphics.html" class="otherLinkColour">Customize Overly with DrawingItems</a></li>
44+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/scan-region-style.html" class="otherLinkColour">Scan Region Style</a></li>
45+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/feedback.html" class="otherLinkColour">User Feedback</a></li>
46+
</ul>
47+
</li>
48+
<li lang="android"><a class="otherLinkColour">Data Parsing</a>
49+
<ul lang="android">
50+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/parse-drivers-license.html" class="otherLinkColour">Parse Drivers' License</a></li>
51+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/parse-gs1.html" class="otherLinkColour">Parse GS1 AI</a></li>
52+
</ul>
53+
</li>
54+
</ul>
55+
</li>
5356
</ul>
5457
</li>
5558
</ul>
5659
</li>
60+
5761
<li lang="android"><a class="otherLinkColour">Optimizations for Challenging Cases</a>
5862
<ul lang="android">
5963
<li lang="android"><a href="{{ site.features }}read-inverted-barcodes.html?lang=android" class="otherLinkColour">Read inverted barcodes</a></li>
@@ -76,6 +80,23 @@
7680

7781
<li lang="android"><a href="{{ site.dbr_android_api }}" class="otherLinkColour">API References</a>
7882
<ul lang="android">
83+
<li lang="android"><a href="{{ site.dbr_android_api }}barcode-scanner/barcode-scan-result.html" class="otherLinkColour">BarcodeScanner</a>
84+
<ul lang="android">
85+
<li lang="android"><a class="otherLinkColour">Classes</a>
86+
<ul lang="android">
87+
<li lang="android"><a href="{{ site.dbr_android_api }}barcode-scanner/barcode-scan-result.html" class="otherLinkColour"></a></li>
88+
<li lang="android"><a href="{{ site.dbr_android_api }}barcode-scanner/barcode-scanner-activity.html" class="otherLinkColour"></a></li>
89+
<li lang="android"><a href="{{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html" class="otherLinkColour"></a></li>
90+
</ul>
91+
</li>
92+
<li lang="android"><a class="otherLinkColour">Enumerations</a>
93+
<ul lang="android">
94+
<li lang="android"><a href="{{ site.dbr_android_api }}barcode-scanner/enum-result-status.html" class="otherLinkColour"></a></li>
95+
<li lang="android"><a href="{{ site.dbr_android_api }}barcode-scanner/enum-scanning-mode.html" class="otherLinkColour"></a></li>
96+
</ul>
97+
</li>
98+
</ul>
99+
</li>
79100
<li lang="android"><a>Orchestration</a>
80101
<ul lang="android">
81102
<li lang="android"><a>DynamsoftCaptureVisionRouter</a>

‎programming/android/user-guide.md‎

Lines changed: 0 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -403,120 +403,3 @@ Now that the code has been written and the project complete, it's time to run th
403403
## Conclusion
404404

405405
Now that your `BarcodeScanner` project is up and running you should be able to see a clean and simplified UI that contains all the necessary UI elements that are needed to make the barcode scanning process as easy and intuitive for the user as it can be.
406-
407-
## Key APIs
408-
409-
### BarcodeScannerConfig
410-
411-
Configurations for `BarcodeScanner` component.
412-
413-
| Method | Description |
414-
| ------ | ----------- |
415-
| `setLicense` | Sets the license key for the Barcode Reader. |
416-
| `getLicense` | Returns the license key string. |
417-
| `setScanningMode` | Sets the scanning mode. |
418-
| `getScanningMode` | Returns the scanning mode. |
419-
| `setTemplateFile` | Sets the template with a file path or a JSON string. |
420-
| `getTemplateFile` | Returns the template with a file path or a JSON string. |
421-
| `setBarcodeFormats` | Sets the barcode format(s) to read. |
422-
| `getBarcodeFormats` | Returns the barcode format(s) that the library will accept. |
423-
| `setScanRegion` | Sets a scan region where only the barcodes located in the scan region can be decoded. |
424-
| `getScanRegion` | Returns the scan region. |
425-
| `setTorchButtonVisible` | Sets whether to display the torch button when scanning or not. |
426-
| `isTorchButtonVisible` | Returns whether the button is visible. |
427-
| `setBeepEnabled` | Sets whether to trigger a beep sound when a barcode is detected. |
428-
| `isBeepEnabled` | Returns whether the beep sound is enabled. |
429-
| `setVibrateEnabled` | Sets whether to trigger a vibration when a barcode is detected. |
430-
| `isVibrateEnabled` | Returns whether the vibration is enabled. |
431-
| `setScanLaserVisible` | Sets whether to display a scan laser when scanning. |
432-
| `isScanLaserVisible` | Returns whether the scan laser is visible. |
433-
| `setAutoZoomEnabled` | Sets whether to enable the auto-zoom feature when scanning. |
434-
| `isAutoZoomEnabled` | Returns whether the auto-zoom feature is enabled. |
435-
| `setCloseButtonVisible` | Sets whether to display a button that can close the scanner page. |
436-
| `isCloseButtonVisible` | Returns whether the close button is visible. |
437-
| `setMaxConsecutiveStableFramesToExit` | Sets how long the library will keep scanning when there is no more barcodes to decode. |
438-
| `getMaxConsecutiveStableFramesToExit` | Returns the maximum number of consecutive stable frames to exit. |
439-
| `setExpectedBarcodesCount` | Sets the expected number of barcodes. The multiple barcodes scanning will be stopped when the `expectedBarcodesCount` is reached. |
440-
| `getExpectedBarcodesCount` | Returns the expected number of barcodes. |
441-
| `setCameraToggleButtonVisible` | Sets whether to display the camera toggle button. |
442-
| `isCameraToggleButtonVisible` | Returns whether the camera toggle button is visible. |
443-
| `setZoomFactor` | Sets the zoom factor. |
444-
| `getZoomFactor` | Returns the zoom factor. |
445-
| `setResolution` | Sets the resolution. |
446-
| `getResolution` | Returns the resolution. |
447-
448-
```java
449-
public void setLicense(String license) {}
450-
public String getLicense() {}
451-
@EnumScanningMode
452-
public void setScanningMode(@EnumScanningMode int scanningMode){}
453-
public int getScanningMode(){}
454-
public void setTemplateFile(String templateFile){}
455-
public String getTemplateFile(){}
456-
public void setBarcodeFormats(long format) {}
457-
@EnumBarcodeFormat
458-
public long getBarcodeFormats() {}
459-
public void setScanRegion(DSRect scanRegion){}
460-
public DSRect getScanRegion(){}
461-
public void setTorchButtonVisible(boolean flashButtonVisible) {}
462-
public boolean isTorchButtonVisible() {}
463-
public void setBeepEnabled(boolean beepEnabled) {}
464-
public boolean isBeepEnabled() {}
465-
public void setVibrateEnabled(boolean vibrationEnabled) {}
466-
public boolean isVibrateEnabled() {}
467-
public void setScanLaserVisible(boolean scanLaserVisible) {}
468-
public boolean isScanLaserVisible() {}
469-
public void setAutoZoomEnabled(boolean autoZoomEnabled) {}
470-
public boolean isAutoZoomEnabled() {}
471-
public void setCloseButtonVisible(boolean closeButtonVisible) {}
472-
public boolean isCloseButtonVisible() {}
473-
public void setMaxConsecutiveStableFramesToExit(int maxConsecutiveStableFramesToExit){}
474-
public int getMaxConsecutiveStableFramesToExit(){}
475-
public void setExpectedBarcodesCount(int expectedBarcodesCount) {}
476-
public int getExpectedBarcodesCount() {}
477-
public void setCameraToggleButtonVisible(boolean cameraToggleButtonVisible) {}
478-
public boolean isCameraToggleButtonVisible() {}
479-
public void setZoomFactor(float zoomFactor) {}
480-
public float getZoomFactor() {}
481-
public void setResolution(@EnumResolution int resolution) {}
482-
@EnumResolution
483-
public int getResolution() {}
484-
```
485-
486-
### BarcodeScanResult
487-
488-
Result object produced by the `BarcodeScanner` component.
489-
490-
| Method | Description |
491-
| ------ | ----------- |
492-
| `getBarcodes` | Returns an array of [`BarcodeResultItem`]({{ site.dbr_android_api }}barcode-result-item.html), which represents a single barocde result. |
493-
| `getResultStatus` | Returns the status of the `BarcodeScanResult`, of type [`EnumResultStatus`](#enumresultstatus). |
494-
| `getErrorCode` | Returns the error code should something go wrong during the barcode recognition process. |
495-
| `getErrorString` | Returns the error message associated with the error code should something go wrong during the barcode recognition process. |
496-
497-
```java
498-
public BarcodeResultItem[] getBarcodes() {}
499-
@EnumResultStatus
500-
public int getResultStatus() {}
501-
public int getErrorCode() {}
502-
public String getErrorString() {}
503-
```
504-
505-
### EnumScanningMode
506-
507-
Enumeration for specifying the scanning mode.
508-
509-
| Member | Description |
510-
| ------ | ----------- |
511-
| `SM_SINGLE` | The scan mode for scanning single barcode. |
512-
| `SM_MULTIPLE` | The scan mode for scanning multiple barcodes. |
513-
514-
### EnumResultStatus
515-
516-
Enumeration that represents the result status of the `BarcodeScanResult`.
517-
518-
| Member | Description |
519-
| ------ | ----------- |
520-
| `RS_FINISHED` | The barcode scanning is finished. You can get at least one result from the `BarcodeScanResult`. |
521-
| `RS_CANCELED` | The barcode scanning activity is closed before the process is finished. No results are available. |
522-
| `RS_EXCEPTION` | Failed to start barcode scanning or an error occurs when scanning the barcodes. No results are available. |

0 commit comments

Comments
 (0)