Mobile Document Scanner API Reference
Dynamsoft Mobile Document Scanner. It captures document pages with the camera or from image files, lets the user rectify, check, and edit them, and exports the result.
The host application is the web application that embeds the document scanner. It gives the document scanner its settings and handlers, and receives the result. The user is the person who scans.
A session is one run of scan(), from the call until it resolves. The pages belong to the document scanner and outlive a session. A finished or failed session keeps them for the next session. The pages go with cancel(), reset(), and dispose().
Make a DocumentScanner with ScannerSettings, and call scan(). scan() resolves with a ScanResult when the session ends. An import of this module has no side effects. The engines load on preload() or on the first scan(), so the module is safe to import during server-side rendering.
The package follows Semantic Versioning 2.0.0. Only a major release breaks the public interface, with two exceptions. A minor release may add a member to a union whose documentation says so, such as ScannerError. A member marked as experimental can change in any release.
Classes
Interfaces
- ButtonEvent
- ButtonSettings
- CaptureLayout
- CaptureSettings
- DocumentState
- EditLayout
- EditModes
- EditSettings
- EngineSettings
- FilterModeSettings
- PageImageBase
- PhaseSettings
- Point
- Quadrilateral
- RasterImage
- RectifyLayout
- RectifyModes
- RectifyModeSettings
- RectifySettings
- ResourceSettings
- ScannedPage
- ScannerEvents
- ScannerSettings
- StringSettings
- SuccessfulScan
- ThemeTokens
- VectorImage
Type Aliases
- AfterCaptureButton
- ButtonSettingsFor
- CaptureScreenArea
- CaptureScreenButton
- DocumentChange
- EditMode
- EditModeButton
- EditScreenButton
- FilterName
- FromEditButton
- ImageEncoding
- LicenseErrorReason
- ModeName
- Navigation
- OutputSettings
- OverlayName
- PageId
- PageImage
- PhaseName
- RectifyMode
- RectifyScreenButton
- ScannedPages
- ScannerError
- ScannerEventName
- ScannerStateReason
- ScanOutput
- ScanResult
- ThemeToken