Infinity Plugin API Reference

var request = {
  licenseKey: 'YOUR_LICENSE_KEY', // Replace with your Anyline License Key
  // Optional: only needed if your app bundles custom ML model files provided by Anyline.
  // The value depends on where these files are placed in your project. See the Developer Examples.
  assetPathPrefix: 'www/assets/anyline_assets',
};

anylineInfinity.requestSdkInitialization(
  request,
  function(response) {
    if (response.initialized) {
      console.log('SDK initialized:', response.succeedInfo);
    } else {
      console.error('SDK init failed:', response.failInfo.lastError);
    }
  },
  function(error) {
    console.error('SDK init error:', error);
  }
);

// Enums are available via window.AnylineEnums (merged by plugin.xml)
var ExportedScanResultImageFormat = AnylineEnums.ExportedScanResultImageFormat;

// Specify image format and delivery method for scan results
var scanResultConfig = {
  imageContainer: {
    encoded: {},
  },
  imageParameters: {
    format: ExportedScanResultImageFormat.Png,
    quality: 50,
  },
};

// scanViewConfigJson is a JSON string containing your ScanViewConfig
var request = {
  scanViewConfigContentString: scanViewConfigJson,
  scanResultConfig: scanResultConfig,
};

anylineInfinity.requestScanStart(
  request,
  function(response) {
    // Called once when the scan session ends
    console.log('Scan session ended:', response.status);
  },
  {
    onScanResults: function(result) {
      // Called 0..N times during scanning
      var scanResult = result.exportedScanResults && result.exportedScanResults[0];
      console.log('Scan result:', scanResult && scanResult.pluginResult);
    },
  }
);

// Stop with default behavior
anylineInfinity.requestScanStop();

// Or stop with an optional reason (surfaces in abortInfo.message on the scan response)
anylineInfinity.requestScanStop({ message: 'Scan stopped: no result within timeout' });

var baseDir = cordova.file.documentsDirectory || cordova.file.dataDirectory;
var resultPath = baseDir.replace(/^file:\/\//, '').replace(/\/$/, '') + '/results/';

// newScanViewConfigJson: a JSON string containing the replacement ScanViewConfig
var switchRequest = {
  scanViewConfigContentString: newScanViewConfigJson,
  scanResultConfig: {
    cleanStrategy: AnylineEnums.WrapperSessionScanResultCleanStrategyConfig.CleanFolderOnStartScanning,
    imageContainer: {
      saved: {
        path: resultPath,
      },
    },
    imageParameters: {
      quality: 50,
      format: 'png',
    },
  },
  scanViewInitializationParameters: {
    correlationId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  },
};
anylineInfinity.requestScanSwitchWithScanStartRequestParams(switchRequest);

anylineInfinity.requestScanSwitchWithScanViewConfigContentString(
  newScanViewConfigJson,
);

var UcrStatus = AnylineEnums.WrapperSessionUcrReportResponseStatus;

// pluginResult: obtained from the onScanResults event stream (see Scan Result Handling)
// userCorrectedValue: the value corrected by the user after reviewing the scan result
var ucrRequest = {
  blobKey: pluginResult.blobKey,
  correctedResult: userCorrectedValue,
};

anylineInfinity.requestUCRReport(
  ucrRequest,
  function(response) {
    if (response.status === UcrStatus.UcrReportSucceeded) {
      console.log('UCR submitted:', response.succeedInfo.message);
    }
  },
  function(err) {
    console.error('UCR failed:', err);
  }
);

var ExportStatus = AnylineEnums.WrapperSessionExportCachedEventsResponseStatus;

anylineInfinity.requestExportCachedEvents(
  function(response) {
    if (response.status === ExportStatus.ExportSucceeded) {
      var filePath = response.succeedInfo.exportedFile;
      console.log('Events exported to:', filePath);
    }
  },
  function(err) {
    console.error('Export failed:', err);
  }
);

// Get the plugin version
anylineInfinity.getPluginVersion(
  function(version) {
    console.log('Plugin version:', version);
  },
  function(error) {
    console.error(error);
  }
);

// Get the native SDK version
anylineInfinity.getSDKVersion(
  function(version) {
    console.log('SDK version:', version);
  },
  function(error) {
    console.error(error);
  }
);

anylineInfinity.requestScanStart(
  request,
  onScanResponse,
  {
    onScanResults: function(result) {
      // Iterate over all results in this batch (may contain multiple when using composite scanning)
      var scanResults = result.exportedScanResults || [];
      scanResults.forEach(function(scanResult) {
        var pluginResult = scanResult.pluginResult;
        console.log('Plugin result:', pluginResult);

        // Handle images based on delivery method
        var imageContainer = scanResult.imageContainer;
        if (imageContainer && imageContainer.saved) {
          var saved = imageContainer.saved;
          var basePath = saved.path || '';
          var fullFramePath = basePath + '/' + (saved.images && saved.images.image);
          var cutoutPath = basePath + '/' + (saved.images && saved.images.cutoutImage);
        } else if (imageContainer && imageContainer.encoded) {
          var encoded = imageContainer.encoded;
          // Decode from Base64 for display or upload
          var fullFrameBase64 = encoded.images && encoded.images.image;
          var cutoutBase64 = encoded.images && encoded.images.cutoutImage;
        }
      });
    },
  }
);

anylineInfinity.requestScanStart(
  scanRequest,
  function(response) { /* session ended */ },
  {
    onScanResults: function(results) { /* ... */ },
    onUIElementClicked: function(element) {
      console.log('UI element tapped:', element.id);
    },
  }
);