Developers
Mobile SDK Document

Native IOS SDK

Xamarin Android SDK

Xamarin IOS SDK

Flutter Android SDK

Flutter IOS SDK

React Native Android SDK

React Native IOS SDK

Web SDK

Web SDK Document

Developers
Native Android SDK

Text Scanner

Below you can find description of a basic Text capture scenario with user interface components.

1. Prerequisites

Pod installation

1. pod ‘ScanflowCore’

2. pod ‘ScanflowText’

We must install these two pod files to integrate Barcode module.

Camera Permission

Add the below camera permission to your info.plist file

Key : Privacy - Camera Usage Description
Value : $(PRODUCT_NAME) camera use

2. Import Modules:

1. Import ScanflowCore

2. Import ScanflowText

We must import those modules in code to access our barcode feature

3. Creating the instance object

private lazy var ScanFlowManager = (previewView: previewView,
scannerType: scannerType, overCropNeed: overCropNeed, overlayApperance: overlayApperance,
leftTopArc: UIColor, leftDownArc: UIColor, rightTopArc: UIColor, rightDownArc: UIColor,
needLocationAccess: Bool?)

This is ScanflowBarCodeManager initializer function that create instance for ScanflowBarCodeManager Class

Do this inside your view controller class

Parameters

  1. PreviewView - need to pass UIView that present in our view controller, that we want to be act as camera view
  2. ScannerType - Need to pass a scanner type that available in our SDK like “QR Code” or ”barcode” or ‘text’
  3. OverCropNeeded - if cropped image is needed inside an overlay, we need to give true else need to give false
  4. OverlayApperance – we can be able to give rectangle overlay, square overlay or none. cropping will work on that given overlay shape
  5. leftTopArc - colour for left top arc of overlay
  6. leftDownArc - colour for left down arc of overlay
  7. rightTopArc - colour for right top arc of overlay
  8. rightDownArc - colour for right down arc of overlay
  9. needLocationAccess - for accessing location

4. Start Session

ScanFlowManager.startSession()
This is the function used to start session Call this function in view controller viewDidLoad()

5. Assigning delegate to self

ScanFlowManager.delegate = self
Call this function in view controller viewDidLoad()

It asks to implement delegate functions in your view controller, so that you can able to communicate with our SDK

6. ScanflowCameraManager Delegate and its functions

Present Camera Permission Denied Alert

it would give alert if you denied camera permission, because it must need for our sdk

Present Video Configuration Alert

it would give alert if configuration of camera it is not supported, or any error occurred in camera configuration

Session Run Time Error Occured

It will trigger when session run time error occurred

session Was Interrupted (canResumeManually resumeManually: Bool)

This function called when camera session interrupted, and it gives resumeManually Boolean variable.so that we can again start camera session

Session Interuption Ended

This function called when camera session interruption ended

ShowAlert (title: String?, message: String)

This function called when camera sdk wants to show any message to user

The message title and content will be passed as params in this function. Better users use this function for log purposes

captured Output(result: String, codeType: String, , results: [String]?, location: CLLocation)

This function is main output function of our SDK

it will give detected code in result variable

It will give detected code type in codeType variable

It will give detected codes in results array in case of multiple detection

captured (originalframe: CVPixelBuffer, overlayFrame: CGRect, croppedImage: UIImage)

This function is another output function of our SDK, here we can check the images captured from camera and what image will be sent to the detection as a input

it will give originalframe that is captured image in cvpixelbuffer format

It will give overlayFrame is the frame to be used for cropping the image

It will give croppedImage in UIImage format, for this you need to give crop needed option in initialize function

Get Started with Text Capture:

1. Installing NuGet Package:

  1. Package > Right Click > Manage NuGet Packages > Browse > Scanflow.TextCapture.Xamarin.iOS
  2. We must install these NuGet Package to integrate Barcode module.
  3. Download the latest version 1.2.1

