Ejecuta cualquier Skill en Manus
con un clic

Ejecuta cualquier Skill en Manus con un clic

use-dynamic-web-twain

Estrellas0

Forks2

Actualizado17 de julio de 2026 a las 09:51

Integrate Dynamic Web TWAIN document scanning into web apps. Scan, upload, and process images from scanners/cameras in vanilla JS or React.

Instalación

Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.

Ejecutar en Manus

Fuente

Dynamsoft

Dynamsoft/web-twain-samples

Abrir repositorio de GitHub Ver repositorios del creador

Descarga

Ejecutar en Manus

Ocupaciones relacionadasSOC

Basado en la clasificación ocupacional SOC

Desarrolladores de softwareOcupaciones informáticas y matemáticas·SOC 15-1252

Explorador de archivos

2 archivos

SKILL.md

readonly

Ejecuta cualquier Skill con un clic

name	use-dynamic-web-twain
description	Integrate Dynamic Web TWAIN document scanning into web apps. Scan, upload, and process images from scanners/cameras in vanilla JS or React.
version	1.0.0
license	MIT

What is Dynamic Web TWAIN?

Dynamic Web TWAIN (DWT) is a cross-platform document scanning SDK that runs in the browser. It connects to scanners (TWAIN/SANE/ICA/WIA/eSCL), cameras, and other image capture devices, then lets you process, edit, and upload the scanned images — all from client-side JavaScript.

Official documentation: Dynamic Web TWAIN Docs

Samples list: Dynamic Web TWAIN Samples

When to Use Dynamic Web TWAIN

Use DWT when you need:

Document scanning — Capture documents from physical scanners or device cameras
Image processing — Convert to binary/bw, rotate, flip, crop, or deskew
Batch scanning — Scan multiple pages into a buffer, reorder, then save as PDF/TIFF/PNG
PDF processing — View PDFs in the browser, modify its pages and scan documents into PDF
Browser-based scanner control — Select scanner source, set resolution, color mode, paper size
File upload from scanners — Stream scanned images directly to a server via HTTP/FTP
Barcode/OCR — DWT add-ons can read barcodes and perform OCR on scanned documents
Question/Answer — Ask questions about Web TWAIN

Setup Approaches

Choose based on your project constraints:

Approach	Best for	Network required
CDN	Quick prototypes, demos	Yes
Local Resources	Intranet, offline, production	No (self-hosted)
npm Package	React, Vue, Angular, bundled apps	No (self-hosted)

1. CDN (Quick Start)

Include the DWT script from CDN, configure, and load:

