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 iOS
Inherits NSObject, and <NSCopying>.
Instance Methods | |
| (nullable instancetype) | - initWithDictionary:error: |
Properties | |
| NSRegularExpression * | regex |
| CGRect | areaLandscape |
| CGRect | areaPortrait |
| SBSCharacterSet * | characterWhitelist |
Detailed Description
Contains settings to control the text recognition engine.
Method Documentation
◆ initWithDictionary:error:
| - (nullable instancetype) initWithDictionary: | (nonnull NSDictionary< NSString *, id > *) | dict | |
| error: | (NSError *_Nullable *_Nullable) | error | |
Property Documentation
◆ regex
|
readwritenonatomicstrong |
Regular expression for filtering the recognized characters. Text that does not match the regular expression is ignored.
By default, the regex is set to nil. You must explicitly initialize the regex in order for text recognition to work.
- Since
- 5.1
◆ areaLandscape
|
readwritenonatomicassign |
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
◆ areaPortrait
|
readwritenonatomicassign |
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/5 of the image height.
This value is only used when scanning in portrait orientation.
- Since
- 5.1
◆ characterWhitelist
|
readwritenonatomicstrong |
White list of recognizable characters. If the white list is non-nil, a recognition result will never contain characters that are not contained in it.
By default the white list is nil and all characters will be recognized.
- Since
- 5.2.0
The documentation for this class was generated from the following file: