Some old APIs are deprecated, check out Deprecated Features and APIs
API List
Global
WebTwain
Buffer
Methods
ClearImageTags()RenameTag()FilterImagesByTag()ClearFilter()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
BlankImageCurrentStdDevBlankImageMaxStdDevBlankImageThresholdBufferMemoryLimitCurrentImageIndexInBufferHowManyImagesInBufferIfAllowLocalCacheSelectedImagesIndicesMaxImagesInBuffer
Events
Edit
Methods
Crop()CropToClipboard()CutFrameToClipboard()CutToClipboard()CopyToClipboard()Erase()Flip()Mirror()Rotate()RotateEx()RotateLeft()RotateRight()ChangeBitDepth()SetDPI()ConvertToBW()ConvertToGrayScale()ChangeImageSize()Invert()SetImageWidth()
Properties
Scan
Methods
GetSourceNameItems()GetSourceNames()GetSourceNamesAsync()GetDeviceType()SelectSource()SelectSourceAsync()SelectSourceByIndex()SelectSourceByIndexAsync()SetOpenSourceTimeout()OpenSource()OpenSourceAsync()EnableSourceUI()EnableSource()AcquireImage()startScan()DisableSource()CloseSource()CloseSourceAsync()CloseWorkingProcess()
Properties
CurrentSourceNameIfDisableSourceAfterAcquireIfDuplexEnabledIfFeederEnabledPageSizePixelTypeResolutionSourceCount
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
BitDepthBrightnessContrastDataSourceStatusDefaultSourceNameDuplexIfAutoBrightIfAutoDiscardBlankpagesIfAutoFeedIfAutomaticBorderDetectionIfAutomaticDeskewIfAutoScanIfFeederLoadedIfPaperDetectableIfShowIndicatorIfShowUIIfUIControllableIfUseTwainDSMImageCaptureDriverTypeImageLayoutDocumentNumberImageLayoutFrameBottomImageLayoutFrameLeftImageLayoutFrameNumberImageLayoutFrameRightImageLayoutFrameTopImageLayoutPageNumberImagePixelTypeMagDataMagTypePendingXfersPixelFlavorTransferModeUnitXferCount
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
FTPPasswordFTPPortFTPUserNameIfPASVModeHttpFieldNameOfUploadedImageHTTPPortIfSSLHTTPPostResponseStringIfShowFileDialogIfShowCancelDialogWhenImageTransferIfShowProgressBarJPEGQualityIfTiffMultiPageTIFFCompressionTypeMaxUploadImageSizeIfAppendImage
Events
Util
Methods
Properties
ErrorCodeErrorStringLogLevelManufacturerProductFamilyProductNameVersionInfoProductKeyUseLocalService
Viewer
Methods
bind()clearSelectedAreas()createCustomElement()createImageEditor()createThumbnailViewer()first()fitWindow()gotoPage()hide()last()next()off()on()previous()render()setButtonClass()setSelectedAreas()setViewMode()show()unbind()
Properties
acceptDropallowSlidebackgroundbordercursorheightidPostfixifAutoScrollinnerBorderpageMarginselectedAreaBorderColorselectedPageBackgroundselectedPageBorderselectionRectAspectRatioshowPageNumbersinglePageModewidthzoom
Events
clickcontextmenudblclickmousemovemousedownmouseupmouseoutmouseoverkeydownkeyuppageAreaSelectedpageAreaUnselectedpageRenderedresizetopPageChanged
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()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()
Yes
No