Infinity Plugin API Reference

const 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: 'anyline_assets',
};

const response = await infinityPlugin.requestSdkInitialization(request);

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

import {
  AnylineInfinityPlugin,
  ExportedScanResultImageFormat,
} from 'anyline-ocr-react-native-module/AnylineInfinityPlugin';

// Subscribe to scan results before starting the scan
const subscription = infinityPlugin.onScanResults((result) => {
  const scanResult = result.exportedScanResults?.[0];
  console.log('Scan result:', scanResult?.pluginResult);
});

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

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

// requestScanStart resolves when the scan session ends
const response = await infinityPlugin.requestScanStart(request);
console.log('Scan session ended:', response.status);

// Clean up subscription when done
subscription.remove();

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

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

import { WrapperSessionScanResultCleanStrategyConfig } from 'anyline-ocr-react-native-module/AnylineInfinityPlugin';
import * as FileSystem from 'expo-file-system';

const resultPath = FileSystem.documentDirectory
  .replace(/^file:\/\//, '')
  .replace(/\/$/, '') + '/results/';

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

infinityPlugin.requestScanSwitchWithScanViewConfigContentString(
  newScanViewConfigJson,
);

import {
  AnylineInfinityPlugin,
  WrapperSessionUcrReportResponseStatus,
} from 'anyline-ocr-react-native-module/AnylineInfinityPlugin';

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

const ucrResponse = await infinityPlugin.requestUCRReport(ucrRequest);

if (ucrResponse.status === WrapperSessionUcrReportResponseStatus.UcrReportSucceeded) {
  console.log('UCR submitted:', ucrResponse.succeedInfo?.message);
} else {
  console.log('UCR failed:', ucrResponse.failInfo?.lastError);
}

import {
  AnylineInfinityPlugin,
  WrapperSessionExportCachedEventsResponseStatus,
} from 'anyline-ocr-react-native-module/AnylineInfinityPlugin';

const exportResponse = await infinityPlugin.requestExportCachedEvents();

if (exportResponse.status === WrapperSessionExportCachedEventsResponseStatus.ExportSucceeded) {
  const filePath = exportResponse.succeedInfo?.exportedFile;
  console.log('Events exported to:', filePath);
} else {
  console.log('Export failed:', exportResponse.failInfo?.lastError);
}

// Get the plugin version (synchronous)
const pluginVersion = infinityPlugin.getPluginVersion();

// Get the native SDK version
const sdkVersion = await infinityPlugin.getSDKVersion();

const subscription = infinityPlugin.onScanResults((result) => {
  // Iterate over all results in this batch (may contain multiple when using composite scanning)
  for (const scanResult of result.exportedScanResults ?? []) {
    const pluginResult = scanResult.pluginResult;
    console.log('Plugin result:', pluginResult);

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

// Remove subscription when no longer needed
subscription.remove();

const subscription = infinityPlugin.onUIElementClicked(
  (element: UiFeedbackElementConfig) => {
    console.log('UI element tapped:', element.id);
  }
);

// Clean up when done
subscription.remove();