2. Adding Camera & Location Permissions

Key : Privacy – Camera Usage Description
Value : $(PRODUCT_NAME) camera use
  1. To acquire data on the current condition of the library, your application needs a Camera Permission for Scanflow AI Scanner. So, confirm you have given app privacy camera usage description in your info.plist
Key : Privacy – Location When In Use Usage Description
Value : $(PRODUCT_NAME) location use
  1. To access the location of the scan. your application needs a Location Permission for Scanflow AI Scanner. So, confirm you have given app privacy Location When In Use Usage Description in your info.plist

3. Add a Namespace

Using Scanflow.TextCapture.Xamarin.iOS;

Add this namespace to your controller and then start creating an instance of object.

4. Create an instance of object

ScanflowTextManager ScanFlowManager = ScanflowTextManager (UIView previewView, string scannerMode, string overlayApperance, bool overCropNeed, UIColor leftTopArc, UIColor leftDownArc, UIColor rightTopArc, UIColor rightDownArc, bool locationNeed)
  1. This is ScanflowTextManager initializer function that create instance for ScanflowTextManager Class. Do this inside your view controller class.

Parameters

  1. previewView - need to pass UIView that present in our view controller, that we want to be act as camera view
  2. scannerMode - Need to pass a scanner mode that available in our SDK like ContainerHorizontal or ContainerVertical or Tire
    1. ScannerMode.ContainerHorizontal - For Horizontal Container
    2. ScannerMode.ContainerVertical - For Vertical Container
    3. ScannerMode.Tire - For Vertical Container
  3. overlayApperance – we can be able to give rectangle overlay, square overlay, or none. cropping will work on that given overlay shape. You can pass the overlayApperance based on the Scanner mode.
    1. OverlayApperance.ContainerHorizontal
    2. OverlayApperance. ContainerVertical
    3. overCropNeeded - if cropped image is needed inside an overlay, we need to give true else need to give false
    4. LeftTopArc - Color for the Left Top overlay Arc
    5. LeftDownArc - Color for the Left Down overlay Arc
    6. RightTopArc - Color for the Right Top overlay Arc
    7. RightDownArc - Color for the Right Down overlay Arc
    8. locationNeed – for accessing location
Example:
ScanflowTextManager ScanFlowManager = new ScanflowTextManager (this, ScannerMode.ContainerHorizontal, OverlayApperance.ContainerHorizontal, true, UIColor.Red, UIColor.Yellow, UIColor.White, UIColor.Purple, true)

5. Validate License

public void ValidateLicense(string authKey)

This is the function used to validate the license generated from Scanflow website. we must pass below params here

Parameters

1. authKey - need to pass an auth key that is generated from scanflow website here

scanflowBarCodeManager.ValidateLicense (authKey: "--------AuthKey---------")

Call this function in view controller ViewDidLoad()

6. Inherit the interface and its methods

Inherit the IScanflowCameraManagerDelegate in your View controller and it asks to implement the functions in your view controller.

PresentCameraPermissionDeniedAlert()

it would give alert if you denied camera permission, because it must need for our sdk

PresentVideoConfigurationAlert()

it would give alert if configuration of camera it is not supported, or any error occurred in camera configuration

SessionRunTimeErrorOccured()

It will trigger when session run time error occurred

SessionWasInterrupted (bool resumeManually)

This function called when camera session interrupted, and it gives resumeManually Boolean variable.so that we can again start camera session

ShowAlert(string title, string message)

This function called when camera sdk wants to show any message to user. The message title and content will be passed as params in this function. Better users use this function for log purposes

Captured(CVPixelBuffer originalframe, CGRect overlayFrame, UIImage croppedImage)

This function is another output function of our SDK, here we can check the images captured from camera and what image will be sent to the detection as a input.

it will give originalframe that is captured image in cvpixelbuffer format

It will giveoverlayFrameis the frame to be used for cropping the image

