Plugin Configuration

ALScanPlugin *scanPlugin = [[ALScanPlugin alloc] initWithJSONDictionary:configDict error:&error];

objcCopied!

ALPluginConfig *pluginConfig = [[ALPluginConfig alloc] initWithJSONDictionary:configDict error:&error];
// check error to see if you can safely proceed with the next operation
ALScanPlugin *scanPlugin = [[ALScanPlugin alloc] initWithConfig:pluginConfig];

objcCopied!

ALScanViewPluginConfig *scanViewPluginConfig = [[ALScanViewPluginConfig alloc] initWithJSONDictionary:configDictionary
                                                                                                error:&error];
ALScanViewPlugin *scanViewPlugin = [[ALScanViewPlugin alloc] initWithConfig:scanViewPluginConfig error:&error];

objcCopied!

ALScanViewPluginConfig *scanViewPluginConfig = [[ALScanViewPluginConfig alloc] initWithPluginConfig:pluginConfig
                                                                                       cutoutConfig:cutoutConfig
                                                                                 scanFeedbackConfig:scanFeedbackConfig
                                                                                              error:&error];
// check the error object and handle appropriately
ALScanViewPlugin *scanViewPlugin = [[ALScanViewPlugin alloc] initWithConfig:scanViewPluginConfig
                                                                      error:&error];
// check the error object and handle appropriately

objcCopied!

ALScanViewConfig *scanViewConfig = [[ALScanViewConfig alloc] initWithJSONDictionary:JSONDict error:&error];
ALScanView *scanView = [[ALScanView alloc] initWithFrame:frame
                                          scanViewPlugin:scanViewPlugin
                                          scanViewConfig:scanViewConfig
                                                   error:&error];

objcCopied!

ALScanViewConfig *scanViewConfig = [[ALScanViewConfig alloc] initWithCameraConfig:cameraConfig
                                                                      flashConfig:flashConfig];
ALScanView *scanView = [[ALScanView alloc] initWithFrame:frame
                                          scanViewPlugin:scanViewPlugin
                                          scanViewConfig:scanViewConfig
                                                   error:&error];

objcCopied!

[ALScanViewPluginConfig withPluginConfig:pluginConfig];

objcCopied!

[[ALScanViewPluginConfig alloc] initWithPluginConfig:pluginConfig error:&error];

objcCopied!

// get the JSON string for the aggregate config
NSString *JSONString = [self getJSONStringForFile:@"sample_id_config"];

// NOTE: implementation found elsewhere, simplified here
CGRect frame = [self getScanViewFrame];

NSError *error;
NSDictionary *configJSONDictionary = [JSONString toJSONObject:&error];
if (!configJSONDictionary) {
    // handle the error object
}

// takes "viewPluginConfig", which covers "pluginConfig", "cutoutConfig", and "scanFeedbackConfig"
ALScanViewPlugin *scanViewPlugin = [[ALScanViewPlugin alloc] initWithJSONDictionary:configJSONDictionary error:&error];
if (!scanViewPlugin) {
    if (error) {
        NSLog(@"there was an error: %@", error.localizedDescription);
    }
    return;
}

// get the scan plugin from the scan view plugin
ALScanPlugin *scanPlugin = scanViewPlugin.scanPlugin;
scanPlugin.delegate = self;

// takes "cameraConfig" and "flashConfig" from the configJSONDictionary
ALScanViewConfig *scanViewConfig = [[ALScanViewConfig alloc] initWithJSONDictionary:configJSONDictionary error:&error];

// take scanViewPlugin, and scanViewConfig
ALScanView *scanView = [[ALScanView alloc] initWithFrame:frame
                                          scanViewPlugin:scanViewPlugin
                                          scanViewConfig:scanViewConfig
                                                   error:&error];
if (!scanView) {
    // handle the error object
}

// Next steps
// - implement the ALScanPluginDelegate
// - install the scan view into the view hierarchy
// - start the scan view camera
// - start the scan view plugin

objcCopied!

