×

MENU

Dynamsoft barcode reader

1D & 2D barcode reader SDK for desktop, web and mobile

Advanced Modules:

DPM | Intermediate Results Integration

Dynamic web twain

Cross-browser document scanning SDK for web applications

Advanced Modules:

PDF Rasterizer | Mobile Web Capture

Dynamsoft Label Recognizer

Localize and extract key data from specified region using OCR

Dynamic .Net twain

Document scanning SDK for .NET desktop applications

Other Technologies

Dynamsoft Panorama™

Proprietary technology for warehouse barcode scanning

Camera Enhancer

High-level camera APIs for mobile applications

See All Products › try our online demos ›

Web Demos

BARCODE READER SDK DEMO

Explore the flexibe barcode reading settings to optimize for your specific usage scenario.

WEB TWAIN SDK DEMO

Try the most popular web scanner features: scan images, import local images and PDF files, edit, save to local, upload to database, and etc.

BARCODE READER JAVASCRIPT DEMO

Transform any camera-equipped devices into real-time, browser-based barcode and QR code scanners.

MRZ SCANNER WEB DEMO

Detects the machine-readable zone of a passport, scans the text, and parses into human-readable data.

APP STORE DEMOS

BARCODE READER SDK FOR IOS

BARCODE READER SDK FOR ANDROID

VIEW MORE DEMOS >

Download Free Trial

Dev Center

Table of contents

Documentation

Some old APIs are deprecated, check out Deprecated Features and APIs

API List

Global


`Dynamsoft.DWT`	`Dynamsoft.DWT.Enum`

WebTwain

Buffer

Methods


`ClearImageTags()`	`RenameTag()`	`RemoveTag()`	`GetTagList()`
`FilterImagesByTag()`	`ClearFilter()`	`SetDefaultTag()`	`TagImages()`
`GetImageBitDepth()`	`GetImageSize()`	`GetImageSizeWithSpecifiedType()`	`GetSelectedImagesSize()`
`GetImageHeight()`	`GetImageWidth()`	`GetImagePartURL()`	`GetImageURL()`
`GetImageXResolution()`	`GetImageYResolution()`	`GetSkewAngle()`	`GetSkewAngleEx()`
`ImageIDToIndex()`	`IndexToImageID()`	`IsBlankImage()`	`IsBlankImageExpress()`
`SelectAllImages()`	`MoveImage()`	`SwitchImage()`	`RemoveImage()`
`RemoveAllImages()`	`RemoveAllSelectedImages()`	`SelectImages()`

Properties


`BlankImageCurrentStdDev`	`BlankImageMaxStdDev`	`BlankImageThreshold`	`BufferMemoryLimit`
`CurrentImageIndexInBuffer`	`HowManyImagesInBuffer`	`IfAllowLocalCache`	`SelectedImagesIndices`
`MaxImagesInBuffer`

Events


`OnBufferChanged`	`OnBitmapChanged`	`OnIndexChangeDragDropDone`	`OnTopImageInTheViewChanged`

Edit

Methods


`Crop()`	`CropToClipboard()`	`CutFrameToClipboard()`	`CutToClipboard()`
`CopyToClipboard()`	`Erase()`	`Flip()`	`Mirror()`
`Rotate()`	`RotateEx()`	`RotateLeft()`	`RotateRight()`
`ChangeBitDepth()`	`SetDPI()`	`ConvertToBW()`	`ConvertToGrayScale()`
`ChangeImageSize()`	`Invert()`	`SetImageWidth()`

Properties


`BackgroundFillColor`

Scan

Methods


`GetSourceNameItems()`	`GetSourceNames()`	`GetSourceNamesAsync()`	`GetDeviceType()`
`SelectSource()`	`SelectSourceAsync()`	`SelectSourceByIndex()`	`SelectSourceByIndexAsync()`
`SetOpenSourceTimeout()`	`OpenSource()`	`OpenSourceAsync()`	`EnableSourceUI()`
`EnableSource()`	`AcquireImage()`	`startScan()`	`DisableSource()`
`CloseSource()`	`CloseSourceAsync()`	`CloseWorkingProcess()`

Properties


