AnylineAbstractModuleView Class Reference

Inherits from UIView
Declared in AnylineAbstractModuleView.h

Overview

The AnylineAbstractModuleView is a programmatic interface for an object that manages easy access to Anylines scanning modes. It is a subclass of UIView. You should sublcass this class to build Anyline modules.

Overwrite startScanningAndReturnError: to add additional initilization before scanning begins.

Overwrite cancelScanningAndReturnError: to do additional clean-up after scanning ends.

Overwrite reportScanResultState: to check the various scanning states

  debugDelegate

@property (nullable, nonatomic, weak) id<AnylineDebugDelegate> debugDelegate

  cameraView

The video view which is responsible for video preview, frame extraction, …

@property (nullable, nonatomic, strong) ALScanView *cameraView

Declared In

AnylineAbstractModuleView.h

  captureDeviceManager

@property (nullable, nonatomic, strong, readonly) ALCaptureDeviceManager *captureDeviceManager

  cutoutView

@property (nullable, nonatomic, strong) ALCutoutView *cutoutView

  flashButton

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

  torchManager

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

  currentConfiguration

The UI Configuration for the scanning UI

@property (nullable, nonatomic, copy) ALUIConfiguration *currentConfiguration

Declared In

AnylineAbstractModuleView.h

  strokeWidth

Sets the width of the views border

@property (nonatomic) IBInspectable NSInteger strokeWidth

Declared In

AnylineAbstractModuleView.h

  strokeColor

Sets the color of the views border

@property (nullable, nonatomic, strong) IBInspectable UIColor *strokeColor

Declared In

AnylineAbstractModuleView.h

  cornerRadius

Sets the corner radius of the views border

@property (nonatomic) IBInspectable NSInteger cornerRadius

Declared In

AnylineAbstractModuleView.h

  outerColor

Sets the color of the space surrounding the view

@property (nullable, nonatomic, strong) IBInspectable UIColor *outerColor

Declared In

AnylineAbstractModuleView.h

  outerAlpha

Sets the alpha of the space surrounding the view

@property (nonatomic) IBInspectable CGFloat outerAlpha

Declared In

AnylineAbstractModuleView.h

  flashImage

Sets image the user uses to toggle the flash

@property (nullable, nonatomic, strong) IBInspectable UIImage *flashImage

Declared In

AnylineAbstractModuleView.h

  flashButtonAlignment

Sets the alignment of the flash button. Possible values are: ALFlashAlignmentTop, ALFlashAlignmentTopLeft, ALFlashAlignmentTopRight, ALFlashAlignmentBottomLeft, ALFlashAlignmentBottom and ALFlashAlignmentBottomRight

@property (nonatomic) ALFlashAlignment flashButtonAlignment

Declared In

AnylineAbstractModuleView.h

  flashButtonOffset

Property for the flash button offset.

@property (nonatomic) CGPoint flashButtonOffset

Declared In

AnylineAbstractModuleView.h

  flashStatus

Reads the status of the flash

@property (nonatomic) ALFlashStatus flashStatus

Declared In

AnylineAbstractModuleView.h

  cancelOnResult

This property tells Anyline if it should stop reading once a result was found

@property (nonatomic) IBInspectable BOOL cancelOnResult

Declared In

AnylineAbstractModuleView.h

  beepOnResult

This property tells Anyline if it should beep once a result was found

@property (nonatomic) IBInspectable BOOL beepOnResult

Declared In

AnylineAbstractModuleView.h

  blinkOnResult

This property tells Anyline if it should blink once a result was found

@property (nonatomic) IBInspectable BOOL blinkOnResult

Declared In

AnylineAbstractModuleView.h

  vibrateOnResult

This property tells Anyline if it should vibrate once a result was found

@property (nonatomic) IBInspectable BOOL vibrateOnResult

Declared In

AnylineAbstractModuleView.h

  cutoutRect

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

@property (nonatomic, readonly) CGRect cutoutRect

Discussion

Warning: May be nil before the layout process is completed.

Declared In

AnylineAbstractModuleView.h

  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

AnylineAbstractModuleView.h

– startScanningAndReturnError:

Starts the scanning process or sets the error object

- (BOOL)startScanningAndReturnError:(NSError *_Nullable *_Nullable)error

Parameters

error

The error that occured

Return Value

Boolean indicating if the scanning could be started

Declared In

AnylineAbstractModuleView.h

– cancelScanningAndReturnError:

Stops the scanning process or sets the error object

- (BOOL)cancelScanningAndReturnError:(NSError *_Nullable *_Nullable)error

Parameters

error

The error that occured

Return Value

Boolean indicating if the scanning could be stopped

Declared In

AnylineAbstractModuleView.h

– enableReporting:

Reporting ON Switch, off by default

- (void)enableReporting:(BOOL)enable

Parameters

enable

if YES, anyline will report for QA failed scan tries. Use reportImageForLog in ALC file, and use the reportScanResultState: for reporting

Declared In

AnylineAbstractModuleView.h

– isRunning

Boolean indicating if a scanning is in progress.

- (BOOL)isRunning

Return Value

Boolean indicating if a scanning is in progress.

Declared In

AnylineAbstractModuleView.h

– stopListeningForMotion

Stop listening for device motion.

- (void)stopListeningForMotion

Declared In

AnylineAbstractModuleView.h