Skip to content

Installation

Requirements

Flutter

Android

The following tools should be installed:

The minimum API Level is 16 for the following Core types:

  • barcode
  • barcodemrz
  • bounds
  • doctype
  • full
  • mrz
  • ocrandmrz

The minimum API Level is 19 for the following Core types:

  • mrzrfid
  • barcodemrzrfid
  • ocrandmrzrfid
  • fullrfid

iOS

  • The following IDE should be installed: Xcode.
  • The minimum iOS version is 9.0.

Installation

Info

Document Reader SDK is available via pub.dev.

Add the API package

Add the lines below to your package's pubspec.yaml file:

dependencies:
  flutter_document_reader_api: ^5.5.0

Add the Core package

Add one of the Core types depending on the functionality that you wish and the license capabilities:

  • Add the lines below to your package's pubspec.yaml file to use the barcode library edition:
dependencies:
  flutter_document_reader_core_barcode: ^5.5.0
  • Add the lines below to your package's pubspec.yaml file to use the barcodemrz library edition:
dependencies:
  flutter_document_reader_core_barcodemrz: ^5.5.0
  • Add the lines below to your package's pubspec.yaml file to use the barcodemrzrfid library edition:
dependencies:
  flutter_document_reader_core_barcodemrzrfid: ^5.5.0
  • Add the lines below to your package's pubspec.yaml file to use the bounds library edition:
dependencies:
  flutter_document_reader_core_bounds: ^5.5.0
  • Add the lines below to your package's pubspec.yaml file to use the doctype library edition:
dependencies:
  flutter_document_reader_core_doctype: ^5.5.0
  • Add the lines below to your package's pubspec.yaml file to use the full library edition:
dependencies:
  flutter_document_reader_core_full: ^5.5.0
  • Add the lines below to your package's pubspec.yaml file to use the fullrfid library edition:
dependencies:
  flutter_document_reader_core_fullrfid: ^5.5.0
  • Add the lines below to your package's pubspec.yaml file to use the mrz library edition:
dependencies:
  flutter_document_reader_core_mrz: ^5.5.0
  • Add the lines below to your package's pubspec.yaml file to use the mrzrfid library edition:
dependencies:
  flutter_document_reader_core_mrzrfid: ^5.5.0
  • Add the lines below to your package's pubspec.yaml file to use the ocrandmrz library edition:
dependencies:
  flutter_document_reader_core_ocrandmrz: ^5.5.0
  • Add the lines below to your package's pubspec.yaml file to use the ocrandmrzrfid library edition:
dependencies:
  flutter_document_reader_core_ocrandmrzrfid: ^5.5.0

Install the packages

Run the following command:

$ flutter pub get

Import the SDK

In your Dart code, you can use:

import 'package:flutter_document_reader_api/document_reader.dart';
Back to top