ALAbstractScanPlugin Class Reference

Inherits from NSObject
Conforms to ALCoreControllerDelegate
Declared in ALAbstractScanPlugin.h

  infoDelegates

@property (nonatomic, strong, readonly) NSHashTable<ALInfoDelegate> *infoDelegates

  pluginID

The pluginID is useful if there are multiple plugins running at the same time

@property (nullable, nonatomic, strong) NSString *pluginID

Declared In

ALAbstractScanPlugin.h

  imageProvider

The ImageProvider implementation takes care of getting new images in the SDK for processing

@property (nullable, nonatomic, assign) id<ALImageProvider> imageProvider

Declared In

ALAbstractScanPlugin.h

– start:error:

Start the scanning with an ImageProvider. Anyline will ask the ImageProvider for new frames until we get a result with high enough confidence.

- (BOOL)start:(id<ALImageProvider> _Nonnull)imageProvider error:(NSError *_Nullable *_Nullable)error

Parameters

imageProvider

The ImageProvider implementation

error

An error if something went wrong during startup

Return Value

Boolean indicating the success of the start

Declared In

ALAbstractScanPlugin.h

– stopAndReturnError:

Stops the scanning.

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

Parameters

error

An error if something went wrong during startup

Return Value

Boolean indicating the success of the start

Declared In

ALAbstractScanPlugin.h

– enableReporting:

Method to enable/disable the reporting functionality. Anyline reports anonymous scan data to there servers to improve and monitor scan quality. Depending on your license reporting is already disabled or can’t be disabled.

- (void)enableReporting:(BOOL)enable

Parameters

enable

Boolean if reporting should be on/off

Declared In

ALAbstractScanPlugin.h

– isRunning

The isRunning boolean indicates if a Anyline process is started.

- (BOOL)isRunning

Return Value

Boolean indicating if Anyline is running

Declared In

ALAbstractScanPlugin.h

– addInfoDelegate:

- (void)addInfoDelegate:(id<ALInfoDelegate> _Nonnull)infoDelegate

– removeInfoDelegate:

- (void)removeInfoDelegate:(id<ALInfoDelegate> _Nonnull)infoDelegate

  confidence

@property (nonatomic, assign) NSInteger confidence

  scanImage

@property (nullable, nonatomic, strong, readonly) ALImage *scanImage

  coreController

@property (nullable, nonatomic, strong) ALCoreController *coreController