<html>
  <head>
    <script src="https://cdn.jsdelivr.net/npm/dwt/dist/dynamsoft.webtwain.min.js"></script>
  </head>

  <body>
    <button onclick="AcquireImage();">Scan</button>
    <button onclick="upload();">Upload</button>
    <button onclick="binarizeImage();">Convert to BW</button>
    <button onclick="rotateCW();">Rotate Clockwise</button>
    <button onclick="rotateCCW();">Rotate Counter-Clockwise</button>
    <div id="dwtcontrolContainer"></div>

    <script>
      Dynamsoft.DWT.AutoLoad = false;
      Dynamsoft.DWT.IfCheckCssFiles = false;
      Dynamsoft.DWT.Containers = [
        { ContainerId: "dwtcontrolContainer", Width: "380px", Height: "400px" },
      ];
      Dynamsoft.DWT.ProductKey =
        "DLS2eyJoYW5kc2hha2VDb2RlIjoiMjAwMDAxLTEwNTI2NzQwMSIsIm1haW5TZXJ2ZXJVUkwiOiJodHRwczovL21kbHMuZHluYW1zb2Z0b25saW5lLmNvbS8iLCJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSIsInN0YW5kYnlTZXJ2ZXJVUkwiOiJodHRwczovL3NkbHMuZHluYW1zb2Z0b25saW5lLmNvbS8iLCJjaGVja0NvZGUiOi0zMzE5NzM0NjJ9";
      Dynamsoft.DWT.ResourcesPath =
        "https://cdn.jsdelivr.net/npm/dwt/dist";
      Dynamsoft.DWT.ServiceInstallerLocation =
        "https://unpkg.com/dwt/dist/dist/";
      Dynamsoft.DWT.Load();

      var DWTObject;

      Dynamsoft.DWT.RegisterEvent("OnWebTwainReady", function () {
        DWTObject = Dynamsoft.DWT.GetWebTwain("dwtcontrolContainer");
      });

      function AcquireImage() {
        if (DWTObject) {
          DWTObject.SelectSourceAsync()
            .then(function () {
              return DWTObject.AcquireImageAsync({
                IfCloseSourceAfterAcquire: true,
                IfShowUI: false,
                PixelType: Dynamsoft.DWT.EnumDWT_PixelType.TWPT_GRAY,
                Resolution: 150,
              });
            })
            .catch(function (exp) {
              alert(exp.message);
            });
        }
      }

      function upload() {
        if (DWTObject && DWTObject.HowManyImagesInBuffer > 0) {
          var strUrl = "https://demo.dynamsoft.com/sample-uploads/";
          var imgAry = [DWTObject.CurrentImageIndexInBuffer];
          DWTObject.HTTPUpload(
            strUrl,
            imgAry,
            Dynamsoft.DWT.EnumDWT_ImageType.IT_PNG,
            Dynamsoft.DWT.EnumDWT_UploadDataFormat.Binary,
            "WebTWAINImage.png",
            function () {
              alert("Upload successful");
            },
            function (errorCode, errorString, sHttpResponse) {
              alert(sHttpResponse.length > 0 ? sHttpResponse : errorString);
            }
          );
        } else {
          alert("There is no image in buffer.");
        }
      }

      function binarizeImage() {
        DWTObject.ConvertToBW(DWTObject.CurrentImageIndexInBuffer);
      }

      function rotateCW() {
        DWTObject.RotateRight(DWTObject.CurrentImageIndexInBuffer);
      }

      function rotateCCW() {
        DWTObject.RotateLeft(DWTObject.CurrentImageIndexInBuffer);
      }
    </script>
  </body>
</html>

Note: When using CDN, ResourcesPath must point to a proper CDN location (it can be where the main script is hosted), otherwise DWT's internal resource loader will fail.

Note: The included ProductKey is a 1-day trial license. Get your own trial key from Dynamsoft for extended use.

2. Local Resources (Offline / Intranet)

Download the DWT resource package and host it alongside your app. This is the recommended approach for production deployments where you don't want CDN dependencies.

Step 1: Copy the Resources/ directory from the DWT installation into your project.

Step 2: Reference the local scripts and set ResourcesPath to the local directory:

<html>
  <head>
    <script src="Resources/dynamsoft.webtwain.initiate.js"></script>
    <script src="Resources/dynamsoft.webtwain.config.js"></script>
  </head>

  <body>
    <button onclick="AcquireImage();">Scan</button>
    <button onclick="upload();">Upload</button>
    <button onclick="binarizeImage();">Convert to BW</button>
    <button onclick="rotateCW();">Rotate Clockwise</button>
    <button onclick="rotateCCW();">Rotate Counter-Clockwise</button>
    <div id="dwtcontrolContainer"></div>

    <script>
      var DWTObject;

      if (!window.Dynamsoft) {
        alert(
          "Dynamic Web TWAIN is not loaded. Check that resources are in place."
        );
      }

      Dynamsoft.DWT.RegisterEvent("OnWebTwainReady", function () {
        DWTObject = Dynamsoft.DWT.GetWebTwain("dwtcontrolContainer");
      });

      function AcquireImage() {
        if (DWTObject) {
          DWTObject.SelectSourceAsync()
            .then(function () {
              return DWTObject.AcquireImageAsync({
                IfCloseSourceAfterAcquire: true,
                IfShowUI: false,
                PixelType: Dynamsoft.DWT.EnumDWT_PixelType.TWPT_GRAY,
                Resolution: 150,
              });
            })
            .catch(function (exp) {
              alert(exp.message);
            });
        }
      }

      // upload(), binarizeImage(), rotateCW(), rotateCCW() — identical to CDN example above
    </script>
  </body>