`CurrentSourceName`	`IfDisableSourceAfterAcquire`	`IfDuplexEnabled`	`IfFeederEnabled`
`PageSize`	`PixelType`	`Resolution`	`SourceCount`

Events


`OnPostAllTransfers`	`OnPostTransfer`	`OnPostTransferAsync`
`OnPreAllTransfers`	`OnPreTransfer`

The following APIs are compatible with TWAIN and ICA

Methods


`getCapabilities()`	`setCapabilities()`

The following APIs are compatible with TWAIN (mostly Windows, but could also be macOS)

Methods


`OpenSourceManager()`	`OpenSourceManagerAsync()`	`CloseSourceManager()`	`CloseSourceManagerAsync()`
`GetCustomDSData()`	`GetCustomDSDataEx()`	`CancelAllPendingTransfers()`	`FeedPage()`
`ResetImageLayout()`	`RewindPage()`	`SetCustomDSData()`	`SetCustomDSDataEx()`
`SetFileXferInfo()`	`SetImageLayout()`

Properties


`BitDepth`	`Brightness`	`Contrast`	`DataSourceStatus`
`DefaultSourceName`	`Duplex`	`IfAutoBright`	`IfAutoDiscardBlankpages`
`IfAutoFeed`	`IfAutomaticBorderDetection`	`IfAutomaticDeskew`	`IfAutoScan`
`IfFeederLoaded`	`IfPaperDetectable`	`IfShowIndicator`	`IfShowUI`
`IfUIControllable`	`IfUseTwainDSM`	`ImageCaptureDriverType`	`ImageLayoutDocumentNumber`
`ImageLayoutFrameBottom`	`ImageLayoutFrameLeft`	`ImageLayoutFrameNumber`	`ImageLayoutFrameRight`
`ImageLayoutFrameTop`	`ImageLayoutPageNumber`	`ImagePixelType`	`MagData`
`MagType`	`PendingXfers`	`PixelFlavor`	`TransferMode`
`Unit`	`XferCount`

Events


`OnSourceUIClose`

Input

Methods


`LoadImage()`	`LoadImageEx()`	`LoadImageFromBase64Binary()`	`LoadImageFromBinary()`
`LoadDibFromClipboard()`	`FTPDownload()`	`FTPDownloadEx()`	`HTTPDownload()`
`HTTPDownloadEx()`	`HTTPDownloadThroughPost()`	`HTTPDownloadDirectly()`

Output

Methods


`ConvertToBase64()`	`ConvertToBlob()`	`FTPUpload()`
`FTPUploadEx()`	`FTPUploadAllAsMultiPageTIFF()`	`FTPUploadAllAsPDF()`
`FTPUploadAsMultiPagePDF()`	`FTPUploadAsMultiPageTIFF()`	`HTTPUpload()`
`HTTPUploadThroughPutEx()`	`HTTPUploadThroughPost()`	`HTTPUploadThroughPostEx()`
`HTTPUploadAllThroughPostAsMultiPageTIFF()`	`HTTPUploadAllThroughPostAsPDF()`	`HTTPUploadThroughPostAsMultiPagePDF()`
`HTTPUploadThroughPostAsMultiPageTIFF()`	`HTTPUploadThroughPostDirectly()`	`SaveAsBMP()`
`SaveAsJPEG()`	`SaveAsPDF()`	`SaveAsPNG()`
`SaveAsTIFF()`	`SaveSelectedImagesAsMultiPagePDF()`	`SaveSelectedImagesAsMultiPageTIFF()`
`SaveAllAsMultiPageTIFF()`	`SaveAllAsPDF()`

Others

Methods


`ClearTiffCustomTag()`	`SetTiffCustomTag()`	`ClearAllHTTPFormField()`	`SetHTTPFormField()`
`SetHTTPHeader()`	`SetUploadSegment()`	`ShowFileDialog()`	`Print()`
`PrintEx()`

Properties


`FTPPassword`	`FTPPort`	`FTPUserName`	`IfPASVMode`
`HttpFieldNameOfUploadedImage`	`HTTPPort`	`IfSSL`	`HTTPPostResponseString`
`IfShowFileDialog`	`IfShowCancelDialogWhenImageTransfer`	`IfShowProgressBar`	`JPEGQuality`
`IfTiffMultiPage`	`TIFFCompressionType`	`MaxUploadImageSize`	`IfAppendImage`

