Interface IDocumentScannerView
-
- All Implemented Interfaces:
public interface IDocumentScannerView
A component which allows to quickly integrate a Document scanning feature into your application. It wraps ContourDetectorFrameHandler, io.scanbot.sdk.ui.camera.IScanbotCameraView, io.scanbot.sdk.camera.IFinderView and DocumentAutoSnappingController providing an interface allowing to contol appearance and behavior of the component.
To start using it you need to add DocumentScannerView into your layout and the call two methods initCamera and initDetectionBehavior (see corresponding docs).
If you use a legacy camera (non CameraX - see CameraUiSettings) it is also required to call IDocumentScannerViewController.onResume on the viewController in Activity onResume and IDocumentScannerViewController.onPause on the viewController in Activity onPause
-
-
Method Summary
Modifier and Type Method Description abstract Unit
initCamera(CameraUiSettings cameraUiSettings)
This must be called in the onCreate of the Activity abstract Unit
initDetectionBehavior(ContourDetector contourDetector, ContourDetectorFrameHandler.ResultHandler contourDetectorResultHandler, IDocumentScannerViewCallback callback)
This should be called as soon as you have an instance of the Contour detector. abstract IDocumentScannerViewController
getViewController()
Use this object to control the state or the behavior of the IDocumentScannerView abstract IDocumentScannerViewCameraConfiguration
getCameraConfiguration()
Use this object to control configuration parameters of the Camera inside abstract IDocumentScannerPolygonViewController
getPolygonConfiguration()
Use this object to control configuration parameters of the Polygon view inside abstract IDocumentFinderViewController
getFinderViewController()
Use this object to control configuration parameters of the Finder view inside -
-
Method Detail
-
initCamera
abstract Unit initCamera(CameraUiSettings cameraUiSettings)
This must be called in the onCreate of the Activity
-
initDetectionBehavior
abstract Unit initDetectionBehavior(ContourDetector contourDetector, ContourDetectorFrameHandler.ResultHandler contourDetectorResultHandler, IDocumentScannerViewCallback callback)
This should be called as soon as you have an instance of the Contour detector. It is recommended to call it in onCreate of the Activity
-
getViewController
abstract IDocumentScannerViewController getViewController()
Use this object to control the state or the behavior of the IDocumentScannerView
-
getCameraConfiguration
abstract IDocumentScannerViewCameraConfiguration getCameraConfiguration()
Use this object to control configuration parameters of the Camera inside
-
getPolygonConfiguration
abstract IDocumentScannerPolygonViewController getPolygonConfiguration()
Use this object to control configuration parameters of the Polygon view inside
-
getFinderViewController
abstract IDocumentFinderViewController getFinderViewController()
Use this object to control configuration parameters of the Finder view inside
-
-
-
-