- (void)setupScanView {
    // It is not shown here, but if an NSError is passed as a parameter make sure to
    // check it after each call and handle appropriately.
    NSError *error;

    // configure the scan plugin (Dial Meter)
    ALMeterConfig *meterConfig = [[ALMeterConfig alloc] init];
    meterConfig.scanMode = [ALMeterConfigScanMode dialMeter];

    ALPluginConfig *pluginConfig = [[ALPluginConfig alloc] init];
    pluginConfig.meterConfig = meterConfig;
    pluginConfig.identifier = @"Dial Meter";
    pluginConfig.cancelOnResult = @(YES);

    // create the cutout config
    NSString *JSONString = [[ALCutoutConfig defaultCutoutConfig] asJSONString];
    NSMutableDictionary *JSONDictionary = [NSMutableDictionary dictionaryWithDictionary:[JSONString asJSONObject]];

    // configure the cutout config using a memberwise initializer
    ALCutoutConfig *cutoutConfig = [[ALCutoutConfig alloc] initWithAlignment:ALCutoutAlignmentTopHalf
                                                                   animation:ALCutoutAnimationStyleNone
                                                               ratioFromSize:CGSizeMake(3, 1)
                                                                      offset:CGPointZero
                                                                       width:720
                                                            maxHeightPercent:100
                                                             maxWidthPercent:100
                                                                cornerRadius:4
                                                                 strokeWidth:2
                                                                 strokeColor:@"0099FF"
                                                         feedbackStrokeColor:@"0099FF"
                                                                  outerColor:@"30000000"
                                                                  cropOffset:CGPointZero
                                                                 cropPadding:CGSizeZero
                                                                       image:nil];

    // create the scan feedback config using a JSON dictionary: when a value for a property is not set
    // some default will be used.
    JSONString = [[ALScanFeedbackConfig defaultScanFeedbackConfig] asJSONString];
    JSONDictionary = [NSMutableDictionary dictionaryWithDictionary:[JSONString asJSONObject]];
    JSONDictionary[@"beepOnResult"] = @(YES);
    JSONDictionary[@"vibrateOnResult"] = @(YES);
    ALScanFeedbackConfig *scanFeedbackConfig = [ALScanFeedbackConfig withJSONDictionary:JSONDictionary];

    // assemble and create the scan view plugin config
    ALScanViewPluginConfig *scanViewPluginConfig = [[ALScanViewPluginConfig alloc] initWithPluginConfig:pluginConfig
                                                                                           cutoutConfig:cutoutConfig
                                                                                     scanFeedbackConfig:scanFeedbackConfig
                                                                                                  error:&error];

    // Create the scan view plugin
    self.scanViewPlugin = [[ALScanViewPlugin alloc] initWithConfig:scanViewPluginConfig error:&error];

    // Note that you don't need to instantiate an ALScanPlugin yourself --
    // the ScanViewPlugin already creates this, and you simply access its scanPlugin property.
    self.scanViewPlugin.scanPlugin.delegate = self;

    // create the camera config: no customization was done, so was left as it is
    ALCameraConfig *cameraConfig = [ALCameraConfig defaultCameraConfig];

    // configure and create the flash config
    JSONString = [[ALFlashConfig defaultFlashConfig] asJSONString];
    JSONDictionary = [NSMutableDictionary dictionaryWithDictionary:[JSONString asJSONObject]];
    JSONDictionary[@"alignment"] = @"bottom_right";
    ALFlashConfig *flashConfig = [ALFlashConfig withJSONDictionary:JSONDictionary];

    // note that you can pass null to either config here and the config defaults would be used.
    ALScanViewConfig *scanViewConfig = [[ALScanViewConfig alloc] initWithCameraConfig:cameraConfig
                                                                          flashConfig:flashConfig];

    self.scanView = [[ALScanView alloc] initWithFrame:CGRectZero
                                       scanViewPlugin:scanViewPlugin
                                       scanViewConfig:scanViewConfig
                                                error:&error];

    // Next Steps:
    // - install the scan view into the view hierarchy
    // - implement ALScanPluginDelegate for this view controller
    // - start the scan view camera
    // - start the scan view plugin
}

objcCopied!

self.scanViewPlugin.scanPlugin.pluginConfig.meterConfig.scanMode = ALMeterConfigScanMode.dialMeter;

objcCopied!

+ (ALScanViewPluginConfig *)defaultScanViewPluginConfig {
// here we use a JSON-based config as a starting point. We will be introducing changes to it later.
    NSString *configStr = [self.class defaultJSONConfigStr];
    return [[ALScanViewPluginConfig alloc] initWithJSONDictionary:[configStr asJSONObject] error:nil];
}

+ (ALScanViewConfig *)defaultScanViewConfig {
    NSString *configStr = [self.class defaultJSONConfigStr];
    return [[ALScanViewConfig alloc] initWithJSONDictionary:[configStr asJSONObject] error:nil];
}

+ (ALScanViewPlugin *)scanViewPluginWithMeterScanMode:(ALMeterConfigScanMode *)scanMode {
    // all config properties that can change during runtime are confined within this method.
    // In this case, we want to have a scan view plugin created for a different meter scan mode than
    // the one currently running, based on for instance, the selection of the user.
    // The result is an ALScanViewPlugin that can be given to a new or existing ALScanView to
    // effect the scan mode change.
    ALScanViewPluginConfig *scanViewPluginConfig = [self.class defaultScanViewPluginConfig];
    ALMeterConfig *meterConfig = scanViewPluginConfig.pluginConfig.meterConfig;

    meterConfig.scanMode = scanMode;

    NSError *error;
    ALScanViewPlugin *ret = [[ALScanViewPlugin alloc] initWithConfig:scanViewPluginConfig error:&error];

    // check and handle any errors
    return ret;
}

- (void)loadScanViewWithMeterScanMode:(ALMeterConfigScanMode *)newScanMode {
ALScanViewPlugin *newScanViewPlugin = [self.class scanViewPluginWithMeterScanMode:newScanMode];
    NSError *error;
    [self.scanView setScanViewPlugin:newScanViewPlugin error:&error];
    // handle the error, if non-null
}

objcCopied!