Events


`OnGetFilePath`	`OnPostLoad`	`OnInternetTransferPercentage`

Util

Methods


`RegisterEvent()`	`UnregisterEvent()`	`SetProductKeyAsync()`
`SetLanguage()`	`GenerateURLForUploadData()`

Properties


`ErrorCode`	`ErrorString`	`LogLevel`	`Manufacturer`
`ProductFamily`	`ProductName`	`VersionInfo`	`ProductKey`
`UseLocalService`

Viewer

Methods


`bind()`	`clearSelectedAreas()`	`createCustomElement()`	`createImageEditor()`
`createThumbnailViewer()`	`first()`	`fitWindow()`	`gotoPage()`
`hide()`	`last()`	`next()`	`off()`
`on()`	`previous()`	`render()`	`setButtonClass()`
`setSelectedAreas()`	`setViewMode()`	`show()`	`unbind()`

Properties


`acceptDrop`	`allowSlide`	`background`	`border`
`cursor`	`height`	`idPostfix`	`ifAutoScroll`
`innerBorder`	`pageMargin`	`selectedAreaBorderColor`	`selectedPageBackground`
`selectedPageBorder`	`selectionRectAspectRatio`	`showPageNumber`	`singlePageMode`
`width`	`zoom`	`autoChangeIndex`

Events


`click`	`contextmenu`	`dblclick`	`mousemove`
`mousedown`	`mouseup`	`mouseout`	`mouseover`
`keydown`	`keyup`	`pageAreaSelected`	`pageAreaUnselected`
`pageRendered`	`resize`

Addon

BarcodeReader

Methods


`decode()`	`getRuntimeSettings()`	`updateRuntimeSettings()`
`resetRuntimeSettings()`	`initRuntimeSettingsWithString()`

OCR

Methods


`Download()`	`DownloadLangData()`	`IsModuleInstalled()`	`SetLanguage()`
`SetOutputFormat()`	`SetPageSetMode()`	`GetIfUseDetectedFont()`	`SetIfUseDetectedFont()`
`GetUnicodeFontName()`	`SetUnicodeFontName()`	`GetMinFontSizeforMoreAccurateResult()`	`SetMinFontSizeforMoreAccurateResult()`
`Recognize()`	`RecognizeFile()`	`RecognizeRect()`	`RecognizeSelectedImages()`

OCRPro

Methods


`Download()`	`IsModuleInstalled()`	`Recognize()`
`RecognizeFile()`	`RecognizeRect()`	`RecognizeSelectedImages()`

Properties


`Settings`

PDF

Methods


`GetConvertMode()`	`IsModuleInstalled()`	`IsTextBasedPDF()`	`SetConvertMode()`
`SetPassword()`	`SetResolution()`	`Write.Setup()`

Camera

Methods


`getSourceList()`	`selectSource()`	`getCurrentSource()`	`closeSource()`
`getResolution()`	`setResolution()`	`getCurrentResolution()`	`play()`
`pause()`	`resume()`	`stop()`	`getStatus()`
`capture()`	`showVideo()`	`closeVideo()`

Webcam

Methods


`CaptureImage()`	`CloseSource()`	`GetCameraControlPropertySetting()`	`GetCameraControlPropertyMoreSetting()`
`GetVideoPropertySetting()`	`GetVideoPropertyMoreSetting()`	`SetCameraControlPropertySetting()`	`SetVideoPropertySetting()`
`GetFrameRate()`	`SetFrameRate()`	`GetMediaType()`	`SetMediaType()`
`GetResolution()`	`SetResolution()`	`GetFramePartURL()`	`GetFrameURL()`
`GetSourceList()`	`SelectSource()`	`PauseVideo()`	`PlayVideo()`
`SetVideoRotateMode()`	`StopVideo()`

Dynamsoft.FileUploader

Methods


`Init()`	`CreateJob()`	`Run()`
`Cancel()`	`CancelAllUpload()`

Is this page helpful?

Yes

No

In this article:

version 17.1.1

Latest Version
Version 17.2.1
Version 17.1.1
Version 17.0
Version 16.2
Version 16.1.1

© 2003–2022 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support