Infinity Plugin API Reference

final request = WrapperSessionSdkInitializationRequest(
  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: 'flutter_assets/anyline_assets',
);

try {
  final response = await infinityPlugin.requestSdkInitialization(request);

  if (response.initialized == true) {
    print('SDK initialized: ${response.succeedInfo?.toJson()}');
  } else {
    print('SDK init failed: ${response.failInfo?.lastError}');
  }
} on PlatformException catch (e) {
  print('SDK initialization error: ${e.message}');
}

// Subscribe to scan results before starting the scan
final subscription = infinityPlugin.onScanResults.listen((result) {
  final scanResult = result.exportedScanResults?.first;
  print('Scan result: ${scanResult?.pluginResult?.toJson()}');
});

// Specify image format and delivery method for scan results
final scanResultConfig = WrapperSessionScanResultConfig(
  imageContainer: ExportedScanResultImageContainer(
    encoded: ExportedScanResultImageContainerEncoded(),
  ),
  imageParameters: ExportedScanResultImageParameters(
    format: ExportedScanResultImageFormat.PNG,
    quality: 50,
  ),
);

// scanViewConfigJson is a JSON string containing your ScanViewConfig
final request = WrapperSessionScanStartRequest(
  scanViewConfigContentString: scanViewConfigJson,
  scanResultConfig: scanResultConfig,
);

// requestScanStart completes when the scan session ends
try {
  final response = await infinityPlugin.requestScanStart(request);
  print('Scan session ended: ${response.status}');
} on PlatformException catch (e) {
  print('Scan start error: ${e.message}');
}

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

// Or stop with an optional reason (surfaces in abortInfo.message on the scan response)
final stopRequest = WrapperSessionScanStopRequest(
  message: 'Scan stopped: no result within timeout',
);
await infinityPlugin.requestScanStop(stopRequest);

import 'package:path_provider/path_provider.dart';

final appDir = await getApplicationDocumentsDirectory();
final resultPath = '${appDir.path}/results/';

// newScanViewConfigJson: a JSON string containing the replacement ScanViewConfig
final switchRequest = WrapperSessionScanStartRequest(
  scanViewConfigContentString: newScanViewConfigJson,
  scanResultConfig: WrapperSessionScanResultConfig(
    cleanStrategy: WrapperSessionScanResultCleanStrategyConfig
        .CLEAN_FOLDER_ON_START_SCANNING,
    imageContainer: ExportedScanResultImageContainer(
      saved: ExportedScanResultImageContainerSaved(
        path: resultPath,
      ),
    ),
    imageParameters: ExportedScanResultImageParameters(
      quality: 50,
      format: ExportedScanResultImageFormat.PNG,
    ),
  ),
  scanViewInitializationParameters: ScanViewInitializationParameters(
    correlationId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  ),
);
await infinityPlugin.requestScanSwitchWithScanStartRequestParams(switchRequest);

await infinityPlugin.requestScanSwitchWithScanViewConfigContentString(
  newScanViewConfigJson,
);

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

try {
  final ucrResponse = await infinityPlugin.requestUCRReport(ucrRequest);

  if (ucrResponse.status == WrapperSessionUcrReportResponseStatus.UCR_REPORT_SUCCEEDED) {
    print('UCR submitted: ${ucrResponse.succeedInfo?.message}');
  } else {
    print('UCR failed: ${ucrResponse.failInfo?.lastError}');
  }
} on PlatformException catch (e) {
  print('UCR report error: ${e.message}');
}

try {
  final exportResponse = await infinityPlugin.requestExportCachedEvents();

  if (exportResponse.status == WrapperSessionExportCachedEventsResponseStatus.EXPORT_SUCCEEDED) {
    final filePath = exportResponse.succeedInfo?.exportedFile;
    print('Events exported to: $filePath');
  } else {
    print('Export failed: ${exportResponse.failInfo?.lastError}');
  }
} on PlatformException catch (e) {
  print('Event export error: ${e.message}');
}

// Get the plugin version (from pubspec.yaml)
final pluginVersion = await infinityPlugin.getPluginVersion();

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

// Call dispose when the plugin instance is no longer needed
infinityPlugin.dispose();

final subscription = infinityPlugin.onScanResults.listen((result) {
  // Iterate over all results in this batch (may contain multiple when using composite scanning)
  for (final scanResult in result.exportedScanResults ?? []) {
    final pluginResult = scanResult.pluginResult;
    print('Plugin result: ${pluginResult?.toJson()}');

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

// Cancel when no longer needed
subscription.cancel();

infinityPlugin.onUIElementClicked.listen((UiFeedbackElementConfig element) {
  print('UI element tapped: ${element.id}');
});