Dev Center
Some old APIs are deprecated, check out Deprecated Features and APIs
API List
Global
WebTwain
Buffer
Methods
- ClearImageTags()
- FilterImagesByTag()
- SetDefaultTag()
- TagImages()
- GetImageBitDepth()
- GetImageSize()
- GetImageSizeWithSpecifiedType()
- GetSelectedImagesSize()
- GetImageHeight()
- GetImageWidth()
- GetImagePartURL()
- GetImageURL()
- GetImageXResolution()
- GetImageYResolution()
- GetSkewAngle()
- GetSkewAngleEx()
- ImageIDToIndex()
- IndexToImageID()
- IsBlankImage()
- IsBlankImageExpress()
- SelectAllImages()
- SelectImages()
- MoveImage()
- SwitchImage()
- RemoveImage()
- RemoveAllImages()
- RemoveAllSelectedImages()
Properties
- BlankImageCurrentStdDev
- BlankImageMaxStdDev
- BlankImageThreshold
- BufferMemoryLimit
- CurrentImageIndexInBuffer
- HowManyImagesInBuffer
- IfAllowLocalCache
- SelectedImagesIndices
- MaxImagesInBuffer
Events
- OnBitmapChanged
- OnImageAreaSelected
- OnImageAreaDeSelected
- OnIndexChangeDragDropDone
- OnTopImageInTheViewChanged
Edit
Methods
- Crop()
- CropToClipboard()
- CutFrameToClipboard()
- CutToClipboard()
- CopyToClipboard()
- Erase()
- Flip()
- Mirror()
- Rotate()
- RotateEx()
- RotateLeft()
- RotateRight()
- ChangeBitDepth()
- SetDPI()
- ConvertToBW()
- ConvertToGrayScale()
- ChangeImageSize()
- Invert()
- SetImageWidth()
- ShowImageEditor()
Properties
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
The following APIs are compatible with TWAIN (mostly Windows, but could also be macOS)
Methods
- CancelAllPendingTransfers()
- CloseSourceManager()
- FeedPage()
- GetCustomDSData()
- GetCustomDSDataEx()
- OpenSourceManager()
- ResetImageLayout()
- RewindPage()
- SetCustomDSData()
- SetCustomDSDataEx()
- SetFileXferInfo()
- SetImageLayout()
- getCapabilities
- setCapabilities
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
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()
Properties
- FTPPassword
- FTPPort
- FTPUserName
- IfPASVMode
- HttpFieldNameOfUploadedImage
- HTTPPort
- IfSSL
- HTTPPostResponseString
- IfShowFileDialog
- IfShowCancelDialogWhenImageTransfer
- IfShowProgressBar
- JPEGQuality
- IfTiffMultiPage
- TIFFCompressionType
- MaxUploadImageSize
- IfAppendImage
Events
Util
Methods
Properties
- ErrorCode
- ErrorString
- LogLevel
- Manufacturer
- ProductFamily
- ProductName
- VersionInfo
- ProductKey
- UseLocalService
Viewer
For WebTwain instances
Methods
Properties
- BackgroundColor
- SelectionImageBorderColor
- FitWindowType
- IfFitWindow
- Height
- Width
- IfAutoScroll
- ShowPageNumber
- MouseX
- MouseY
- ImageMargin
- MouseShape
- SelectionRectAspectRatio
- Zoom
Events
For the WebTwain. Viewer interface
Methods
- setViewMode()
- updateUISettings()
- setButtonClass()
- setSelectedImageArea()
- zoomIn()
- zoomOut()
- bindCustomElement
- showCustomElement
- hideCustomElement
- toggleCustomElement
- showVideo()
- closeVideo()
- on()
Properties
Events
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
Methods
Camera
Methods
- getSourceList()
- selectSource()
- getCurrentSource()
- closeSource()
- getResolution()
- setResolution()
- getCurrentResolution()
- play()
- pause()
- resume()
- stop()
- getStatus()
- capture()
Webcam
Methods
- CaptureImage()
- CloseSource()
- GetCameraControlPropertySetting()
- GetCameraControlPropertyMoreSetting()
- GetVideoPropertySetting()
- GetVideoPropertyMoreSetting()
- SetCameraControlPropertySetting()
- SetVideoPropertySetting()
- GetFrameRate()
- SetFrameRate()
- GetMediaType()
- SetMediaType()
- GetResolution()
- SetResolution()
- GetFramePartURL()
- GetFrameURL()
- GetSourceList()
- SelectSource()
- PauseVideo()
- PlayVideo()
- SetVideoRotateMode()
- StopVideo()
Yes
No