Scandit Class Reference

Classes
class	Barcode
class	BarcodePicker
class	MatrixScanSession
class	Point
class	Quadrilateral
class	RecognizedText
class	Rect
class	ScanOverlay
class	ScanSession
class	ScanSettings
class	SymbologySettings
class	TextRecognitionSettings

Detailed Description

Module for all functionality of the barcode recognition plugin.

---

Class Documentation

class Scandit::RecognizedText

Holds the text recognition result as identified in a frame.

Class Members
String	text	The identified text in the frame.
boolean	rejected	Whether this code is rejected or not. If beeping/vibration is enabled, the device will beep and vibrate whenever text has been recognized. Set this property to true to suppress beeping/vibration. Use this functionality if you want to perform additional checks on the recognized text that cannot be expressed through a regular expression.

class Scandit::TextRecognitionSettings

Settings related to to text recognition.

Class Members
Rect	areaPortrait	The area (in relative coordinates) in which text is to be recognized. While it's possible to set this area to the whole image, it is not recommended to do so for speed reasons. For best performance, set this to the smallest possible area. By default, the recognition area is set to 1/4 of the image height. This value is only used when scanning in portrait orientation.
Rect	areaLandscape	The area (in relative coordinates) in which text is to be recognized. While it's possible to set this area to the whole image, it is not recommended to do so for speed reasons. For best performance, set this to the smallest possible area. By default, the recognition area is set to 1/4 of the image height. This value is only used when scanning in landscape orientation.
String	regex	Regular expression for filtering the recognized characters. Text that does not match the regular expression is ignored. By default, the regex is set to null. You must explicitly initialize the regex in order for text recognition to work.
String	characterWhitelist	White list of recognizable characters. If the white list is non-null, a recognition result will never contain characters that are not contained in it. By default the white list is null and all characters will be recognized.