Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Android

TextRecognitionSettings Class Reference

Public Member Functions

 TextRecognitionSettings ()
 
 TextRecognitionSettings (Pattern regex)
 
void setProperty (String key, Object value)
 
 TextRecognitionSettings (JSONObject json) throws JSONParseException
 
TextRecognitionSettings clone ()
 

Public Attributes

RectF areaPortrait
 
RectF areaLandscape
 
Pattern regex
 
CharacterSet characterWhitelist
 

Detailed Description

Holds settings related to text recognition.

Constructor & Destructor Documentation

Construct new default text recognition settings.

The recognition settings object has the regular expression set to null. You must explicitly initialize it in order for text recognition to work.

TextRecognitionSettings ( Pattern  regex)

Construct new default text recognition settings.

Parameters
regexThe regular expression to use
TextRecognitionSettings ( JSONObject  json) throws JSONParseException

Parse the text recognition settings from a JSON object.

Parameters
jsonThe json object
Exceptions
JSONParseExceptionin case the JSON object is invalid.

Member Function Documentation

void setProperty ( String  key,
Object  value 
)

Sets a property.

This function is for internal use only and any functionality that can be accessed through it can and will vanish without public notice from one version to the next. Do not call this function unless you specifically have to.

Parameters
keyThe property's name.
valueThe property's value.
Returns
A deep copy of the text recognition settings.

Member Data Documentation

RectF 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. areaLandscape is used when scanning in landscape orientation.

Since
5.1
RectF 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. areaPortrait is used when scanning in portrait orientation.

Since
5.1
Pattern 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.

Since
5.1
CharacterSet 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.

Since
5.2.0

The documentation for this class was generated from the following file:
  • TextRecognitionSettings.java