It will givecroppedImagein uiimage format, for this you need to give crop needed option in initialize function

CapturedOutput (string result, string codeType, string[] results, UIImage processedImage, CLLocation location)

This function is main output function of our SDK

it will give detected code in result variable

It will give detected codeype in  codeType variable

It will give detected codes in results array in case of multiple detection

It will give detected codes location in location variable.

7. Assigning delegate to controller

ScanFlowManager. WeakDelegate = this;

Call this function in view controller ViewDidLoad()

It asks to implement interface functions in your view controller, so that you can be able to communicate with our SDK

8. Start Session

ScanFlowManager.StartSession()

This is the function used to start session Call this function in view controller ViewDidLoad()

9. Capture the date

ScanFlowManager.StartCaptureData();

This is the method used to Capture the datas.

10. Stop Session

ScanFlowManager.StopSession();

This is the method used to Stop Session.

Text Scanner

Below you can find description of a basic Text capture scenario with user interface components.

1. Prerequisites

Follow these steps to include our Scanflow text dependency inside of your flutter app:

  1. Open your pubspec file and add scanflow_text under dependencies
    dependencies:
    flutter:
    sdk:flutter
    scanflow_text:<latest_version>
  2. In your terminal run the following command to load the dependency in your app ‘flutter pub get’

Runtime Permission

Ask the camera permission inside init() method:

Permission.camera.request().isGranted.then((value) => setState(() {
if (value) {
//permission granted
} else {
log("::Permisson Required::");
}
}));

Use this Barcode Capture widget

TextCapture(
licenseKey: licenseKey,
scanType: widget.textScanType.name,
textScanResultBackHandler: callbackHandler)

Customize Addon Features

These are some additional Addons for user customization. Users can be able to Change Beep Sound, Enable or Disable Vibration, Enable or Disable Play Beep Sound, Auto Zoom...

TextCapture(
{Key? key,
required this.licenseKey,
this.isBeepSound,
this.isContinueScan,
this.isVibrate,
this.scanType,
this.isAutoExposure,
this.flashLight,
this.isAutoZoom,
required this.textScanResultBackHandler})

Resister Barcode Result CallBack

