DocumentScannerCamera class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- DocumentScannerCamera
Constructors
-
DocumentScannerCamera({Key? key, required DocumentCameraConfiguration configuration, dynamic onCameraPreviewStarted(bool isFlashAvailable)?, dynamic onHeavyOperationProcessing(bool)?, dynamic onFrameDetectionResult(DocumentDetectionResult detectionResult)?, Future<
void> onSnappedDocumentResult(ImageRef originalImage, ImageRef? documentImage, DocumentDetectionResult? detectionResult)?, dynamic onError(SBException error)?, DocumentScannerCameraController? controller}) -
const
Properties
- configuration → DocumentCameraConfiguration
-
The configuration of the camera and detection behavior.
final
- controller → DocumentScannerCameraController?
-
The controller to access camera methods.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onCameraPreviewStarted → dynamic Function(bool isFlashAvailable)?
-
Runs each time the camera preview is started. This differs for android and ios.
In android this function will be called after each successful snap while in ios only once.
As ios not stopping camera preview after the snap
final
- onError → dynamic Function(SBException error)?
-
The callback that will be called when there is any error.
final
- onFrameDetectionResult → dynamic Function(DocumentDetectionResult detectionResult)?
-
A detection result callback that is triggered when a document is detected in the camera preview.
The callback provides the document detection result, which includes the detection status and the polygon of the detected document (if any).
final
- onHeavyOperationProcessing → dynamic Function(bool)?
-
The callback that is triggered when camera plugin takes more time to execute (e.g. snap a document).
final
-
onSnappedDocumentResult
→ Future<
void> Function(ImageRef originalImage, ImageRef? documentImage, DocumentDetectionResult? detectionResult)? -
A document scanner result callback that is triggered when a document is snapped.
The callback provides the original image and, if detectDocumentAfterSnap is enabled, the cropped image of the detected document along with the document detection result.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< DocumentScannerCamera> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited