diff --git a/hello-world/next/README.md b/hello-world/next/README.md
index c4033664..0feaf2f6 100644
--- a/hello-world/next/README.md
+++ b/hello-world/next/README.md
@@ -1,24 +1,411 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Hello World Sample for Next.js
-## Getting Started
+[Next.js](https://nextjs.org/) is a react framework that enables functionalities such as server-side rendering and generating static websites for react-based web applications. Follow this guide to learn how to implement [Dynamsoft Barcode Reader JavaScript SDK](https://www.dynamsoft.com/barcode-reader/sdk-javascript/) (hereafter called "the library") into a Next.js application. Note that in this sample, `TypeScript` is used.
-First, run the development server:
+In this guide, we will be using [`dynamsoft-barcode-reader-bundle 10.2.1000`](https://www.npmjs.com/package/dynamsoft-barcode-reader-bundle/v/10.2.1000).
-```bash
+> Note:
+>
+> If you’re looking to integrate DBR-JS into a framework that we don't yet have a sample, don't worry! We have a [comprehensive guide](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/use-in-framework.html) that provides detailed instruction and best practices for a seamless integration into any frameworks!
+>
+> Additionally, we're here to help! Please don't hesitate to [contact us](#Support) for any support or questions you might have.
+
+## Official Sample
+
+* Hello World in Next.js - Source Code
+
+## Preparation
+
+Make sure you have [node](https://nodejs.org/) installed. `node 18.17.1` and `next 14.2.3` are used in the example below.
+
+## Quick Start
+
+```cmd
+npm install
npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
```
+Then open http://localhost:3000/ to view the sample app.
+
+## Creating the sample project
+
+In this section, we will be creating a Next.js application utilizing the Dynamsoft Barcode Reader bundle sdk.
+
+We'll be exploring how you could create a page that not only enables barcode scanning via a webcam or a built-in camera, but also decode barcodes from local images.
+
+By the end of this guide, you'll have a good understanding of the SDK and be ready to discover more ways to use it!
+
+### Create a [Next.js](https://nextjs.org/) Application bootstrapped with [create-next-app](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with TypeScript.
+
+```cmd
+npx create-next-app@latest
+```
+
+On installation, you will be prompted to configure your project.\
+You can customize these options according to your preferences.\
+Below is the configuration used for this sample.
+
+```
+√ What is your project named? ... my-app
+√ Would you like to use TypeScript? ... Yes
+√ Would you like to use ESLint? ... Yes
+√ Would you like to use Tailwind CSS? ... No
+√ Would you like to use `src/` directory? ... No
+√ Would you like to use App Router? (recommended) ... Yes
+√ Would you like to customize the default import alias (@/*)? ... Yes
+√ What import alias would you like configured? ... @/*
+```
+
+### **CD** to the root directory of the application and install necessary libraries
+
+```cmd
+cd my-app
+npm install dynamsoft-barcode-reader-bundle
+```
+
+## Start to implement
+
+### Add file "dynamsoft.config.ts" at the root of the app to configure libraries
+
+```typescript
+/* /dynamsoft.config.ts */
+import { CoreModule } from "dynamsoft-core";
+import { LicenseManager } from "dynamsoft-license";
+import "dynamsoft-barcode-reader";
+
+// Configures the paths where the .wasm files and other necessary resources for modules are located.
+CoreModule.engineResourcePaths = {
+ std: "https://cdn.jsdelivr.net/npm/dynamsoft-capture-vision-std@1.2.10/dist/",
+ dip: "https://cdn.jsdelivr.net/npm/dynamsoft-image-processing@2.2.30/dist/",
+ core: "https://cdn.jsdelivr.net/npm/dynamsoft-core@3.2.30/dist/",
+ license: "https://cdn.jsdelivr.net/npm/dynamsoft-license@3.2.21/dist/",
+ cvr: "https://cdn.jsdelivr.net/npm/dynamsoft-capture-vision-router@2.2.30/dist/",
+ dbr: "https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader@10.2.10/dist/",
+ dce: "https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@4.0.3/dist/",
+};
+
+/** LICENSE ALERT - README
+ * To use the library, you need to first specify a license key using the API "initLicense()" as shown below.
+ */
+
+LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", true);
+
+/**
+ * You can visit https://www.dynamsoft.com/customer/license/trialLicense?utm_source=github&product=dbr&package=js to get your own trial license good for 30 days.
+ * Note that if you downloaded this sample from Dynamsoft while logged in, the above license key may already be your own 30-day trial license.
+ * For more information, see https://www.dynamsoft.com/barcode-reader/programming/javascript/user-guide/?ver=10.2.10&utm_source=github#specify-the-license or contact support@dynamsoft.com.
+ * LICENSE ALERT - THE END
+ */
+
+// Optional. Preload "BarcodeReader" module for reading barcodes. It will save time on the initial decoding by skipping the module loading.
+CoreModule.loadWasm(["DBR"]);
+```
+
+> Note:
+>
+> * `initLicense()` specify a license key to use the library. You can visit https://www.dynamsoft.com/customer/license/trialLicense?utm_source=sample&product=dbr&package=js to get your own trial license good for 30 days.
+> * `engineResourcePaths` tells the library where to get the necessary resources at runtime.
+
+### Build directory structure
+
+* Create a directory `components` on the root directory, and then create another two directories, `VideoCapture` and `ImageCapture` under `/components/`.
+
+### Create and edit the `VideoCapture` component
+
+* Create `VideoCapture.tsx` under `/components/VideoCapture/`. The `VideoCapture` component helps decode barcodes via camera.
+
+* In `VideoCapture.tsx`, add code for initializing and destroying some instances. For our stylesheet (CSS) specification, please refer to our [source code](#Official-Sample).
+
+```tsx
+/* /components/VideoCapture/VideoCapture.tsx */
+import React, { useEffect, useRef } from "react";
+import "../../dynamsoft.config"; // import side effects. The license, engineResourcePath, so on.
+import { CameraEnhancer, CameraView } from "dynamsoft-camera-enhancer";
+import { CaptureVisionRouter } from "dynamsoft-capture-vision-router";
+import { MultiFrameResultCrossFilter } from "dynamsoft-utility";
+
+const componentDestroyedErrorMsg = "VideoCapture Component Destroyed";
+
+function VideoCapture() {
+ const cameraViewContainer = useRef(null);
+ const resultsContainer = useRef(null);
+
+ useEffect((): any => {
+ let resolveInit: () => void;
+ const pInit: Promise = new Promise((r) => {
+ resolveInit = r;
+ });
+ let isDestroyed = false;
+
+ let cvRouter: CaptureVisionRouter;
+ let cameraEnhancer: CameraEnhancer;
+
+ (async () => {
+ try {
+ // Create a `CameraEnhancer` instance for camera control and a `CameraView` instance for UI control.
+ const cameraView = await CameraView.createInstance();
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ } // Check if component is destroyed after every async
+ cameraEnhancer = await CameraEnhancer.createInstance(cameraView);
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ }
+
+ // Get default UI and append it to DOM.
+ cameraViewContainer.current!.append(cameraView.getUIElement());
+
+ // Create a `CaptureVisionRouter` instance and set `CameraEnhancer` instance as its image source.
+ cvRouter = await CaptureVisionRouter.createInstance();
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ }
+ cvRouter.setInput(cameraEnhancer);
+
+ // Define a callback for results.
+ cvRouter.addResultReceiver({
+ onDecodedBarcodesReceived: (result) => {
+ if (!result.barcodeResultItems.length) return;
+
+ resultsContainer.current!.textContent = "";
+ console.log(result);
+ for (let item of result.barcodeResultItems) {
+ resultsContainer.current!.textContent += `${item.formatString}: ${item.text}\n\n`;
+ }
+ },
+ });
+
+ // Filter out unchecked and duplicate results.
+ const filter = new MultiFrameResultCrossFilter();
+ // Filter out unchecked barcodes.
+ filter.enableResultCrossVerification("barcode", true);
+ // Filter out duplicate barcodes within 3 seconds.
+ filter.enableResultDeduplication("barcode", true);
+ await cvRouter.addResultFilter(filter);
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ }
+
+ // Open camera and start scanning single barcode.
+ await cameraEnhancer.open();
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ }
+ await cvRouter.startCapturing("ReadSingleBarcode");
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ }
+ } catch (ex: any) {
+ if ((ex as Error)?.message === componentDestroyedErrorMsg) {
+ console.log(componentDestroyedErrorMsg);
+ } else {
+ let errMsg = ex.message || ex;
+ console.error(errMsg);
+ alert(errMsg);
+ }
+ }
+ })();
+
+ // Resolve pInit promise once initialization is complete.
+ resolveInit!();
+
+ // componentWillUnmount. dispose cvRouter when it's no longer needed
+ return async () => {
+ isDestroyed = true;
+ try {
+ // Wait for the pInit to complete before disposing resources.
+ await pInit;
+ cvRouter?.dispose();
+ cameraEnhancer?.dispose();
+ } catch (_) {}
+ };
+ }, []);
+
+ return (
+
+
+ Results:
+
+
+
+ );
+}
+
+export default VideoCapture;
+```
+
+> Note:
+>
+> * The component should never update so that events bound to the UI stay valid. In this component, the useEffect() hook is used to handle the component’s mount and unmount lifecycle events, and there are no state updates that would cause a re-render.
+> * If you're looking to customize the UI, the UI customization feature are provided by the auxiliary SDK "Dynamsoft Camera Enhancer". For more details, refer to our [User Guide](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/index.html#customize-the-ui)
+
+### Create and edit the `ImageCapture` component
+
+* Create `ImageCapture.tsx` under `/components/ImageCapture/`. The `ImageCapture` component helps decode barcodes in an image.
+
+* In `ImageCapture.tsx`, add code for initializing and destroying the `CaptureVisionRouter` instance. For our stylesheet (CSS) specification, please refer to our [source code](#Official-Sample).
+
+```tsx
+/* /components/ImageCapture/ImageCapture.tsx */
+import React, { useRef, useEffect, MutableRefObject, useCallback } from "react";
+import "../../dynamsoft.config"; // import side effects. The license, engineResourcePath, so on.
+import { EnumCapturedResultItemType } from "dynamsoft-core";
+import { BarcodeResultItem } from "dynamsoft-barcode-reader";
+import { CaptureVisionRouter } from "dynamsoft-capture-vision-router";
+
+function ImageCapture() {
+ const resultsContainer: MutableRefObject = useRef(null);
+
+ let pCvRouter: MutableRefObject | null> = useRef(null);
+ let isDestroyed = useRef(false);
+
+ const decodeImg = useCallback(async (e: React.ChangeEvent) => {
+ let files = [...(e.target.files as any as File[])];
+ e.target.value = ""; // reset input
+ resultsContainer.current!.innerText = "";
+
+ try {
+ // ensure cvRouter is created only once
+ const cvRouter = await (pCvRouter.current = pCvRouter.current || CaptureVisionRouter.createInstance());
+ if (isDestroyed.current) return;
+
+ for (let file of files) {
+ // Decode selected image with 'ReadBarcodes_SpeedFirst' template.
+ const result = await cvRouter.capture(file, "ReadBarcodes_SpeedFirst");
+ if (isDestroyed.current) return;
+
+ // Print file name if there's multiple files
+ if (files.length > 1) {
+ resultsContainer.current!.innerText += `\n${file.name}:\n`;
+ }
+ for (let _item of result.items) {
+ if (_item.type !== EnumCapturedResultItemType.CRIT_BARCODE) {
+ continue; // check if captured result item is a barcode
+ }
+ let item = _item as BarcodeResultItem;
+ resultsContainer.current!.innerText += item.text + "\n"; // output the decoded barcode text
+ console.log(item.text);
+ }
+ // If no items are found, display that no barcode was detected
+ if (!result.items.length) resultsContainer.current!.innerText = "No barcode found";
+ }
+ } catch (ex: any) {
+ let errMsg = ex.message || ex;
+ console.error(errMsg);
+ alert(errMsg);
+ }
+ }, []);
+
+ useEffect((): any => {
+ // In 'development', React runs setup and cleanup one extra time before the actual setup in Strict Mode.
+ isDestroyed.current = false;
+
+ // componentWillUnmount. dispose cvRouter when it's no longer needed
+ return async () => {
+ isDestroyed.current = true;
+ if (pCvRouter.current) {
+ try {
+ (await pCvRouter.current).dispose();
+ } catch (_) {}
+ }
+ };
+ }, []);
+
+ return (
+
+
+
+
+
+
+ );
+}
+
+export default ImageCapture;
+```
+
+### Add the `VideoCapture` and `ImageCapture` component to `page.tsx`
+
+* On `/app/page.tsx`, we will edit the component so that it offers buttons to switch components between `VideoCapture` and `ImageCapture`.
+
+* Add following code to `page.tsx`. For our stylesheet (CSS) specification, please refer to our [source code](#Official-Sample).
+
+```tsx
+/* /app/page.tsx */
+"use client";
+
+import dynamic from "next/dynamic";
+import { useState } from "react";
+import "./page.css";
+
+const VideoCapture = dynamic(() => import("../components/VideoCapture/VideoCapture"), {
+ ssr: false,
+});
+const ImageCapture = dynamic(() => import("../components/ImageCapture/ImageCapture"), {
+ ssr: false,
+});
+
+enum Modes {
+ VIDEO_CAPTURE = "video",
+ IMAGE_CAPTURE = "image",
+}
+
+export default function Home() {
+ const [mode, setMode] = useState(Modes.VIDEO_CAPTURE);
+
+ const showVideoCapture = () => setMode(Modes.VIDEO_CAPTURE);
+ const showImageCapture = () => setMode(Modes.IMAGE_CAPTURE);
+
+ return (
+
+
+
Hello World for Next.js
+
+
+
+
+
+
{mode === Modes.VIDEO_CAPTURE ? : }
+
+ );
+}
+```
+> Note:
+>
+> With Next.js' dynamic `import()`, we can significantly improve the initial load speed and performance when we dynamically import Dynamsoft's Barcode Scanning component on-demand.
+>
+> Additionally, we need to set `{ ssr: false }` since the component is client-side only and could not be rendered server-side.
+>
+> Read more: [https://nextjs.org/learn-pages-router/seo/improve/dynamic-import-components](https://nextjs.org/learn-pages-router/seo/improve/dynamic-import-components)
+
+* Try running the project.
+
+```cmd
+npm run dev
+```
+
+If you followed all the steps correctly, you will have a working page that turns one of the cameras hooked to or built in your computer or mobile device into a barcode scanner. Also, if you want to decode a local image, just click the `Image Decode` button and select the image you want to decode. Once barcodes are found, the results will show in a dialog.
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Development server
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
## Learn More
@@ -33,4 +420,4 @@ You can check out [the Next.js GitHub repository](https://github.com/vercel/next
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+Check out [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
diff --git a/hello-world/next/app/layout.tsx b/hello-world/next/app/layout.tsx
index 3314e478..3e561528 100644
--- a/hello-world/next/app/layout.tsx
+++ b/hello-world/next/app/layout.tsx
@@ -5,8 +5,9 @@ import "./globals.css";
const inter = Inter({ subsets: ["latin"] });
export const metadata: Metadata = {
- title: "Create Next App",
- description: "Generated by create next app",
+ title: "Hello World for Next.js - Dynamsoft Barcode Reader Sample",
+ description: "Dynamsoft Barcode Reader in a Next.js Application, helps read barcodes from camera or images.",
+ keywords: "barcodes, camera, images, nextjs",
};
export default function RootLayout({
diff --git a/hello-world/next/app/page.css b/hello-world/next/app/page.css
index f3fee6a1..580a16f8 100644
--- a/hello-world/next/app/page.css
+++ b/hello-world/next/app/page.css
@@ -4,44 +4,30 @@
align-items: center;
margin-top: 20px;
}
-.title .title-logo {
- width: 60px;
- height: 60px;
- animation: retate 5s infinite linear;
-}
-.top-btns {
+.buttons-container {
width: 30%;
margin: 20px auto;
}
-.top-btns button {
+.buttons-container button {
display: inline-block;
border: 1px solid black;
padding: 5px 15px;
background-color: transparent;
cursor: pointer;
}
-.top-btns button:first-child {
+.buttons-container button:first-child {
border-top-left-radius: 10px;
border-bottom-left-radius: 10px;
border-right: transparent;
}
-.top-btns button:nth-child(2) {
+.buttons-container button:nth-child(2) {
border-top-right-radius: 10px;
border-bottom-right-radius: 10px;
border-left: transparent;
}
-@media screen and (max-width: 500px) {
- .top-btns {
- width: 70%;
+@media screen and (max-width: 800px) {
+ .buttons-container {
+ width: 70%;
}
}
-
-@keyframes retate {
- from {
- transform: rotate(0deg);
- }
- to {
- transform: rotate(360deg);
- }
-}
\ No newline at end of file
diff --git a/hello-world/next/app/page.tsx b/hello-world/next/app/page.tsx
index 9f005fd7..17435b8f 100644
--- a/hello-world/next/app/page.tsx
+++ b/hello-world/next/app/page.tsx
@@ -1,22 +1,51 @@
"use client";
-import { useState } from 'react';
+import dynamic from "next/dynamic";
+import { useState } from "react";
import "./page.css";
-import VideoCapture from '@/component/VideoCapture';
-import ImageCapture from '@/component/ImageCapture';
+
+const VideoCapture = dynamic(() => import("../components/VideoCapture/VideoCapture"), {
+ ssr: false,
+});
+const ImageCapture = dynamic(() => import("../components/ImageCapture/ImageCapture"), {
+ ssr: false,
+});
+
+enum Modes {
+ VIDEO_CAPTURE = "video",
+ IMAGE_CAPTURE = "image",
+}
export default function Home() {
- const [mode, setMode] = useState("video");
+ const [mode, setMode] = useState(Modes.VIDEO_CAPTURE);
+
+ const showVideoCapture = () => setMode(Modes.VIDEO_CAPTURE);
+ const showImageCapture = () => setMode(Modes.IMAGE_CAPTURE);
+
return (
-
- )
-};
diff --git a/hello-world/next/component/VideoCapture.css b/hello-world/next/component/VideoCapture.css
deleted file mode 100644
index 810b49cb..00000000
--- a/hello-world/next/component/VideoCapture.css
+++ /dev/null
@@ -1,11 +0,0 @@
-.div-ui-container {
- width: 100%;
- height: 70vh;
- background: #eee;
-}
-
-.div-results-container {
- width: 100%;
- height: 10vh;
- overflow: auto;
-}
\ No newline at end of file
diff --git a/hello-world/next/component/VideoCapture.tsx b/hello-world/next/component/VideoCapture.tsx
deleted file mode 100644
index 5ae142e3..00000000
--- a/hello-world/next/component/VideoCapture.tsx
+++ /dev/null
@@ -1,103 +0,0 @@
-"use client";
-
-import { useEffect, useRef, MutableRefObject } from 'react';
-import "../dynamsoft.config";
-import { CameraEnhancer, CameraView } from "dynamsoft-camera-enhancer";
-import { CaptureVisionRouter } from "dynamsoft-capture-vision-router";
-import { MultiFrameResultCrossFilter } from "dynamsoft-utility";
-import "./VideoCapture.css";
-
-const strErrorDistoryed = 'videoCapture component destoryed';
-
-export default () => {
- const uiContainer: MutableRefObject = useRef(null);
- const resultsContainer: MutableRefObject = useRef(null);
-
- useEffect((): any => {
- let resolveInit:()=>void;
- const pInit:Promise = new Promise(r=>{resolveInit=r});
- let bDestoryed = false;
-
- let cvRouter:CaptureVisionRouter;
- let cameraEnhancer:CameraEnhancer;
-
- (async()=>{
- try{
- // Create a `CameraEnhancer` instance for camera control and a `CameraView` instance for UI control.
- const cameraView = await CameraView.createInstance();
- if(bDestoryed){ throw Error(strErrorDistoryed); } // Check if component is destroyed after every async
- cameraEnhancer = await CameraEnhancer.createInstance(cameraView);
- if(bDestoryed){ throw Error(strErrorDistoryed); }
-
- // Get default UI and append it to DOM.
- uiContainer.current!.append(cameraView.getUIElement());
-
- // Create a `CaptureVisionRouter` instance and set `CameraEnhancer` instance as its image source.
- cvRouter = await CaptureVisionRouter.createInstance();
- if(bDestoryed){ throw Error(strErrorDistoryed); }
- cvRouter.setInput(cameraEnhancer);
-
- // Define a callback for results.
- cvRouter.addResultReceiver({ onDecodedBarcodesReceived: (result) => {
- if (!result.barcodeResultItems.length) return;
-
- resultsContainer.current!.textContent = '';
- console.log(result);
- for (let item of result.barcodeResultItems) {
- resultsContainer.current!.append(
- `${item.formatString}: ${item.text}`,
- document.createElement('br'),
- document.createElement('hr'),
- );
- }
- }});
-
- // Filter out unchecked and duplicate results.
- const filter = new MultiFrameResultCrossFilter();
- // Filter out unchecked barcodes.
- filter.enableResultCrossVerification("barcode", true);
- // Filter out duplicate barcodes within 3 seconds.
- filter.enableResultDeduplication("barcode", true);
- await cvRouter.addResultFilter(filter);
- if(bDestoryed){ throw Error(strErrorDistoryed); }
-
- // Open camera and start scanning single barcode.
- await cameraEnhancer.open();
- if(bDestoryed){ throw Error(strErrorDistoryed); }
- await cvRouter.startCapturing("ReadSingleBarcode");
- if(bDestoryed){ throw Error(strErrorDistoryed); }
-
- }catch(ex:any){
-
- if((ex as Error)?.message === strErrorDistoryed){
- console.log(strErrorDistoryed);
- }else{
- let errMsg = ex.message || ex;
- console.error(errMsg);
- alert(errMsg);
- }
- }
- })();
-
- // distroy function will wait pInit
- resolveInit!();
-
- // onBeforeUnmount
- return async () => {
- bDestoryed = true;
- try{
- await pInit;
- cvRouter?.dispose();
- cameraEnhancer?.dispose();
- }catch(_){}
- };
- }, []);
-
- return (
-
-
- Results:
-
-
- );
-}
diff --git a/hello-world/next/components/ImageCapture/ImageCapture.css b/hello-world/next/components/ImageCapture/ImageCapture.css
new file mode 100644
index 00000000..03da581c
--- /dev/null
+++ b/hello-world/next/components/ImageCapture/ImageCapture.css
@@ -0,0 +1,20 @@
+.image-capture-container {
+ width: 100%;
+ height: 100%;
+ font-family: Consolas, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono,
+ Courier New, monospace;
+}
+
+.image-capture-container .input-container {
+ width: 80%;
+ height: 100%;
+ display: flex;
+ justify-content: center;
+ border: 1px solid black;
+ margin: 0 auto;
+}
+
+.image-capture-container .results {
+ margin-top: 20px;
+ height: 100%;
+}
diff --git a/hello-world/next/components/ImageCapture/ImageCapture.tsx b/hello-world/next/components/ImageCapture/ImageCapture.tsx
new file mode 100644
index 00000000..03e52618
--- /dev/null
+++ b/hello-world/next/components/ImageCapture/ImageCapture.tsx
@@ -0,0 +1,76 @@
+import React, { useRef, useEffect, MutableRefObject, useCallback } from "react";
+import "../../dynamsoft.config"; // import side effects. The license, engineResourcePath, so on.
+import { EnumCapturedResultItemType } from "dynamsoft-core";
+import { BarcodeResultItem } from "dynamsoft-barcode-reader";
+import { CaptureVisionRouter } from "dynamsoft-capture-vision-router";
+import "./ImageCapture.css";
+
+function ImageCapture() {
+ const resultsContainer: MutableRefObject = useRef(null);
+
+ let pCvRouter: MutableRefObject | null> = useRef(null);
+ let isDestroyed = useRef(false);
+
+ const decodeImg = useCallback(async (e: React.ChangeEvent) => {
+ let files = [...(e.target.files as any as File[])];
+ e.target.value = ""; // reset input
+ resultsContainer.current!.innerText = "";
+
+ try {
+ // ensure cvRouter is created only once
+ const cvRouter = await (pCvRouter.current = pCvRouter.current || CaptureVisionRouter.createInstance());
+ if (isDestroyed.current) return;
+
+ for (let file of files) {
+ // Decode selected image with 'ReadBarcodes_SpeedFirst' template.
+ const result = await cvRouter.capture(file, "ReadBarcodes_SpeedFirst");
+ if (isDestroyed.current) return;
+
+ // Print file name if there's multiple files
+ if (files.length > 1) {
+ resultsContainer.current!.innerText += `\n${file.name}:\n`;
+ }
+ for (let _item of result.items) {
+ if (_item.type !== EnumCapturedResultItemType.CRIT_BARCODE) {
+ continue; // check if captured result item is a barcode
+ }
+ let item = _item as BarcodeResultItem;
+ resultsContainer.current!.innerText += item.text + "\n"; // output the decoded barcode text
+ console.log(item.text);
+ }
+ // If no items are found, display that no barcode was detected
+ if (!result.items.length) resultsContainer.current!.innerText = "No barcode found";
+ }
+ } catch (ex: any) {
+ let errMsg = ex.message || ex;
+ console.error(errMsg);
+ alert(errMsg);
+ }
+ }, []);
+
+ useEffect((): any => {
+ // In 'development', React runs setup and cleanup one extra time before the actual setup in Strict Mode.
+ isDestroyed.current = false;
+
+ // componentWillUnmount. dispose cvRouter when it's no longer needed
+ return async () => {
+ isDestroyed.current = true;
+ if (pCvRouter.current) {
+ try {
+ (await pCvRouter.current).dispose();
+ } catch (_) {}
+ }
+ };
+ }, []);
+
+ return (
+
+
+
+
+
+
+ );
+}
+
+export default ImageCapture;
diff --git a/hello-world/next/components/VideoCapture/VideoCapture.css b/hello-world/next/components/VideoCapture/VideoCapture.css
new file mode 100644
index 00000000..245b44b7
--- /dev/null
+++ b/hello-world/next/components/VideoCapture/VideoCapture.css
@@ -0,0 +1,11 @@
+.camera-view-container {
+ width: 100%;
+ height: 70vh;
+ background: #eee;
+}
+
+.results {
+ width: 100%;
+ height: 10vh;
+ overflow: auto;
+}
diff --git a/hello-world/next/components/VideoCapture/VideoCapture.tsx b/hello-world/next/components/VideoCapture/VideoCapture.tsx
new file mode 100644
index 00000000..89302c07
--- /dev/null
+++ b/hello-world/next/components/VideoCapture/VideoCapture.tsx
@@ -0,0 +1,115 @@
+import React, { useEffect, useRef } from "react";
+import "../../dynamsoft.config"; // import side effects. The license, engineResourcePath, so on.
+import { CameraEnhancer, CameraView } from "dynamsoft-camera-enhancer";
+import { CaptureVisionRouter } from "dynamsoft-capture-vision-router";
+import { MultiFrameResultCrossFilter } from "dynamsoft-utility";
+import "./VideoCapture.css";
+
+const componentDestroyedErrorMsg = "VideoCapture Component Destroyed";
+
+function VideoCapture() {
+ const cameraViewContainer = useRef(null);
+ const resultsContainer = useRef(null);
+
+ useEffect((): any => {
+ let resolveInit: () => void;
+ const pInit: Promise = new Promise((r) => {
+ resolveInit = r;
+ });
+ let isDestroyed = false;
+
+ let cvRouter: CaptureVisionRouter;
+ let cameraEnhancer: CameraEnhancer;
+
+ (async () => {
+ try {
+ // Create a `CameraEnhancer` instance for camera control and a `CameraView` instance for UI control.
+ const cameraView = await CameraView.createInstance();
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ } // Check if component is destroyed after every async
+ cameraEnhancer = await CameraEnhancer.createInstance(cameraView);
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ }
+
+ // Get default UI and append it to DOM.
+ cameraViewContainer.current!.append(cameraView.getUIElement());
+
+ // Create a `CaptureVisionRouter` instance and set `CameraEnhancer` instance as its image source.
+ cvRouter = await CaptureVisionRouter.createInstance();
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ }
+ cvRouter.setInput(cameraEnhancer);
+
+ // Define a callback for results.
+ cvRouter.addResultReceiver({
+ onDecodedBarcodesReceived: (result) => {
+ if (!result.barcodeResultItems.length) return;
+
+ resultsContainer.current!.textContent = "";
+ console.log(result);
+ for (let item of result.barcodeResultItems) {
+ resultsContainer.current!.textContent += `${item.formatString}: ${item.text}\n\n`;
+ }
+ },
+ });
+
+ // Filter out unchecked and duplicate results.
+ const filter = new MultiFrameResultCrossFilter();
+ // Filter out unchecked barcodes.
+ filter.enableResultCrossVerification("barcode", true);
+ // Filter out duplicate barcodes within 3 seconds.
+ filter.enableResultDeduplication("barcode", true);
+ await cvRouter.addResultFilter(filter);
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ }
+
+ // Open camera and start scanning single barcode.
+ await cameraEnhancer.open();
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ }
+ await cvRouter.startCapturing("ReadSingleBarcode");
+ if (isDestroyed) {
+ throw Error(componentDestroyedErrorMsg);
+ }
+ } catch (ex: any) {
+ if ((ex as Error)?.message === componentDestroyedErrorMsg) {
+ console.log(componentDestroyedErrorMsg);
+ } else {
+ let errMsg = ex.message || ex;
+ console.error(errMsg);
+ alert(errMsg);
+ }
+ }
+ })();
+
+ // Resolve pInit promise once initialization is complete.
+ resolveInit!();
+
+ // componentWillUnmount. dispose cvRouter when it's no longer needed
+ return async () => {
+ isDestroyed = true;
+ try {
+ // Wait for the pInit to complete before disposing resources.
+ await pInit;
+ cvRouter?.dispose();
+ cameraEnhancer?.dispose();
+ } catch (_) {}
+ };
+ }, []);
+
+ return (
+
+
+
+ Results:
+
+
+ );
+}
+
+export default VideoCapture;
diff --git a/hello-world/next/dynamsoft.config.ts b/hello-world/next/dynamsoft.config.ts
index 8a0d59c1..f31509c2 100644
--- a/hello-world/next/dynamsoft.config.ts
+++ b/hello-world/next/dynamsoft.config.ts
@@ -2,11 +2,22 @@ import { CoreModule } from "dynamsoft-core";
import { LicenseManager } from "dynamsoft-license";
import "dynamsoft-barcode-reader";
+// Configures the paths where the .wasm files and other necessary resources for modules are located.
+CoreModule.engineResourcePaths = {
+ std: "https://cdn.jsdelivr.net/npm/dynamsoft-capture-vision-std@1.2.10/dist/",
+ dip: "https://cdn.jsdelivr.net/npm/dynamsoft-image-processing@2.2.30/dist/",
+ core: "https://cdn.jsdelivr.net/npm/dynamsoft-core@3.2.30/dist/",
+ license: "https://cdn.jsdelivr.net/npm/dynamsoft-license@3.2.21/dist/",
+ cvr: "https://cdn.jsdelivr.net/npm/dynamsoft-capture-vision-router@2.2.30/dist/",
+ dbr: "https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader@10.2.10/dist/",
+ dce: "https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@4.0.3/dist/",
+};
+
/** LICENSE ALERT - README
* To use the library, you need to first specify a license key using the API "initLicense()" as shown below.
*/
-LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
+LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", true);
/**
* You can visit https://www.dynamsoft.com/customer/license/trialLicense?utm_source=github&product=dbr&package=js to get your own trial license good for 30 days.
@@ -15,15 +26,5 @@ LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
* LICENSE ALERT - THE END
*/
-CoreModule.engineResourcePaths = {
- std: "https://cdn.jsdelivr.net/npm/dynamsoft-capture-vision-std@1.2.10/dist/",
- dip: "https://cdn.jsdelivr.net/npm/dynamsoft-image-processing@2.2.30/dist/",
- core: "https://cdn.jsdelivr.net/npm/dynamsoft-core@3.2.30/dist/",
- license: "https://cdn.jsdelivr.net/npm/dynamsoft-license@3.2.21/dist/",
- cvr: "https://cdn.jsdelivr.net/npm/dynamsoft-capture-vision-router@2.2.30/dist/",
- dbr: "https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader@10.2.10/dist/",
- dce: "https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@4.0.3/dist/"
-};
-
// Optional. Preload "BarcodeReader" module for reading barcodes. It will save time on the initial decoding by skipping the module loading.
CoreModule.loadWasm(["DBR"]);
diff --git a/hello-world/next/package.json b/hello-world/next/package.json
index 6a807bc1..15a52796 100644
--- a/hello-world/next/package.json
+++ b/hello-world/next/package.json
@@ -1,5 +1,5 @@
{
- "name": "read-video-nextjs",
+ "name": "dbrjs-next-sample",
"version": "0.1.0",
"private": true,
"scripts": {
@@ -22,4 +22,4 @@
"eslint": "^8",
"eslint-config-next": "14.2.3"
}
-}
+}
\ No newline at end of file