classTextScanningextendsStatefulWidget {
const TextScanning({Key? key, required this.textScanType}) : super(key: key);
final TextScanType textScanType
@override
State<TextScanning> createState() => _TextScanningState();
}
class_TextScanningStateextends State<TextScanning>
implements TextScanResultCallback {
String?licenseKey = "";
@override
void didUpdateWidget( covariantTextScanning oldWidget) {
super.didUpdateWidget(oldWidget);
}
@override
void dispose () {
super..dispose();
@override
Widgetbuild (BuildContext context) {
TextScanResultCallbackHandler callbackHandler =
TextScanResultCallbackHandler();
// Register this widget as the callback
callbackHandler.registerCallback(this);
return.Scaffold(
backgroundColor: Colors.black,
appBar: AppBar(
title: Text(
widget.textScanType.name,
style: const TextStyle(fontWeight: FontWeight.bold),
),
),
body: Container(
color: Colors.black,
child:TextCapture(
licenseKey, licenseKey,
scanType: widget.textScanType.name,
textScanResultBackHandler: callbackHandler),
));
}
@override
voidonTextScanResultSuccess(TextScanResult textScanResult) {
}
@override
voidonTextScanResultFailure(String message) {
}
}

OnTextScanResultSuccess – return the result success class.

Text Scanner

Below you can find description of a basic Text capture scenario with user interface components.

1. Prerequisites

Follow these steps to include our Scanflow text dependency inside of your flutter app:

  1. Open your pubspec file and add scanflow_text under dependencies
    dependencies:
    flutter:
    sdk:flutter
    scanflow_text:<latest_version>
  2. In your terminal run the following command to load the dependency in your app ‘flutter pub get’

Runtime Permission

Ask the camera permission inside init() method:

Permission.camera.request().isGranted.then((value) => setState(() {
if (value) {
//permission granted
} else {
log("::Permisson Required::");
}
}));

Use this Barcode Capture widget

TextCapture(
licenseKey: licenseKey,
scanType: widget.textScanType.name,
textScanResultBackHandler: callbackHandler)

Customize Addon Features

These are some additional Addons for user customization. Users can be able to Change Beep Sound, Enable or Disable Vibration, Enable or Disable Play Beep Sound, Auto Zoom...

TextCapture(
{Key? key,
required this.licenseKey,
this.isBeepSound,
this.isContinueScan,
this.isVibrate,
this.scanType,
this.isAutoExposure,
this.flashLight,
this.isAutoZoom,
required this.textScanResultBackHandler})

Resister Barcode Result CallBack

classTextScanningextendsStatefulWidget {
const TextScanning({Key? key, required this.textScanType}) : super(key: key);
final TextScanType textScanType
@override
State<TextScanning> createState() => _TextScanningState();
}
class_TextScanningStateextends State<TextScanning>
implements TextScanResultCallback {
String?licenseKey = "";
@override
void didUpdateWidget( covariantTextScanning oldWidget) {
super.didUpdateWidget(oldWidget);
}
@override
void dispose () {
super..dispose();
@override
Widgetbuild (BuildContext context) {
TextScanResultCallbackHandler callbackHandler =
TextScanResultCallbackHandler();
// Register this widget as the callback
callbackHandler.registerCallback(this);
return.Scaffold(
backgroundColor: Colors.black,
appBar: AppBar(
title: Text(
widget.textScanType.name,
style: const TextStyle(fontWeight: FontWeight.bold),
),
),
body: Container(
color: Colors.black,
child:TextCapture(
licenseKey, licenseKey,
scanType: widget.textScanType.name,
textScanResultBackHandler: callbackHandler),
));
}
@override
voidonTextScanResultSuccess(TextScanResult textScanResult) {
}
@override
voidonTextScanResultFailure(String message) {
}
}

OnTextScanResultSuccess – return the result success class.

Text Scanner

Importing the Text component

import {DatacaptureText} from 'react-native-datacapture-Text';

Use the Text Component in your app

<DatacaptureText
LicenseKey={"YOUR SCANFLOW LICENSE KEY MUST BE ENTER HERE"}
isBeepSound={true} //enable or disable play beep sound
isScanType={“ANY}
isVibrartion={true} //enable or disable vibrate
isAutoFlashlight={true} //enable or disable auto flashlight mode
isAutoExposure={true}
isContinuousScan={true} //by default true for continuous scan
isAutoZoom={false} //enable or disable auto zoom mode
/>

Setup Text Scanner Configuration

The following props are explained in detail:

licenseKey (type: String):

The license key prop is a string value that represents the unique identifier or authorization code required to activate and authenticate the scanflow.

isScanType (type: predefined String)

The Text Scanner has six different features

Type Description
CONTAINER_VERTICAL It allows you to read vertical text from Containers. We have our own enhancement pipeline to read text from Containers will be performed
CONTAINER_HORIZONTAL It allows you to read horizontal text from Containers. We have our own enhancement pipeline to read text from Containers will be performed

Text Result Listener:

onScanResultSuccess returns the TextScanResult result object for Tyre and Container onScanResultFailure returns the Reason when Scanner failed to Scan

useEffect(() => {
eventEmitter.addListener('onBatchScanResult', onBatchScanResultSuccess);
eventEmitter.addListener('onOneOfManyCodeResult', onOneOfManyCodeResult);
eventEmitter.addListener(''onOneofManyCodeRemoved', onOneofManyCodeRemoved);
eventEmitter.addListener('onOneofManyCodeSelected', onOneofManyCodeSelected);
eventEmitter.addListener('onScanBarcodeDetection', onScanBarcodeDetection);
eventEmitter.addListener(''onScanResultFailure', onScanResultFailure);
eventEmitter.addListener('onScanResultSuccess', onScanResultSuccess);
return () => {
eventEmitter.removeAllListeners(''onBatchScanResult');
eventEmitter.removeAllListeners(''onOneOfManyCodeResult');
eventEmitter.removeAllListeners(''onOneofManyCodeRemoved');
eventEmitter.removeAllListeners('''onOneofManyCodeSelected');
eventEmitter.removeAllListeners(''onScanBarcodeDetection');
eventEmitter.removeAllListeners(''onScanResultFailure');
eventEmitter.removeAllListeners(''onScanResultSuccess');
};
});
function onBatchScanResultSuccess(data: any) {
}
function onOneOfManyCodeResult(data: any) {
}
function onOneofManyCodeRemoved(data: any) {
}
function onOneofManyCodeSelected(data: any) {
}
function onScanBarcodeDetection(data: any) {
}
function onScanResultFailure(data: any) {
}
function onScanResultSuccess(data: any) {
}

Text Scanner

Importing the Text component

import {DatacaptureText} from 'react-native-datacapture-Text';

Use the Text Component in your app

<DatacaptureText
LicenseKey={"YOUR SCANFLOW LICENSE KEY MUST BE ENTER HERE"}
isBeepSound={true} //enable or disable play beep sound
isScanType={“ANY}
isVibrartion={true} //enable or disable vibrate
isAutoFlashlight={true} //enable or disable auto flashlight mode
isAutoExposure={true}
isContinuousScan={true} //by default true for continuous scan
isAutoZoom={false} //enable or disable auto zoom mode
/>

Setup Text Scanner Configuration

The following props are explained in detail:

licenseKey (type: String):

The license key prop is a string value that represents the unique identifier or authorization code required to activate and authenticate the scanflow.

isScanType (type: predefined String)

The Text Scanner has six different features

Type Description
CONTAINER_VERTICAL It allows you to read vertical text from Containers. We have our own enhancement pipeline to read text from Containers will be performed
CONTAINER_HORIZONTAL It allows you to read horizontal text from Containers. We have our own enhancement pipeline to read text from Containers will be performed

Text Result Listener:

onScanResultSuccess returns the TextScanResult result object for Tyre and Container onScanResultFailure returns the Reason when Scanner failed to Scan

useEffect(() => {
eventEmitter.addListener('onBatchScanResult', onBatchScanResultSuccess);
eventEmitter.addListener('onOneOfManyCodeResult', onOneOfManyCodeResult);
eventEmitter.addListener(''onOneofManyCodeRemoved', onOneofManyCodeRemoved);
eventEmitter.addListener('onOneofManyCodeSelected', onOneofManyCodeSelected);
eventEmitter.addListener('onScanBarcodeDetection', onScanBarcodeDetection);
eventEmitter.addListener(''onScanResultFailure', onScanResultFailure);
eventEmitter.addListener('onScanResultSuccess', onScanResultSuccess);
return () => {
eventEmitter.removeAllListeners(''onBatchScanResult');
eventEmitter.removeAllListeners(''onOneOfManyCodeResult');
eventEmitter.removeAllListeners(''onOneofManyCodeRemoved');
eventEmitter.removeAllListeners('''onOneofManyCodeSelected');
eventEmitter.removeAllListeners(''onScanBarcodeDetection');
eventEmitter.removeAllListeners(''onScanResultFailure');
eventEmitter.removeAllListeners(''onScanResultSuccess');
};
});
function onBatchScanResultSuccess(data: any) {
}
function onOneOfManyCodeResult(data: any) {
}
function onOneofManyCodeRemoved(data: any) {
}
function onOneofManyCodeSelected(data: any) {
}
function onScanBarcodeDetection(data: any) {
}
function onScanResultFailure(data: any) {
}
function onScanResultSuccess(data: any) {
}
Download SDK