</html>

When using local resources, the configuration (ProductKey, ResourcesPath, Containers) is set inside dynamsoft.webtwain.config.js. You don't set them again in your page script.

3. React (npm Package)

Install the npm package and use DWT inside a React component:

npm install dwt ncp

Add a script to copy DWT static resources from node_modules to your public folder:

{
  "scripts": {
    "copy-resources": "ncp node_modules/dwt/dist public/dwt-resources",
    "dev": "npm run copy-resources && vite",
    "build": "npm run copy-resources && vite build"
  }
}

// src/DWT.tsx
import React, { useEffect, useRef } from "react";
import Dynamsoft from "dwt";

function DWT() {
  const containerId = "dwtcontrolContainer";
  const dwtObject = useRef<any>(null);

  useEffect(() => {
    Dynamsoft.DWT.RegisterEvent("OnWebTwainReady", () => {
      dwtObject.current = Dynamsoft.DWT.GetWebTwain(containerId);
    });

    Dynamsoft.DWT.ProductKey =
      "DLS2eyJoYW5kc2hha2VDb2RlIjoiMjAwMDAxLTEwNTI2NzQwMSIsIm1haW5TZXJ2ZXJVUkwiOiJodHRwczovL21kbHMuZHluYW1zb2Z0b25saW5lLmNvbS8iLCJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSIsInN0YW5kYnlTZXJ2ZXJVUkwiOiJodHRwczovL3NkbHMuZHluYW1zb2Z0b25saW5lLmNvbS8iLCJjaGVja0NvZGUiOi0zMzE5NzM0NjJ9";
    Dynamsoft.DWT.ResourcesPath = "/dwt-resources";
    Dynamsoft.DWT.Containers = [
      {
        WebTwainId: "dwtObject",
        ContainerId: containerId,
        Width: "300px",
        Height: "400px",
      },
    ];

    Dynamsoft.DWT.Load();

    return () => {
      if (dwtObject.current) {
        dwtObject.current.Unload();
      }
    };
  }, []);

  const acquireImage = () => {
    if (dwtObject.current) {
      dwtObject.current
        .SelectSourceAsync()
        .then(() =>
          dwtObject.current.AcquireImageAsync({
            IfCloseSourceAfterAcquire: true,
          })
        )
        .catch((error: any) => {
          console.error(error.message);
        });
    }
  };

  return (
    <>
      <button onClick={acquireImage}>Scan</button>
      <div id={containerId}></div>
    </>
  );
}

export default DWT;

// App.tsx
import DWT from "./DWT";

function App() {
  return <DWT />;
}

export default App;

Note: When using the npm package, clear any default styles in src/App.css and src/index.css to avoid layout conflicts with the DWT viewer.

Reference Documentation

The full API reference and guides are available online. When you need details beyond what's in this skill, fetch documentation from:

Index: https://www.dynamsoft.com/web-twain/docs/llms.txt

This lists all available documentation pages with their URLs. Fetch it first to discover the relevant page, then fetch that page for the full content.

Key API reference pages (under info/api/):

