ALScanPlugin Class Reference

Inherits from	NSObject
Declared in	ALScanPlugin.h

Overview

Object which takes image frames and scans them with the configured plugin

`delegate`

The object to be notified when events of interest can be reported

@property (nonatomic, weak) id<ALScanPluginDelegate> delegate

Declared In

ALScanPlugin.h

`assetController`

An object providing access to the assets that the plugin runs on

@property (nonatomic, strong) ALAssetController *assetController

Declared In

ALScanPlugin.h

`scanPluginConfig`

Configuration object for the scan plugin

@property (nonatomic, strong, readonly) ALScanPluginConfig *scanPluginConfig

Declared In

ALScanPlugin.h

`pluginID`

The unique identifier string for the plugin

@property (nonatomic, readonly) NSString *pluginID

Declared In

ALScanPlugin.h

`isStarted`

Indicates whether or not the plugin has been started

@property (nonatomic, readonly) BOOL isStarted

Declared In

ALScanPlugin.h

`isRunning`

Indicates whether or not the plugin is running

@property (nonatomic, readonly) BOOL isRunning

Declared In

ALScanPlugin.h

`ROI`

The “region of interest” within the image frame where the plugin is to be told to look for objects to be scanned

@property (nonatomic, assign) CGRect ROI

Declared In

ALScanPlugin.h

`– initWithConfig:error:`

Initializes a scan plugin given a JSON config data object (which encodes the string form of the config). May lead to an error when config is invalid, if so the error param is filled

- (id _Nullable)initWithConfig:(ALScanPluginConfig *_Nonnull)scanPluginConfig error:(NSError *_Nullable *_Nullable)error

Parameters

`scanPluginConfig`	an `ALScanPluginConfig` config object
`error`	set with the error details if there’s an error encountered during initialization

Return Value

the ALScanPlugin object

Declared In

ALScanPlugin.h

`– initWithJSONDictionary:error:`

Initializes a scan plugin given a JSON config data object (which encodes the string form of the config)

- (id _Nullable)initWithJSONDictionary:(NSDictionary *_Nonnull)jsonConfig error:(NSError *_Nullable *_Nullable)error

Parameters

`jsonConfig`	Configuration data in JSON.
`error`	set with the error details if there’s an error encountered during initialization

Return Value

the ALScanPlugin object

Declared In

ALScanPlugin.h

`– start`

Starts the plugin

- (void)start

Declared In

ALScanPlugin.h

`– stop`

Stops the plugin

- (void)stop

Declared In

ALScanPlugin.h