CameraConfig class

Constructors

CameraConfig()

Properties

accentColor ↔ Color?
The accent color of the interface, should be a hex RGB color string.
getter/setter pair
allowMultipleDocuments ↔ bool?
Global options. Whether to show the icon to enable "multi-document"mode".
getter/setter pair
cancelAndDeleteImagesButtonText ↔ String?
The text inside of the cancel alert button.
getter/setter pair
cancelButtonText ↔ String?
The text inside of the cancel button.
getter/setter pair
cancelConfirmationMessage ↔ String?
The text inside of the alert to confirm exiting the scanner.
getter/setter pair
cropPadding ↔ Dimensions
To add extra horizontal and / or vertical padding to the cropped image.
getter/setter pair
defaultColor ↔ DefaultColor?
What the default color conversion will be (grayscale, original, enhanced).
getter/setter pair
defaultCrop ↔ bool?
Whether the crop mode (auto edge detection) should be enabled by default.
getter/setter pair
defaultMultipleDocuments ↔ bool?
Whethe the "multi-document-mode" should be enabled by default.
getter/setter pair
deleteButtonText ↔ String?
The text inside of the delete button.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
iconDisabledColor ↔ Color?
The color of the menu icons when they are enabled, should be a hex RGB color string.
getter/setter pair
iconEnabledColor ↔ Color?
The color of the menu icons when they are enabled, should be a hex RGB color string.
getter/setter pair
imageColorEnhancedText ↔ String?
The text inside of the color selection alert dialog button named enhanced.
getter/setter pair
imageColorGrayscaleText ↔ String?
The text inside of the color selection alert dialog button named grayscale.
getter/setter pair
imageColorOriginalText ↔ String?
The text inside of the color selection alert dialog button named original.
getter/setter pair
imageLimit ↔ num?
To limit the amount of images that can be taken.
getter/setter pair
imageLimitReachedMessage ↔ String?
The message to display when the limit has reached.
getter/setter pair
imageMaxHeight ↔ num?
The max height of the result image.
getter/setter pair
imageMaxQuality ↔ num?
Set the quality (between 0-100) of the jpg encoder. Default is 100.
getter/setter pair
imageMaxWidth ↔ num?
The max width of the result image.
getter/setter pair
imageMovingMessage ↔ String?
The warning message when the camera preview has to much motion to be able to automatically take a photo.
getter/setter pair
imageMovingSensitivityAndroid ↔ num?
The threshold of how sensitive the motion detection is. (lower value is higher sensitivity, default 50)
getter/setter pair
imageMovingSensitivityiOS ↔ num?
The threshold sensitive the motion detection is. (lower value is higher sensitivity, default 200).
getter/setter pair
imageTooBrightMessage ↔ String?
iOS Options The warning message when the camera result is too bright.
getter/setter pair
imagetooDarkMessage ↔ String?
The warning message when the camera result is too dark.
getter/setter pair
isViewFinderEnabled ↔ bool?
Whether the camera has a view finder overlay (a helper grid so the user knows where the document should be), should be a Boolean.
getter/setter pair
model ↔ ModelOptions
If you would like to use a custom model for object detection. Model + labels file should be packaged in your bundle.
getter/setter pair
moveCloserMessage ↔ String?
The warning message when someone should move closer to a document.
getter/setter pair
orientationWarningMessage ↔ String?
getter/setter pair
outputFileName ↔ String?
The filename to be given to the image results.
getter/setter pair
overlayColor ↔ Color?
The overlay color (when using document detection), should be a hex RGB color string.
getter/setter pair
overlayColorAlpha ↔ num?
The amount of opacity for the overlay, should be a float.
getter/setter pair
previewDuration ↔ num?
The amount of seconds the preview should be visible for, should be a float.
getter/setter pair
primaryColor ↔ Color?
The primary color of the interface, should be a hex RGB color string.
getter/setter pair
retakeButtonText ↔ String?
The text inside of the retake button.
getter/setter pair
reviewIconColor ↔ Color?
The color of the menu icons of the screen where you can review/edit the images, should be a hex RGB color string.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shouldGoToReviewScreenWhenImageLimitReached ↔ bool?
Whether to go to the Review Screen once the image limit has been reached. (default false)
getter/setter pair
shutterButton ↔ ShutterButton
Whether to disable/hide the shutterbutton (only works if a model is supplied).
getter/setter pair
storagePath ↔ String?
Android Options Where to put the image results
getter/setter pair
storeImagesToCameraRol ↔ bool?
Whether the camera automatically saves the images to the camera roll (iOS) / gallery (Android). Default true.
getter/setter pair
success ↔ SuccessOptions
After capture, show a checkmark preview with this success message, instead of a preview of the image.
getter/setter pair
timer ↔ TimerOptions
If you would like to enable automatic capturing of images.
getter/setter pair
userCanChangeColorSetting ↔ bool?
Whether to hide or show the color changing button in the Review Screen. (default shown/true)
getter/setter pair
userCanCropManually ↔ bool?
Whether to hide or show the cropping button in the Review Screen. (default shown/true)
getter/setter pair
userCanRotateImage ↔ bool?
Whether to hide or show the rotate button in the Review Screen. (default shown/true)
getter/setter pair
warningBackgroundColor ↔ Color?
The color of the background of the warning message, should be a hex RGB color string.
getter/setter pair
warningTextColor ↔ Color?
The color of the text of the warning message, should be a hex RGB color string.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited