API Documentation

Basic Scan

Methods
AcquireImage() CloseSource() DisableSource()
EnableSource() OpenSource() SelectSource()
SelectSourceByIndex() SetOpenSourceTimeout()
Properties
BitDepth IfAppendImage IfDisableSourceAfterAcquire
IfDuplexEnabled IfFeederEnabled IfShowUI
ImageCaptureDriverType PageSize PixelType
Resolution SourceCount
Events
OnPostAllTransfers OnPostTransfer

Basic Edit

Methods
AddText() ChangeBitDepth() ChangeImageSize()
ConvertToGrayScale() CopyToClipboard() CreateTextFont()
Crop() CropToClipboard() CutFrameToClipboard()
CutToClipboard() Erase() Flip()
Mirror() MoveImage() OverlayRectangle()
RemoveAllImages() RemoveAllSelectedImages() RemoveImage()
Rotate() RotateEx() RotateLeft()
RotateRight() SetDPI() SetImageWidth()
SetSelectedImageArea() SetSelectedImageIndex() ShowImageEditor()
SwitchImage()
Properties
SelectionRectAspectRatio
Events
OnImageAreaSelected OnImageAreaDeSelected

UI & Display

Methods
SetViewMode()
Properties
BackgroundColor BackgroundFillColor FitWindowType
Height IfAutoScroll IfFitWindow
ImageMargin MaxImagesInBuffer MouseShape
SelectionImageBorderColor Width Zoom
ShowPageNumber MouseX MouseY
Events
OnTopImageInTheViewChanged OnMouseClick
OnMouseDoubleClick OnMouseMove
OnMouseRightClick

Load & Save

Methods
FileExists() LoadDibFromClipboard()
LoadImage() LoadImageEx()
LoadImageFromBase64Binary() SaveAllAsMultiPageTIFF()
SaveAllAsPDF() SaveAsBMP()
SaveAsJPEG() SaveAsPDF()
SaveAsPNG() SaveAsTIFF()
SaveSelectedImagesAsMultiPagePDF() SaveSelectedImagesAsMultiPageTIFF()
SaveSelectedImagesToBase64Binary() ShowFileDialog()
Properties
IfShowFileDialog
Events
OnGetFilePath OnPostLoad

Upload & Download

Methods
ClearAllHTTPFormField() FTPDownload()
FTPDownloadDirectly() FTPDownloadEx()
FTPUpload() FTPUploadAllAsMultiPageTIFF()
FTPUploadAllAsPDF() FTPUploadAsMultiPagePDF()
FTPUploadAsMultiPageTIFF() FTPUploadDirectly()
FTPUploadEx() HTTPDownload()
HTTPDownloadDirectly() HTTPDownloadEx()
HTTPUpload() HTTPUploadAllThroughPostAsMultiPageTIFF()
HTTPUploadAllThroughPostAsPDF() HTTPUploadThroughPost()
HTTPUploadThroughPostAsMultiPagePDF() HTTPUploadThroughPostAsMultiPageTIFF()
HTTPUploadThroughPostDirectly() HTTPUploadThroughPostEx()
SetHTTPFormField() SetUploadSegment()
SetHTTPHeader()
Properties
FTPPassword FTPPort
FTPUserName HttpFieldNameOfUploadedImage
HTTPPort HTTPPostResponseString
IfPASVMode IfShowCancelDialogWhenImageTransfer
IfSSL MaxUploadImageSize
Events
OnInternetTransferPercentage

Advanced Scan

Methods
CancelAllPendingTransfers() CloseSourceManager() CloseWorkingProcess()
FeedPage() GetCustomDSData() GetCustomDSDataEx()
GetDeviceType() GetSourceNameItems() OpenSourceManager()
ResetImageLayout() RewindPage() SetCustomDSData()
SetCustomDSDataEx() SetFileXferInfo() SetImageLayout()
Properties
Brightness Contrast CurrentSourceName
DataSourceStatus DefaultSourceName Duplex
IfAutoBright IfAutoDiscardBlankpages IfAutoFeed
IfAutomaticBorderDetection IfAutomaticDeskew IfAutoScan
IfFeederLoaded IfPaperDetectable IfShowIndicator
IfUIControllable IfUseTwainDSM PendingXfers
PixelFlavor TransferMode Unit
XferCount
Events
OnPreAllTransfers OnPreTransfer OnSourceUIClose

Capability Negotiation

Methods
CapGet() CapGetCurrent() CapGetDefault()
CapGetFrameBottom() CapGetFrameLeft() CapGetFrameRight()
CapGetFrameTop() CapGetHelp() CapGetLabel()
CapGetLabels() CapIfSupported() CapReset()
CapSet() CapSetFrame() GetCapItems()
GetCapItemsString() SetCapItems() SetCapItemsString()
Properties
Capability CapCurrentIndex CapCurrentValue
CapDefaultIndex CapDefaultValue CapMaxValue
CapMinValue CapNumItems CapStepSize
CapType CapValue CapValueString
CapValueType

Encode & Decode

Methods
ClearTiffCustomTag() ConvertToBase64() ConvertToBlob()
SetTiffCustomTag()
Properties
IfOpenImageWithGDIPlus() IfTiffMultiPage() JPEGQuality()
PDFAuthor() PDFCompressionType() PDFCreationDate()
PDFCreator() PDFKeywords() PDFModifiedDate()
PDFProducer() PDFSubject() PDFTitle()
PDFVersion() TIFFCompressionType()

Runtime Info

Methods
GetImageBitDepth() GetImageHeight() GetImageSize()
GetImageSizeWithSpecifiedType() GetImageWidth() GetImageXResolution()
GetImageYResolution() GetSelectedImageIndex() GetSelectedImagesSize()
GetSkewAngle() GetSkewAngleEx() IsBlankImageExpress()
Properties
BlankImageCurrentStdDev BlankImageMaxStdDev BlankImageThreshold
CurrentImageIndexInBuffer HowManyImagesInBuffer ImageLayoutDocumentNumber
ImageLayoutFrameBottom ImageLayoutFrameLeft ImageLayoutFrameNumber
ImageLayoutFrameRight ImageLayoutFrameTop ImageLayoutPageNumber
ImagePixelType MagData MagType
SelectedImagesCount

General Utilities

Methods
GetImagePartURL() GetImageURL() Print()
RegisterEvent() UnregisterEvent() SetLanguage()
Properties
BufferMemoryLimit ErrorCode ErrorString
IfAllowLocalCache IfShowProgressBar LogLevel
Manufacturer ProductFamily ProductKey
ProductName VersionInfo
Events
OnBitmapChanged

PDF Rasterizer

Methods
Addon.PDF.Download() Addon.PDF.SetResolution()
Addon.PDF.SetPassword() Addon.PDF.SetConvertMode()

Webcam Capture

Methods
Addon.Webcam.CaptureImage() Addon.Webcam.CloseSource()
Addon.Webcam.Download() Addon.Webcam.GetCameraControlPropertyMoreSetting()
Addon.Webcam.GetCameraControlPropertySetting() Addon.Webcam.GetFrameRate()
Addon.Webcam.GetImagePartUrl() Addon.Webcam.GetImageUrl()
Addon.Webcam.GetMediaType() Addon.Webcam.GetResolution()
Addon.Webcam.GetSourceList() Addon.Webcam.GetVideoPropertyMoreSetting()
Addon.Webcam.GetVideoPropertySetting() Addon.Webcam.PauseVideo()
Addon.Webcam.PlayVideo() Addon.Webcam.SelectSource()
Addon.Webcam.SetCameraControlPropertySetting() Addon.Webcam.SetFrameRate()
Addon.Webcam.SetMediaType() Addon.Webcam.SetResolution()
Addon.Webcam.SetVideoPropertySetting() Addon.Webcam.SetVideoRotateMode()
Addon.Webcam.StopVideo()

File Uploader

Methods
Init() CreateJob() Run()
Cancel() CancelAllUpload() GenerateURLForUploadData()
Properties
ServerUrl HttpHeader SourceValue
Events
OnUploadTransferPercentage OnRunSuccess OnRunFailure

Barcode Reader

Constructor
dynamsoft.BarcodeReader()
Methods
decode() decodeBase64String() getRuntimeSettings()
updateRuntimeSettings() resetRuntimeSettings()
dynamsoft.BarcodeReader.initServiceConnection()
Properties
productKey bAutoConnectService
resourcesPath ifCheck64bitServiceFirst
Events
onAutoConnectServiceSuccess onAutoConnectServiceError

Enumerations

Errors

OCR Basic

Client-Side

Methods
Download() DownloadLangData() GetIfUseDetectedFont()
GetMinFontSizeforMoreAccurateResult() GetUnicodeFontName() IsModuleInstalled()
Recognize() RecognizeFile() RecognizeRect()
RecognizeSelectedImages SetIfUseDetectedFont() SetLanguage()
SetMinFontSizeforMoreAccurateResult() SetOutputFormat() SetPageSetMode()
SetUnicodeFontName()
OCR Basic Result Object
Result PageSetResult PageResult
LineResult WordResult

Server-Side (Java)

OCR Pro

Client-Side

Methods
Download() IsModuleInstalled() Recognize()
RecognizeFile() RecognizeRect() RecognizeSelectedImages
Properties
Settings
OCR Pro Result Object
OCRResult PageResult
LetterResult ErrorInfo

Server-Side

OCRPro.ServerSide.Request

OCRPro.ServerSide.Response

results matching ""

    No results matching ""

    results matching ""

      No results matching ""