Topic	Online URL
API Index	`https://www.dynamsoft.com/web-twain/docs/info/api/index.md`
Global config (`Dynamsoft.DWT`)	`https://www.dynamsoft.com/web-twain/docs/info/api/Dynamsoft_WebTwainEnv.md`
Enumerations	`https://www.dynamsoft.com/web-twain/docs/info/api/Dynamsoft_Enum.md`
Interfaces	`https://www.dynamsoft.com/web-twain/docs/info/api/interfaces.md`
Scanner acquisition	`https://www.dynamsoft.com/web-twain/docs/info/api/WebTwain_Acquire.md`
Buffer management	`https://www.dynamsoft.com/web-twain/docs/info/api/WebTwain_Buffer.md`
Image editing	`https://www.dynamsoft.com/web-twain/docs/info/api/WebTwain_Edit.md`
Input/Output	`https://www.dynamsoft.com/web-twain/docs/info/api/WebTwain_IO.md`
Viewer control	`https://www.dynamsoft.com/web-twain/docs/info/api/WebTwain_Viewer.md`
Utility methods	`https://www.dynamsoft.com/web-twain/docs/info/api/WebTwain_Util.md`
Device management	`https://www.dynamsoft.com/web-twain/docs/info/api/Device.md`
File uploader	`https://www.dynamsoft.com/web-twain/docs/info/api/Dynamsoft_FileUploader.md`
RESTful API	`https://www.dynamsoft.com/web-twain/docs/info/api/restful.md`
Barcode Reader add-on	`https://www.dynamsoft.com/web-twain/docs/info/api/Addon_BarcodeReader.md`
OCR add-on	`https://www.dynamsoft.com/web-twain/docs/info/api/Addon_OCR.md`
PDF Rasterizer add-on	`https://www.dynamsoft.com/web-twain/docs/info/api/Addon_PDF.md`
Webcam add-on	`https://www.dynamsoft.com/web-twain/docs/info/api/Addon_Webcam.md`
Appendix	`https://www.dynamsoft.com/web-twain/docs/info/api/appendix.md`

Additional guides available via llms.txt: hello-world tutorials, general usage, extended usage (barcode, OCR, PDF, UI customization, RESTful API), FAQs, deployment, framework integration (React, Vue, Angular), upgrade guides, and release notes.

DWT Configuration Reference

See Global APIs for the full global API reference.

These properties must be set before calling Dynamsoft.DWT.Load():

Property	Required	Description
`ProductKey`	Yes	A 1-day trial license key is included by default. Replace with your own trial or full license key from Dynamsoft for production use.
`ResourcesPath`	Yes	Path to DWT static resources (.js, .css, .wasm files)
`Containers`	Yes	Array of container configs: `{ WebTwainId?, ContainerId?, Width?, Height? }`
`AutoLoad`	No	Set to `false` for manual loading (recommended in frameworks)
`ServiceInstallerLocation`	No	URL for the Dynamsoft Service installer download
`IfCheckCssFiles`	No	Set to `false` when resources are bundled locally to skip CSS verification
`IfAlwaysFocusOnPopupWindow`	No	Control whether the scanner-related UI and load/save UI are always displayed in the foreground.

Container Configuration

Dynamsoft.DWT.Containers = [
  {
    WebTwainId: "dwtObject",      // Optional — id to reference this instance
    ContainerId: "dwtContainer",  // Optional — id of the div element
    Width: "360px",               // Optional — width of the container appended to the div element
    Height: "480px",              // Optional — height of the container appended to the div element
  },
];

ContainerId must match the id of the <div> that will host the viewer
WebTwainId and ContainerId are both optional but one must exist as the identifier for that WebTwain instance. You can leave ContainerId empty if you don't want DWT to create a viewer UI (headless mode).
Width/Height define the viewer dimensions

Common Operations

Image Acquisition

See Acquire APIs for the full acquire API reference.

