MRZScannerConfig

MRZScannerConfig is the class that defines the configurations for MRZ scanning. It is set via the MRZScannerViewController.

Definition

Assembly: DynamsoftMRZScanner.xcframework

• Objective-C
• Swift

1. @interface DSMRZScannerConfig : NSObject
   

2. class MRZScannerConfig : NSObject
   

Properties

The following property is deprecated:

license

Sets or returns the license string.

• Objective-C
• Swift

1. @property(nonatomic, assign) NSString* license;
   

2. var license: String { get set }
   

templateFile

Sets or returns the template with a file path or a JSON string.

• Objective-C
• Swift

1. @property(nonatomic, assign) NSString* templateFile;
   

2. var templateFile: String { get set }
   

documentType

Sets or returns the document type to scan, such as ID cards or passports.

• Objective-C
• Swift

1. @property(nonatomic, assign) DSDocumentType documentType;
   

2. var documentType: DocumentType { get set }
   

isTorchButtonVisible

Sets or returns the visibility of the torch button. Users can click the torch button to turn on/off the torch.

• Objective-C
• Swift

1. @property(nonatomic, assign) BOOL isTorchButtonVisible;
   

2. var isTorchButtonVisible: Bool { get set }
   

isBeepEnabled

Sets or returns whether the beep sound is enabled when a MRZ is scanned.

• Objective-C
• Swift

1. @property(nonatomic, assign) BOOL isBeepEnabled;
   

2. var isBeepEnabled: Bool { get set }
   

isVibrateEnabled

Sets or returns whether the vibration is enabled when a MRZ is scanned.

• Objective-C
• Swift

1. @property(nonatomic, assign) BOOL isVibrateEnabled;
   

2. var isVibrateEnabled: Bool { get set }
   

isCloseButtonVisible

Sets or returns the visibility of the close button.

• Objective-C
• Swift

1. @property(nonatomic, assign) BOOL isCloseButtonVisible;
   

2. var isCloseButtonVisible: Bool { get set }
   

isGuideFrameVisible

Sets or returns the visibility of the guide frame on the display.

• Objective-C
• Swift

1. @property(nonatomic, assign) BOOL isGuideFrameVisible;
   

2. var isGuideFrameVisible: Bool { get set }
   

templateFilePath

Sets or returns the local file path for the JSON parameters template file.

• Objective-C
• Swift

1. @property(nonatomic, assign) NSString* templateFilePath;
   

2. var templateFilePath: String { get set }