Skip to main content

Flutter License Plate Scanner SDK - Introduction

Introduction

The Scanbot SDK provides the ability to scan car license plates and parse data fields. Scanning is currently limited to common EU license plates (country code on blue background on the left side).

The MRZ scanner is available as an RTU-UI component (types of components are explained here).

Take a look at our Example Apps to see how to integrate the MRZ Scanner.

EU License Plate Scanner RTU-UI Component

ScanbotSdkUi.startLicensePlateScanner(config)

Opens scanner that extracts country code and the license plate number from the European car license plate.

alt

var config = LicensePlateScannerConfiguration(
topBarBackgroundColor: Colors.pink,
topBarButtonsColor: Colors.white70,
cameraOverlayColor: Colors.black.withAlpha(150),
confirmationDialogAccentColor: Colors.green);
var result = await ScanbotSdkUi.startLicensePlateScanner(config);
  • result.operationResult

    • SUCCESS if License Plate data was detected
    • CANCELED if the user canceled the operation (tapped on the "cancel" button)
    • ERROR if an error occurred
  • result.countryCode - country code of the license plate

  • result.licensePlate - number on the license plate

  • result.rawText - raw value detected on the license plate

  • result.confidence - confidence of the recognition

LicensePlateScannerConfiguration

  /// The preferred camera module (default - BACK)
CameraModule? cameraModule;

/// Background color outside of the finder window.
Color? cameraOverlayColor;

/// Title of the cancel button.
String? cancelButtonTitle;

/// Whether the cancel button is hidden or not. iOS only.
bool? cancelButtonHidden;

/// The style of the confirmation dialog. iOS Only.
DialogStyle? confirmationDialogStyle;

/// The style of the confirmation dialogs confirm button. iOS Only.
DialogButtonStyle? confirmationDialogConfirmButtonStyle;

/// The style of the confirmation dialogs retry button. iOS Only.
DialogButtonStyle? confirmationDialogRetryButtonStyle;

/// Title of the button that opens the screen where the user can allow the usage of the camera by the app.
String? enableCameraButtonTitle;

/// Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
String? enableCameraExplanationText;

/// Foreground color of the detection overlay.
Color? finderLineColor;

/// Width of finder frame border. Default is 2.
double? finderLineWidth;

/// User guidance text below the finder view
String? finderTextHint;

/// Foreground color of the description label.
Color? finderTextHintColor;

/// The preferred height of the view finder. Defaults to 150.0. iOS only.
double? finderPreferredHeight;

/// Controls whether the flash toggle button is hidden or not. iOS only.
bool? flashButtonHidden;

/// Title of the flash toggle button. iOS only.
String? flashButtonTitle;

/// Controls whether the flash should be initially enabled. The default value is FALSE.
bool? flashEnabled;

/// UI Interface orientation lock mode
OrientationLockMode? orientationLockMode;

/// The background color of the top toolbar.
Color? topBarBackgroundColor;

/// The color of all active toggle buttons in the toolbar.
Color? topBarButtonsActiveColor;

/// The color of all inactive toggle buttons in the toolbar.
Color? topBarButtonsInactiveColor;

/// Minimum number of accumulated frames that have equal result
int? minNumberOfRequiredFramesWithEqualRecognitionResult;

/// Maximum number of accumulated frames to inspect before actual result is returned
int? maximumNumberOfAccumulatedFrames;

/// Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
bool? useButtonsAllCaps;

/// Threshold used to pause the detection after significant movement occurred. -1 is default value. Default = 0 for textFilterStrategy='DOCUMENT' and 1000 for textFilterStrategy='LCD_DOT_MATRIX_DISPLAY'. Android only.
int? significantShakeDelay;

/// Detector mode, classic (OCR based) or ML (machine learning based) approach.
LicensePlateScanStrategy? scanStrategy;

/// The title of the confirmation dialog.
String? confirmationDialogTitle;

/// The message text of the confirmation dialog.
String? confirmationDialogMessage;

/// The title of the confirmation dialog retry button.
String? confirmationDialogConfirmButtonTitle;

/// The title of the confirmation dialog confirm button.
String? confirmationDialogRetryButtonTitle;

/// The accent color of buttons on a confirmation dialog. Android only.
Color? confirmationDialogAccentColor;

/// Allows to set if the confirm button should be filled. Defaults to TRUE. Android only.
bool? confirmationDialogConfirmButtonFilled;

/// Allows to set a text color of the filled button. See `confirmationDialogConfirmButtonFilled`. Android only.
Color? confirmationDialogConfirmButtonFilledTextColor;

/// If `true`, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
bool? replaceCancelButtonWithIcon;

/// Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
CameraPreviewMode? cameraPreviewMode;

/// Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
bool? touchToFocusEnabled;

Want to scan longer than one minute?

Generate your free "no-strings-attached" Trial License and properly test the Scanbot SDK.

Get your free Trial License

What do you think of this documentation?