Merge pull request #9 from Dynamsoft/_dev

3.3.0

Author: Cube

Api Reference.url

@@ -1,2 +1,2 @@
 [InternetShortcut]
-URL=https://www.dynamsoft.com/camera-enhancer/docs/programming/javascript/api-reference/?ver=3.2.0
+URL=https://www.dynamsoft.com/camera-enhancer/docs/programming/javascript/api-reference/?ver=3.3.0

LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2003–2022 Dynamsoft. All Rights Reserved.
+Copyright © 2003–2023 Dynamsoft. All Rights Reserved.
 
 The use of this software is governed by the Dynamsoft Terms and Conditions.
 https://www.dynamsoft.com/company/license-agreement/

README.md

@@ -53,7 +53,7 @@ The simplest way to include the SDK is to use either the [jsDelivr](https://jsde
   <script src="https://unpkg.com/dynamsoft-camera-enhancer/dist/dce.js"></script>
   ```
 
-> In some rare cases, you might not be able to access the CDN. If this happens, you can use [https://download2.dynamsoft.com/dce/dynamsoft-camera-enhancer-js/dynamsoft-camera-enhancer-js-3.2.0/dist/dce.js](https://download2.dynamsoft.com/dce/dynamsoft-camera-enhancer-js/dynamsoft-camera-enhancer-js-3.2.0/dist/dce.js)
+> In some rare cases, you might not be able to access the CDN. If this happens, you can use [https://download2.dynamsoft.com/dce/dynamsoft-camera-enhancer-js/dynamsoft-camera-enhancer-js-3.3.0/dist/dce.js](https://download2.dynamsoft.com/dce/dynamsoft-camera-enhancer-js/dynamsoft-camera-enhancer-js-3.3.0/dist/dce.js)
 
 #### Host the SDK yourself
 
@@ -80,7 +80,7 @@ The following shows a few ways to download the SDK.
 Depending on how you downloaded the SDK and where you put it. You can typically include it like this:
 
 ```html
-<script src="/dce-js-3.2.0/dist/dce.js"></script>
+<script src="/dynamsoft-camera-enhancer-js-3.3.0/dist/dce.js"></script>
 ```
 
 or
@@ -89,7 +89,7 @@ or
 <script src="/node_modules/dynamsoft-camera-enhancer/dist/dce.js"></script>
 ```
 
-or 
+or
 
 ```typescript
 import { CameraEnhancer } from 'dynamsoft-camera-enhancer';
@@ -128,18 +128,18 @@ As shown in the code snippet below, before opening the video stream, we need to
 
 The built-in UI of the `CameraEnhancer` object is defined in the file `dist/dce.ui.html` . There are a few ways to customize it:
 
-* Modify the file `dist/dce.ui.html` directly.
+- Modify the file `dist/dce.ui.html` directly.
 
   This option is only possible when you host this file on your own web server instead of using a CDN.
 
-* Copy the file `dist/dce.ui.html` to your project, modify it and use the the API `defaultUIElementURL` to set it as the default UI.
+- Copy the file `dist/dce.ui.html` to your project, modify it and use the the API `defaultUIElementURL` to set it as the default UI.
 
 ```javascript
 // To make sure the following line takes effect, put it before the API `open()` is called.
 Dynamsoft.DCE.CameraEnhancer.defaultUIElementURL = "THE-URL-TO-THE-FILE";
 ```
 
-* Append the default UI element to your page as shown in [Configure the CameraEnhancer object](#configure-the-cameraenhancer-object), customize it if necessary.
+- Append the default UI element to your page as shown in [Configure the CameraEnhancer object](#configure-the-cameraenhancer-object), customize it if necessary.
 
 ```html
 <!-- Define an element to hold the UI element -->
@@ -158,9 +158,9 @@ Dynamsoft.DCE.CameraEnhancer.defaultUIElementURL = "THE-URL-TO-THE-FILE";
 </script>
 ```
 
-* Build the UI element into your own web page and specify it with the API `setUIElement(HTMLElement)`.
+- Build the UI element into your own web page and specify it with the API `setUIElement(HTMLElement)`.
 
-  * Embed only the video
+  - Embed only the video
 
   ```html
   <div id="enhancerUIContainer" style="width:100%;height:100%;">
@@ -177,7 +177,7 @@ Dynamsoft.DCE.CameraEnhancer.defaultUIElementURL = "THE-URL-TO-THE-FILE";
 
   > The video element will be created and appended to the DIV element with the class `dce-video-container`, make sure the class name is the same. Besides, the CSS property `position` of the DIV element must be either `relative`, `absolute`, `fixed`, or `sticky`.
 
-  * Add the camera list and resolution list. If the class names for these lists match the default ones,  `dce-sel-camera` and `dce-sel-resolution` , the SDK will automatically populate the lists and handle the camera/resolution switching.
+  - Add the camera list and resolution list. If the class names for these lists match the default ones,  `dce-sel-camera` and `dce-sel-resolution` , the SDK will automatically populate the lists and handle the camera/resolution switching.
 
   ```html
   <select class="dce-sel-camera"></select>
@@ -205,13 +205,13 @@ Dynamsoft.DCE.CameraEnhancer.defaultUIElementURL = "THE-URL-TO-THE-FILE";
 
 Once you have downloaded the SDK, you can locate the "dist" directory and copy it to your project (usually as part of your website / web application). The following shows some of the files in this directory:
 
-* `dce.js` // The main SDK file
-* `dce.mjs` // For using the SDK as a module (`<script type="module">`)
-* `dce.ui.html` // Defines the default enhancer UI
+- `dce.js` // The main SDK file
+- `dce.mjs` // For using the SDK as a module (`<script type="module">`)
+- `dce.ui.html` // Defines the default enhancer UI
 
 ### Step Two: Configure the Server
 
-* Enable HTTPS
+- Enable HTTPS
 
   To use the SDK, you must access your website / web application via a secure HTTPS connection. This is due to browser security restrictions which only grant camera video streaming access to a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts).
 
@@ -229,26 +229,28 @@ Now that the SDK is hosted on your server, you can include it accordingly.
 
 ### Can I open the web page directly from the hard drive?
 
-Yes, for simple testing purposes, it's perfectly fine to open the file directly from the hard drive. However, you might encounter some issues in doing so (like unable to access the camera, etc.). The recommendation is to deploy this page to your web server and run it over **HTTPS**. If you don't have a ready-to-use web server but have a package manager like *npm* or *yarn*, you can set up a simple HTTP server in minutes. Check out [`http-server` on npm](https://www.npmjs.com/package/http-server) or [yarn](https://yarnpkg.com/package/http-server).
+Yes, for simple testing purposes, it's ok to open the file directly from the hard drive (`file://`). However, you might encounter some issues in doing so (like unable to access the camera, etc.). The recommendation is to deploy this page to your web server and run it over **HTTPS** or use "http://localhost" during development.
+
+If you don't have a ready-to-use web server but have a package manager like *npm* or *yarn*, you can set up a simple HTTP server in minutes. Check out [`http-server` on npm](https://www.npmjs.com/package/http-server) or [yarn](https://yarnpkg.com/package/http-server).
 
 ### Why can't I use my camera?
 
 If you open the web page as `http://` , the camera may not work and you see the following error in the browser console:
 
 > [Deprecation] getUserMedia() no longer works on insecure origins. To use this feature, you should consider switching your application to a secure origin, such as HTTPS. See [https://goo.gl/rStTGz](https://goo.gl/rStTGz) for more details.
 
-* In Safari 12 the equivalent error is:
+- In Safari 12 the equivalent error is:
 
 > Trying to call getUserMedia from an insecure document.
 
 You get this error because the API [getUserMedia](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) requires HTTPS to access the camera.
 
 To make sure your web application can access the camera, please configure your web server to support HTTPS. The following links may help.
 
-* NGINX: [Configuring HTTPS servers](https://nginx.org/en/docs/http/configuring_https_servers.html)
-* IIS: [Create a Self Signed Certificate in IIS](https://aboutssl.org/how-to-create-a-self-signed-certificate-in-iis/)
-* Tomcat: [Setting Up SSL on Tomcat in 5 minutes](https://dzone.com/articles/setting-ssl-tomcat-5-minutes)
-* Node.js: [npm tls](https://nodejs.org/docs/v0.4.1/api/tls.html)
+- NGINX: [Configuring HTTPS servers](https://nginx.org/en/docs/http/configuring_https_servers.html)
+- IIS: [Create a Self Signed Certificate in IIS](https://aboutssl.org/how-to-create-a-self-signed-certificate-in-iis/)
+- Tomcat: [Setting Up SSL on Tomcat in 5 minutes](https://dzone.com/articles/setting-ssl-tomcat-5-minutes)
+- Node.js: [npm tls](https://nodejs.org/docs/v0.4.1/api/tls.html)
 
 ## API Documentation
 

dist/dce.esm.js

@@ -36,7 +36,7 @@ export default class CameraEnhancer implements ImageSource {
     private static _engineResourcePath?;
     /**
      * ```js
-     * Dynamsoft.DCE.CameraEnhancer.engineResourcePath = "https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@3.2.0/dist/";
+     * Dynamsoft.DCE.CameraEnhancer.engineResourcePath = "https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer/dist/";
      * ```
     */
     static set engineResourcePath(value: string);
@@ -64,7 +64,7 @@ export default class CameraEnhancer implements ImageSource {
     /**
      * The url of the default UI.
      * ```js
-     * Dynamsoft.DCE.CameraEnhancer.defaultUIElementURL = "https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@3.2.0/dist/dce.ui.html";
+     * Dynamsoft.DCE.CameraEnhancer.defaultUIElementURL = "https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer/dist/dce.ui.html";
      * let pEnhancer = null;
      * (async()=>{
      *     let enhancer = await (pEnhancer = pEnhancer || Dynamsoft.DCE.CameraEnhancer.createInstance());
@@ -175,7 +175,6 @@ export default class CameraEnhancer implements ImageSource {
     private _focusParameters;
     private _tapFocusEnabled;
     private _focusSupported;
-    private _focusArea;
     private _tapDoFocus;
     private _touchMoved;
     private _touchMoveEvent;
@@ -208,7 +207,7 @@ export default class CameraEnhancer implements ImageSource {
     private iPlayRound;
     private promisePlay;
     /** @ignore */
-    _ifSaveLastUsedCamera: boolean;
+    private _ifSaveLastUsedCamera;
     /**
      * Whether to record camera you selected after reload the page.
      */
@@ -709,7 +708,7 @@ export default class CameraEnhancer implements ImageSource {
      * @param MediaStreamConstraints
      * @category Camera Settings
      */
-    updateVideoSettings(MediaStreamConstraints: any): Promise<PlayCallbackInfo | void>;
+    updateVideoSettings(mediaStreamConstraints: any): Promise<PlayCallbackInfo | void>;
     /**
      * Check if the camera is open.
      * @category Open and Close
@@ -961,6 +960,11 @@ export default class CameraEnhancer implements ImageSource {
     private _readCvsData;
     private _transformPixelFormat;
     private _getImageData;
+    /**
+     * Force lose webgl context.
+     * @private
+     */
+    private forceLoseContext;
     _getVideoData(bufferContainer?: Uint8Array, options?: {
         region?: Region;
         pixelFormat?: PixelFormat;
@@ -996,11 +1000,6 @@ export default class CameraEnhancer implements ImageSource {
      */
     getFrameFromBuffer(index?: number): DCEFrame;
     clearFrameBuffer(): void;
-    /**
-     * Force lose webgl context.
-     * @private
-     */
-    private forceLoseContext;
     private _createDrawingLayerBaseCvs;
     /**
      * Might be called when:
@@ -1024,6 +1023,7 @@ export default class CameraEnhancer implements ImageSource {
     updateDrawingStyle(styleId: number, styleDefinition: any): void;
     clearDrawingLayers(): void;
     showTip(x: number, y: number, width: number, initialMessage?: string, duration?: number, autoShowSuggestedTip?: boolean): void;
+    private _hideTip;
     hideTip(): void;
     updateTipMessage(message: string): void;
     suggestTip(occasion: string, message: string): void;

dist/dce.js

@@ -21,4 +21,74 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+===================================================================================
+
+===================================================================================
+showdown
+
+MIT License
+Copyright (c) 2018,2021 ShowdownJS
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+===================================================================================
+
+===================================================================================
+highlight.js
+
+BSD 3-Clause License
+
+Copyright (c) 2006, Ivan Sagalaev.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+===================================================================================
+
+===================================================================================
+markdown-to-html-github-style(https://github.com/KrauseFx/markdown-to-html-github-style)
+
+MIT License
+
+Copyright (c) 2019 Felix Krause
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
 ===================================================================================

dist/dce.mjs

@@ -1,6 +1,6 @@
 {
 	"name": "dynamsoft-camera-enhancer",
-  "version": "3.2.0",
+  "version": "3.3.0",
 	"description": "Allow your website to easily control cameras on desktop and mobile devices.",
 	"private": false,
 	"homepage": "https://www.dynamsoft.com/camera-enhancer/docs/programming/javascript/?ver=latest",
@@ -65,20 +65,21 @@
 		"@rollup/plugin-node-resolve": "^13.3.0",
 		"@rollup/plugin-replace": "3.0.0",
 		"@rollup/plugin-typescript": "8.3.0",
-		"@types/node": "16.11.2",
-		"detect-browser-node-ssr": "^2.0.0",
 		"@scannerproxy/browser-info": "^1.0.7",
 		"@scannerproxy/curscript-path": "^1.0.3",
-		"inline-css": "^4.0.1",
-		"markdown-styles": "^3.2.0",
+		"@types/node": "16.11.2",
+		"detect-browser-node-ssr": "^2.0.0",
+		"highlight.js": "^9.15.6",
 		"rollup": "^2.58.0",
 		"rollup-plugin-terser": "7.0.2",
+		"showdown": "^1.9.0",
 		"tslib": "2.3.1",
 		"typedoc": "0.22.6",
 		"typedoc-plugin-missing-exports": "0.22.3",
 		"typescript": "4.3.5"
 	},
 	"dependencies": {
-		"dm-fabric": "^5.1.17"
+		"dm-fabric": "^5.1.17",
+		"mutable-promise": "^1.1.13"
 	}
 }

dist/types/class/cameraenhancer.d.ts

@@ -1,2 +1,2 @@
 [InternetShortcut]
-URL=https://github.com/Dynamsoft/camera-enhancer-javascript-samples/tree/v3.2.0
+URL=https://github.com/Dynamsoft/camera-enhancer-javascript-samples/tree/v3.3.0