DWT provides two modes: silent (custom settings) and interactive (scanner's native UI):

// Mode 1: Silent scan with full control
async function acquireImage() {
  if (!DWTObject) return;
  try {
    await DWTObject.SelectSourceAsync(); // Opens a dialog to select the scanner source. You can also use SelectDeviceAsync(device) if you already have the device info.
    await DWTObject.AcquireImageAsync({
      IfCloseSourceAfterAcquire: true,
      IfShowUI: false,
      PixelType: Dynamsoft.DWT.EnumDWT_PixelType.TWPT_GRAY, // BW: 0, Gray: 1, RGB: 2
      Resolution: 200,
      IfDuplexEnabled: true,
      IfFeederEnabled: true,
    });
  } catch (exp) {
    alert(exp.message);
  }
}

async function acquireImageWithSpecifiedScanner(device) {
  if (!DWTObject) return;
  await DWTObject.SelectDeviceAsync(device); // Get the list of devices using DWTObject.GetDevicesAsync()
  await DWTObject.AcquireImageAsync({
    IfCloseSourceAfterAcquire: true,
  })
}

// Mode 2: Let scanner's native dialog handle settings
async function acquireImageWithUI() {
  if (!DWTObject) return;
  try {
    await DWTObject.SelectSourceAsync();
    await DWTObject.AcquireImageAsync({
      IfCloseSourceAfterAcquire: true,
      IfShowUI: true,
    });
  } catch (exp) {
    alert(exp.message);
  }
}

Key AcquireImageAsync options:

Option	Type	Description
`IfShowUI`	bool	Show the scanner's native settings dialog
`IfCloseSourceAfterAcquire`	bool	Close scanner connection after scan completes
`PixelType`	enum	Color mode: BW (0), Gray (1), RGB (2)
`Resolution`	number	DPI (typical: 150–300)
`IfDuplexEnabled`	bool	Scan both sides of the page
`IfFeederEnabled`	bool	Use document feeder if available

Image Processing

See Edit APIs for the full image editing API reference.

function binarizeImage() {
  DWTObject.ConvertToBW(DWTObject.CurrentImageIndexInBuffer);
}

function rotateClockwise() {
  DWTObject.RotateRight(DWTObject.CurrentImageIndexInBuffer);
}

function rotateCounterClockwise() {
  DWTObject.RotateLeft(DWTObject.CurrentImageIndexInBuffer);
}

function mirrorImage() {
  DWTObject.Mirror(DWTObject.CurrentImageIndexInBuffer);
}

function flipImage() {
  DWTObject.Flip(DWTObject.CurrentImageIndexInBuffer);
}

function cropImage(left, top, right, bottom) {
  DWTObject.Crop(DWTObject.CurrentImageIndexInBuffer, left, top, right, bottom);
}

function deskew(index) {
  DWTObject.GetSkewAngle(
    index,
    function(angle) {
      console.log("skew angle: " + angle);
      DWTObject.Rotate(index, angle, true,
        function() {
          console.log("Successfully deskewed an image!");
        },
        function(errorCode, errorString) {
          console.log(errorString);
        }
      );
    },
    function(errorCode, errorString) {
      console.log(errorString);
    }
  );
}

TWAIN Capabilities

You can also use TWAIN capabilities directly for more advanced control. For example, enable barcode detection during scanning and read the results in the OnPostTransferAsync event with the following code:

var DWTObject;
Dynamsoft.DWT.RegisterEvent("OnWebTwainReady", function () {
  DWTObject = Dynamsoft.DWT.GetWebTwain('dwtcontrolContainer'); // Get the Dynamic Web TWAIN object that is embeded in the div with id 'dwtcontrolContainer'
  DWTObject.RegisterEvent("OnPostTransferAsync", function (outputInfo) {
    console.log(outputInfo);
    var dwtBarcode = document.getElementById("DWTBarcode");
    if (outputInfo && outputInfo.extendedImageInfo && outputInfo.extendedImageInfo.barcode && outputInfo.extendedImageInfo.barcode.length > 0) {
      console.log(outputInfo.extendedImageInfo.barcode[0]);
    }
  });
});

function AcquireImage() {
  if (DWTObject) {
    DWTObject.SelectSourceAsync().then(function () {
      DWTObject.setCapabilities({
        exception: "fail", capabilities: [{
          capability: Dynamsoft.DWT.EnumDWT_Cap.ICAP_BARCODEDETECTIONENABLED,
          curValue: true
        }]
      }, function (c) {
        return DWTObject.AcquireImageAsync({
          IfShowUI: false,
          IfCloseSourceAfterAcquire: true, // Scanner source will be closed automatically after the scan.
          IfGetExtImageInfo: true,
          extendedImageInfoQueryLevel: 0
        });
      }, function (errorData) {
        if (errorData.capabilities && errorData.capabilities.length > 0)
          if (errorData.capabilities[0].errorString)
            alert(errorData.capabilities[0].errorString);
        DWTObject.CloseSourceAsync();
      });
    }).catch(function (exp) {
      alert(exp.message);
      DWTObject.CloseSourceAsync();
    });
  }
}

Upload

See I/O APIs and Uploader APIs for the full upload API reference.

// Upload current image as PNG
function uploadCurrentAsPNG() {
  if (!DWTObject || DWTObject.HowManyImagesInBuffer === 0) return;

  DWTObject.HTTPUpload(
    "https://your-api.com/upload",
    [DWTObject.CurrentImageIndexInBuffer],
    Dynamsoft.DWT.EnumDWT_ImageType.IT_PNG, // JPG: 1, PNG: 2, TIF: 3, PDF: 4
    Dynamsoft.DWT.EnumDWT_UploadDataFormat.Binary, // Binary: 1, Base64: 2
    "ScannedDocument.png",
    function () {
      alert("Upload successful");
    },
    function (errorCode, errorString, sHttpResponse) {
      alert(sHttpResponse.length > 0 ? sHttpResponse : errorString);
    }
  );
}

// Upload all images as PDF
function uploadAllAsPDF() {
  if (!DWTObject || DWTObject.HowManyImagesInBuffer === 0) return;

  var indices = [];
  for (var i = 0; i < DWTObject.HowManyImagesInBuffer; i++) {
    indices.push(i);
  }

  DWTObject.HTTPUpload(
    "https://your-api.com/upload",
    indices,
    Dynamsoft.DWT.EnumDWT_ImageType.IT_PDF,
    Dynamsoft.DWT.EnumDWT_UploadDataFormat.Binary,
    "document.pdf",
    function () {
      alert("Upload successful");
    },
    function (errorCode, errorString, sHttpResponse) {
      alert(sHttpResponse.length > 0 ? sHttpResponse : errorString);
    }
  );
}

// Get image as base64 (for custom upload logic)
function getImageAsBase64(indices) {
  DWTObject.ConvertToBase64(
    indices,
    Dynamsoft.DWT.EnumDWT_ImageType.IT_PDF,
    function (result, indices, type) {
      console.log(result.getData(0, result.getLength()));
    },
    function (errorCode, errorString) {
      console.log(errorString);
    },
  );
}

Input

See I/O APIs for the full I/O API reference.

// Load image from file
function loadImageFromDisk() {
  DWTObject.IfShowFileDialog = true; //"Open File" dialog will be opened.
  DWTObject.LoadImageEx(
    "", //file name can be empty if "Open File" dialog is called.
    Dynamsoft.DWT.EnumDWT_ImageType.IT_JPG,
    function () {
      console.log("success");
    },
    function (errorCode, errorString) {
      console.log(errorString);
    },
  );
}

// Load image from binary (Blob | ArrayBuffer)
function loadImageFromBinary(imageData){
  DWTObject.LoadImageFromBinary(
    imageData,
    function () {
      console.log("success");
    },
    function (errorCode, errorString) {
      console.log(errorString);
    },
  );
}

Buffer Management

See Buffer APIs for the full buffer API reference.

// Navigate through scanned images
DWTObject.CurrentImageIndexInBuffer = 2; // Switch to 3rd image (0-based)

// Remove current image
DWTObject.RemoveImage(DWTObject.CurrentImageIndexInBuffer);

// Remove selected images
DWTObject.RemoveImages([0, 2, 4]);

// Clear all images
DWTObject.RemoveAllImages();

// Get total pages in buffer
var count = DWTObject.HowManyImagesInBuffer;

// Reorder images
DWTObject.SwitchImage(0, 3); // Swap image at index 0 with index 3

// Get image URL for display in an img element
DWTObject.GetImageURL(index);

Saving Locally

See I/O APIs for more save/export options.

// Save current image as file
function saveCurrentImage() {
  DWTObject.SaveAsPNG("scanned.png", DWTObject.CurrentImageIndexInBuffer);
}

function saveAllAsPDF() {
  DWTObject.SaveAllAsPDF("all-pages.pdf");
}

function saveAllAsTIFF() {
  DWTObject.SaveAllAsMultiPageTIFF("all-pages.tiff");
}

DWT Events

// Fires once when DWT is fully initialized
Dynamsoft.DWT.RegisterEvent("OnWebTwainReady", function () {
  DWTObject = Dynamsoft.DWT.GetWebTwain("dwtcontrolContainer");
});

// Fires when images in the buffer change like flipped, cropped, rotated, etc. or a new image has been acquired.
// Operation type:
// 1: new image(s) added at the tail
// 2: image(s) inserted before the current index
// 3: image(s) deleted
// 4: image(s) modified
DWTObject.RegisterEvent("OnBitmapChanged", function (indices, type, index) {
    console.log(indices);
});

// An enhanced callback triggered when a change occurs in the buffer.
// Action types include
//   add: New pages are added to the buffer.
//   remove: The existing pages are removed.
//   modify: The existing pages are modified.
//   shift: The existing pages are reordered or the selected pages are changed.
//   filter: The existing pages are filtered by a tag.
DWTObject.RegisterEvent("OnBufferChanged", function (bufferChangeInfo) {
    console.log(bufferChangeInfo);
});


// Fires after each page is scanned and transferred to the buffer
DWTObject.RegisterEvent("OnPostTransferAsync", function (outputInfo) {
  console.log("Page scanned, index:", outputInfo);
});

Enum Reference

See Enumerations for the complete enum reference — PixelType, ImageType, UploadDataFormat, Cap, TransferMode, TIFFCompressionType, and more.

Quick reference for the most common enums:

Enum	Constant	Value
PixelType	`TWPT_BW` / `TWPT_GRAY` / `TWPT_RGB`	0 / 1 / 2
ImageType	`IT_JPG` / `IT_PNG` / `IT_TIF` / `IT_PDF`	1 / 2 / 3 / 4
UploadDataFormat	`Binary` / `Base64`	1 / 2

Dynamic Web TWAIN Service

DWT requires the Dynamic Web TWAIN Service (previously Dynamsoft Service) to be installed on the client machine for desktop scanning. The service:

Communicates between the browser and scanner drivers (TWAIN/ICA/SANE/WIA/eSCL)
Is bundled as a lightweight installer (Windows .msi, macOS .pkg, Linux .deb/.rpm)
Must be running for scanner access to work

If the service is not installed, DWT will prompt the user to download it. Set ServiceInstallerLocation to control where the installer is fetched from:

Dynamsoft.DWT.ServiceInstallerLocation =
  "https://unpkg.com/dwt/dist/dist/";

Without this URL, users will be directed to according to ResourcesPath.

Platform Support

OS	Browser	Scanner Protocols
Windows	Chrome, Edge, Firefox	TWAIN, WIA, eSCL
macOS	Chrome, Safari, Firefox	ICA, TWAIN, eSCL
Linux	Chrome, Firefox	SANE

name	use-dynamic-web-twain
description	Integrate Dynamic Web TWAIN document scanning into web apps. Scan, upload, and process images from scanners/cameras in vanilla JS or React.
version	1.0.0
license	MIT