Skip to content

Installation

How to install Document Reader SDK.

Overview

graph LR
  A(Document Reader SDK) --> B(API);
  A --> C(Core);
  B --> D(Common);
  A -.- E[(Database)];

Document Reader SDK consists of two frameworks: API and Core.

API framework provides the external interface for controlling the process and getting the result. It depens on the Common framework that is an interface for working with the camera and other modules that are used in other Regula SDKs.

Core framework provides the recognition functionality where all the processing happens. This is the internal framework, it is used by the API framework only and is not accessible for developers. However, it should be referenced in the project.

Database contains the documents' data. It's mandatory to have it if you use the Core type that supports document type recognition.

Requirements

Installation

pub.dev

To always use the latest release, add the following to your pubspec.yaml:

pubspec.yaml
1
2
3
dependencies:
  flutter_document_reader_api: any
  flutter_document_reader_core_fullrfid: any

Alternatively, you can pin to a specific version (e.g. 1.0.0):

pubspec.yaml
1
2
3
dependencies:
  flutter_document_reader_api: ^1.0.0
  flutter_document_reader_core_fullrfid: ^1.0.0

And then run in Terminal the command below to install dependencies in your project:

flutter pub get

Now, you can import the SDK in your Dart code:

import 'package:flutter_document_reader_api/document_reader.dart';

Next Steps