ALScanView Class Reference

Inherits from UIView
Declared in ALScanView.h

  uiOverlayView

@property (nullable, nonatomic, strong) ALUIFeedback *uiOverlayView

  cameraConfig

@property (nonatomic, strong) ALCameraConfig *cameraConfig

  flashButtonConfig

@property (nonatomic, strong) ALFlashButtonConfig *flashButtonConfig

  flashButton

@property (nullable, nonatomic, strong) ALFlashButton *flashButton

  torchManager

@property (nullable, nonatomic, strong) ALTorchManager *torchManager

  captureDeviceManager

@property (nonatomic, strong) ALCaptureDeviceManager *captureDeviceManager

  scanViewPlugin

@property (nonatomic, strong) ALAbstractScanViewPlugin *scanViewPlugin

  watermarkRect

Returns the bounding Rect of the visible WatermarkView with the correct location on the Module View.

@property (nonatomic, readonly) CGRect watermarkRect

Discussion

Warning: May be nil before the layout process is completed or the license is not community.

Declared In

ALScanView.h

– initWithFrame:scanViewPlugin:

Constructor for ScanView

- (_Nullable instancetype)initWithFrame:(CGRect)frame scanViewPlugin:(ALAbstractScanViewPlugin *_Nullable)scanViewPlugin

Parameters

frame

The frame for the ScanView

scanViewPlugin

The ScanViewPlugin which you want to use for scanning (ID,Meter, Barcode, OCR or LicensePlate)

Return Value

An instance of a ScanView

Declared In

ALScanView.h

– initWithFrame:scanViewPlugin:cameraConfig:flashButtonConfig:

Constructor for ScanView

- (_Nullable instancetype)initWithFrame:(CGRect)frame scanViewPlugin:(ALAbstractScanViewPlugin *_Nullable)scanViewPlugin cameraConfig:(ALCameraConfig *_Nonnull)cameraConfig flashButtonConfig:(ALFlashButtonConfig *_Nonnull)flashButtonConfig

Parameters

frame

The frame for the ScanView

scanViewPlugin

The ScanViewPlugin which you want to use for scanning (ID,Meter, Barcode, OCR or LicensePlate)

cameraConfig

The CameraConfig for the ScanView

flashButtonConfig

The flashButtonCOnfig for the ScanView

Return Value

An instance of a ScanView

Declared In

ALScanView.h

+ scanViewForFrame:configPath:licenseKey:delegate:error:

Constructor to setup Anyline with a JSon Config.

+ (_Nullable instancetype)scanViewForFrame:(CGRect)frame configPath:(NSString *_Nonnull)configPath licenseKey:(NSString *_Nonnull)licenseKey delegate:(id _Nonnull)delegate error:(NSError *_Nullable *_Nullable)error

Parameters

frame

The frame for the ScanView

configPath

An absolute path to the Anyline json config file

licenseKey

The Anyline license key

delegate

The delegate which will be called when scanning (ALIDPluginDelegate, ALOCRScanPluginDelegate, ALMeterScanPluginDelegate, ALBarcodeScanPluginDelegate, ALDocumentScanPluginDelegate or ALLicensePlateScanPluginDelegate)

error

The error if something goes wrong during setup

Return Value

Boolean indicating the success of the setup

Declared In

ALScanView.h

+ scanViewForFrame:configDict:licenseKey:delegate:error:

Constructor to setup Anyline with a JSon Config.

+ (_Nullable instancetype)scanViewForFrame:(CGRect)frame configDict:(NSDictionary *_Nonnull)configDict licenseKey:(NSString *_Nonnull)licenseKey delegate:(id _Nonnull)delegate error:(NSError *_Nullable *_Nullable)error

Parameters

frame

The frame for the ScanView

configDict

A dictionary representing an Anyline json config

licenseKey

The Anyline license key

delegate

The delegate which will be called when scanning (ALIDPluginDelegate, ALOCRScanPluginDelegate, ALMeterScanPluginDelegate, ALBarcodeScanPluginDelegate, ALDocumentScanPluginDelegate or ALLicensePlateScanPluginDelegate)

error

The error if something goes wrong during setup

Return Value

Boolean indicating the success of the setup

Declared In

ALScanView.h

– startCamera

Starts the camera on an async thread

- (void)startCamera

Declared In

ALScanView.h

– stopCamera

Stops the camera

- (void)stopCamera

Declared In

ALScanView.h

– updateDispatchTimer

Methods for updating the UI

- (void)updateDispatchTimer

Declared In

ALScanView.h

– updateTextRect:

- (void)updateTextRect:(ALSquare *_Nonnull)square

– updateCutoutView:

- (void)updateCutoutView:(ALCutoutConfig *_Nonnull)cutoutConfig

– updateVisualFeedbackView:

- (void)updateVisualFeedbackView:(ALScanFeedbackConfig *_Nonnull)scanFeedbackConfig

– updateWebView:

- (void)updateWebView:(ALScanViewPluginConfig *_Nonnull)config