Sparkscan Net Ios

SparkScan .NET for iOS Skill

Critical: Do Not Trust Internal Knowledge

Your training data may contain outdated or incorrect Scandit SDK APIs. The SparkScan API changes between major SDK versions — button-visibility / color properties get renamed, removed, or restructured. The .NET binding also uses different naming conventions than the Swift / Obj-C native SDK (PascalCase, Enabled instead of isEnabled, TimeSpan instead of TimeInterval, etc.), and a few naming choices differ from the rest of the .NET API.

Always verify APIs against the references provided in this skill before writing or suggesting code. Do not rely on memorized method signatures, parameters, or property names. If you cannot find an API in the provided references, fetch the relevant documentation page before responding.

.NET-iOS-specific gotchas worth flagging:

• This skill targets the non-MAUI .NET for iOS workload (project <TargetFramework>net10.0-ios</TargetFramework>, no <UseMaui> flag). For MAUI apps, use the sparkscan-maui skill instead.
• `SparkScan` and `SparkScanSettings` use plain `new` constructors, not `Create(...)` factories. This is unusual compared to the rest of the .NET API (BarcodeCapture.Create(...), BarcodeCaptureSettings.Create(), DataCaptureView.Create(...)). The canonical pattern is var settings = new SparkScanSettings(); var sparkScan = new SparkScan(settings); — writing SparkScan.Create(...) or SparkScanSettings.Create() is a compile error. DataCaptureContext.ForLicenseKey(key) still uses the factory form (it lives in Core, not Spark).
• `SparkScanView.Create(parent, context, sparkScan, settings)` IS a factory (unlike SparkScan itself). On iOS the parent argument is just this.View — there is no coordinator-layout container (that's Android-only). The created view is added to parentView automatically; do not call this.View.AddSubview(sparkScanView) yourself.
• iOS lifecycle is sparkScanView.PrepareScanning() in ViewWillAppear and sparkScanView.StopScanning() in ViewWillDisappear. Do not use OnPause / OnResume here — those are the Android-only API. Calling them on iOS will not compile (the iOS binding does not surface them).
• Pick the `UIViewController` constructor that matches how the controller is instantiated, or the camera preview will never appear. The dotnet new ios template that ships with modern .NET-iOS is scene-based (no Main.storyboard, UIApplicationSceneManifest in Info.plist, SceneDelegate.WillConnect builds the window programmatically) — in that project shape, the VC must expose a parameterless public ViewController() : base() { } and SceneDelegate.WillConnect calls new ViewController(). Older Scandit samples are storyboard-based (UIMainStoryboardFile in Info.plist, customClass="ViewController" in the storyboard) — those need public ViewController(IntPtr handle) : base(handle) { } because storyboard inflation invokes that ctor with a real native handle. Never call `new ViewController(IntPtr.Zero)` to bridge the two: IntPtr.Zero is a null native handle, so the resulting managed wrapper has no underlying UIViewController; this.View never attaches to the window, SparkScanView.Create(parentView: this.View, …) lands on a detached view, and the app launches into a blank screen with no camera and no scans. See references/integration.md "Scene-based vs storyboard instantiation" for the full callout.
• NSCameraUsageDescription in Info.plist is mandatory. Without it the app crashes on first camera access. iOS shows the system permission dialog automatically when the camera starts — there is no separate runtime-request API for the camera.
• The .NET ISparkScanListener has only two methods: OnBarcodeScanned(SparkScan, SparkScanSession, IFrameData?) and OnSessionUpdated(SparkScan, SparkScanSession, IFrameData?). There are no `OnObservationStarted` / `OnObservationStopped` methods (the way IBarcodeCaptureListener has them).
• Prefer the event API (sparkScan.BarcodeScanned += handler) over the listener interface in idiomatic C# — that's what the official .NET iOS SparkScan sample uses. The event handler receives SparkScanEventArgs with Session, FrameData, and SparkScan.
• `IFrameData` and the image buffers must be `Dispose()`d on iOS. The official sample uses using var imageBuffer = args.FrameData?.ImageBuffers.LastOrDefault(); and using var frame = imageBuffer?.ToImage();. Failing to dispose causes a frozen / stuttering preview. The SparkScanEventArgs.FrameData itself is IFrameData?. If you do not need the frame, do not retain it.
• Symbology names are C# PascalCase: Symbology.Ean13Upca, Symbology.Ean8, Symbology.Code128, Symbology.InterleavedTwoOfFive, Symbology.Qr, Symbology.DataMatrix. They are not Swift dot-case (.ean13UPCA).
• The capture mode's enabled property is sparkScan.Enabled (not IsEnabled).
• CodeDuplicateFilter is TimeSpan — not TimeInterval (that is the Swift type). Use TimeSpan.FromMilliseconds(500), TimeSpan.FromSeconds(2.5), or TimeSpan.Zero. SparkScanSettings does not expose CodeDuplicate.DefaultDuplicateFilter / ReportDataAndSymbologyOnlyOnce sentinels — those live on BarcodeCaptureSettings, not on SparkScan. For SparkScan, set the TimeSpan directly.
• Feedback is delivered through ISparkScanFeedbackDelegate.GetFeedbackForBarcode(Barcode) and assigned with sparkScanView.Feedback = this (or any object that implements ISparkScanFeedbackDelegate). Returning null from the delegate falls back to the default success feedback.
• Success feedback: new SparkScanBarcodeSuccessFeedback() (default), or pass (Color), (Color, Brush), or (Color, Brush, Feedback?).
• Error feedback: new SparkScanBarcodeErrorFeedback(message: "...", resumeCapturingDelay: TimeSpan.FromSeconds(60)). The view shows the error message, the trigger button shows an error state, and scanning resumes after the delay.
• GetFeedbackForBarcode(Barcode) is invoked on a background thread. Build the feedback object eagerly (in SetupSparkScan / ViewDidLoad) and just return it.
• SparkScan.BarcodeScanned (and ISparkScanListener.OnBarcodeScanned) also run on a background thread. Dispatch any UI update via DispatchQueue.MainQueue.DispatchAsync(() => { … }).
• SDK 8.0+ requires explicit initialization in `AppDelegate.FinishedLaunching`. Call ScanditCaptureCore.Initialize() + ScanditBarcodeCapture.Initialize() before any Scandit code runs. Without this the SDK's DI container has no registrations and the first new SparkScan(...) / SparkScanView.Create(...) call crashes at launch. Not required on 6.x / 7.x. See references/integration.md for the canonical AppDelegate.cs template.
• The NuGet packages are Scandit.DataCapture.Core and Scandit.DataCapture.Barcode. No separate *.Maui packages here — those are only for MAUI projects. Do not guess the version from training data — fetch the latest stable from https://www.nuget.org/packages/Scandit.DataCapture.Barcode/ via WebFetch before pinning. Inventing a non-existent version (e.g. 8.13.0 when only 8.4.0 is published) causes dotnet restore to fail with Unable to find package Scandit.DataCapture.Core with version (>= …). See references/integration.md Step 0 for the full procedure.
• SparkScanView.HardwareTriggerSupported and SparkScanViewSettings.HardwareTriggerKeyCode are Android-only and not surfaced on dotnet.ios. Do not reference them in iOS code.
• SparkScanScanningModeDefault and SparkScanScanningModeTarget are constructed with new, both taking (SparkScanScanningBehavior, SparkScanPreviewBehavior). There is no parameterless constructor in the .NET binding; the Swift init() overloads (no args) are not surfaced on dotnet.ios.
• View state is exposed via SparkScanView.ViewStateChanged (event of EventHandler<SparkScanViewStateEventArgs>) — there is no UiListener property on the .NET binding. Use the events BarcodeCountButtonTapped, BarcodeFindButtonTapped, LabelCaptureButtonTapped, and ViewStateChanged instead.

Intent Routing

Based on the user's request, load the appropriate reference file before responding:

• Integrating SparkScan from scratch, configuring settings, customizing feedback, customizing the SparkScanView appearance, handling scans, doing async work after a scan, or displaying scanned barcodes in a list (e.g. "add SparkScan to my .NET iOS app", "set up barcode scanning in C#", "how do I use SparkScan in net-ios", "reject barcodes with error feedback", "hide the torch button", "show a custom toast on scan", "use target mode", "crop a thumbnail from the scanned frame", "show scanned barcodes in a list", "add a results table under the scanner", "build a UITableView of scans") → read references/integration.md and follow the instructions there (the list-building recipe lives in the "Build a results list (UITableView pattern)" subsection under Optional configuration).
• Migrating or upgrading an existing SparkScan integration (e.g. "upgrade from v6 to v7", "migrate my SparkScan", "bump the Scandit .NET SDK to v8", "what changed between SDK versions") → read references/migration.md and follow the instructions there.
• Replacing a third-party barcode scanner with SparkScan (e.g. "replace my ZXing.Net.Mobile scanner with SparkScan", "migrate from AVFoundation barcode scanning to Scandit", "switch from [library] to SparkScan") → read references/third-party-migration.md and follow the instructions there.

API Usage Policy

Only use APIs that are explicitly documented in the Scandit references below. Do not invent or guess method signatures, parameters, or property names. If unsure whether an API exists or how it is called — or if a compile error occurs — fetch the relevant reference page before responding. Do not tell the user to check the docs themselves. After answering, always include the relevant link so the user can explore further.

Never construct or guess documentation URLs. When you need a specific class or property's API page: 1. First check whether the page you already fetched contains a direct hyperlink to it — topic pages link directly to relevant API symbols. Always request links alongside content in your fetch prompt. 2. If no direct link was found, fetch the API index (see Full API reference in the table below), extract the actual link from it, and follow that.

URL structures can vary (e.g. api/ui/ subdirectory) and guessing will lead to 404s.

References

Direct users to the right resource based on their question:

API surface this skill covers

All classes documented with :available: dotnet.ios in the official RST docs (docs/source/barcode-capture/api/spark-scan*.rst and api/ui/spark-scan-*.rst) are addressed in references/integration.md:

• SparkScan — new SparkScan(), new SparkScan(SparkScanSettings), Enabled, ApplySettingsAsync(settings), AddListener(ISparkScanListener) / RemoveListener(ISparkScanListener), events BarcodeScanned / SessionUpdated (both EventHandler<SparkScanEventArgs>), SparkScanLicenseInfo, Dispose.
• SparkScanSettings — new SparkScanSettings(), new SparkScanSettings(CapturePreset), EnableSymbology, EnableSymbologies(ICollection<Symbology>), EnableSymbologies(CompositeType), GetSymbologySettings, EnabledSymbologies, EnabledCompositeTypes, CodeDuplicateFilter, BatterySaving, ScanIntention, SetProperty / GetProperty<T> / TryGetProperty<T>.
• SparkScanSession — NewlyRecognizedBarcode, FrameSequenceId, Reset().
• SparkScanEventArgs — SparkScan, Session, FrameData.
• ISparkScanListener — OnBarcodeScanned, OnSessionUpdated. (No OnObservation* callbacks.)
• SparkScanLicenseInfo — LicensedSymbologies.
• Feedback: SparkScanBarcodeFeedback (abstract), SparkScanBarcodeSuccessFeedback (4 constructors), SparkScanBarcodeErrorFeedback(message, resumeCapturingDelay, …) (4 constructors), ISparkScanFeedbackDelegate.GetFeedbackForBarcode(Barcode).
• SparkScanView — Create(parentView, context, sparkScan, settings), lifecycle PrepareScanning() / StopScanning(), control methods StartScanning() / PauseScanning() / ShowToast(string), button visibility properties (BarcodeCountButtonVisible, BarcodeFindButtonVisible, LabelCaptureButtonVisible, TargetModeButtonVisible, ScanningBehaviorButtonVisible, ZoomSwitchControlVisible, PreviewSizeControlVisible, CameraSwitchButtonVisible, TriggerButtonVisible, PreviewCloseControlVisible, TorchControlVisible), color / image customization (ToolbarBackgroundColor, ToolbarIconActiveTintColor, ToolbarIconInactiveTintColor, TriggerButtonCollapsedColor, TriggerButtonExpandedColor, TriggerButtonAnimationColor, TriggerButtonTintColor, TriggerButtonImage), Feedback (the ISparkScanFeedbackDelegate), static DefaultBrush, events BarcodeCountButtonTapped, BarcodeFindButtonTapped, LabelCaptureButtonTapped, ViewStateChanged.
• SparkScanViewSettings — TriggerButtonCollapseTimeout, DefaultScanningMode, DefaultTorchState, SoundEnabled, HapticEnabled, HoldToScanEnabled, HardwareTriggerEnabled, ZoomFactorOut, ZoomFactorIn, ToastSettings, VisualFeedbackEnabled, InactiveStateTimeout, DefaultCameraPosition, DefaultMiniPreviewSize, SmartSelectionCandidateBrush. (No HardwareTriggerKeyCode — Android-only.)
• SparkScanToastSettings — ToastEnabled, ToastBackgroundColor, ToastTextColor, plus message strings (TargetModeEnabledMessage, ContinuousModeEnabledMessage, ScanPausedMessage, ZoomedInMessage, TorchEnabledMessage, etc. — see integration.md for the full list).
• SparkScanViewState enum (Initial, Idle, Inactive, Active, Error), SparkScanViewEventArgs(View), SparkScanViewStateEventArgs(State).
• SparkScanMiniPreviewSize enum (Regular, Expanded).
• SparkScanPreviewBehavior enum (Default, Persistent), SparkScanScanningBehavior enum (Single, Continuous).
• ISparkScanScanningMode (: IDisposable), SparkScanScanningModeDefault(scanningBehavior, previewBehavior), SparkScanScanningModeTarget(scanningBehavior, previewBehavior).

SparkScan .NET for iOS Integration Guide

SparkScan is a pre-built scanning UI for high-volume single-scanning workflows. The SparkScanView overlays a draggable trigger button (and an optional mini preview) on top of any screen, so the user can scan without leaving their current workflow. Unlike BarcodeCapture, you do not wire up a Camera, DataCaptureView, or BarcodeCaptureOverlay yourself — SparkScan owns its own camera and preview.

Examples below use C# 12 and a UIViewController. The same APIs work in storyboards, XIBs, or programmatically-instantiated controllers — adapt ownership of DataCaptureContext, SparkScan, and SparkScanView to the project's existing structure.

Scene-based vs storyboard instantiation — match the constructor to the instantiation path. The dotnet new ios template that ships with modern .NET-iOS is scene-based: no Main.storyboard, no UIMainStoryboardFile in Info.plist, AppDelegate returns a UISceneConfiguration from GetConfiguration, and a SceneDelegate.WillConnect builds the window and sets Window.RootViewController programmatically. In that case the UIViewController must expose a parameterless constructor (public ViewController() : base() { }) and SceneDelegate.WillConnect calls new ViewController(). Do not call new ViewController(IntPtr.Zero) — the (IntPtr handle) constructor is a binding ctor used by storyboard / XIB inflation to wrap an existing native object. Calling it with IntPtr.Zero produces a managed wrapper with no native UIViewController underneath; the view never attaches to the window, SparkScanView.Create(parentView: this.View, …) ends up on a detached view, and the camera preview never appears. Symptom: the app launches but shows a blank screen, no camera, no scans. If the project is storyboard-based (older Scandit samples follow this pattern — UIMainStoryboardFile in Info.plist, customClass="ViewController" in Main.storyboard), keep the public ViewController(IntPtr handle) : base(handle) { } constructor instead, since storyboard inflation invokes that ctor with a real native handle.

MAUI? Stop. If the project file has <UseMaui>true</UseMaui>, switch to the sparkscan-maui skill. The MAUI integration uses <scandit:SparkScanView> in XAML and the UseScanditCore / UseScanditBarcode(c => c.AddSparkScanView()) builder, which are different.

Prerequisites

Step 0 — Fetch the latest SDK version from NuGet (mandatory, do this before any edits)

Before editing the .csproj, WebFetch https://www.nuget.org/packages/Scandit.DataCapture.Barcode/ and read the latest stable version number off the page (skip -beta.* / -preview.* / -rc.* suffixes). Use that exact version for both packages.

Do not guess, do not reuse a version from training data, and do not invent a number like 8.13.0 when only 8.4.0 is the latest stable — dotnet restore will fail with Unable to find package Scandit.DataCapture.Core with version (>= 8.13.0). The latest stable version changes regularly; only the live NuGet page is authoritative. If WebFetch fails, fall back to https://api.nuget.org/v3-flatcontainer/scandit.datacapture.barcode/index.json (last entry without a pre-release suffix) before proceeding.

Other prerequisites

• Scandit Data Capture SDK for .NET — add both packages to the .csproj, pinned to the version fetched in Step 0:

  <ItemGroup>
    <PackageReference Include="Scandit.DataCapture.Core" Version="<step-0-version>" />
    <PackageReference Include="Scandit.DataCapture.Barcode" Version="<step-0-version>" />
  </ItemGroup>

Both packages are published on NuGet.org. Do not add Scandit.DataCapture.Core.Maui or Scandit.DataCapture.Barcode.Maui — those are MAUI-only.

• `SupportedOSPlatformVersion` must be at least `15.0` in the .csproj (matches the MAUI / .NET iOS template default):

  <SupportedOSPlatformVersion>15.0</SupportedOSPlatformVersion>

• A valid Scandit license key:
• Sign in at https://ssl.scandit.com to generate one.
• No account yet? Sign up at https://ssl.scandit.com/dashboard/sign-up?p=test.
• Camera usage description in `Info.plist`:

  <key>NSCameraUsageDescription</key>
  <string>Used to scan barcodes.</string>

Without this key the app crashes on first camera access. iOS prompts the user for permission automatically the first time the camera is opened; there is no separate runtime-request API to call (the Scandit SDK triggers the standard system prompt when the camera starts).

• SDK initialization (Scandit 8.0+). Initialize the Scandit DI container in AppDelegate.FinishedLaunching before any Scandit type is constructed. Without this, the first new SparkScan(...) / SparkScanView.Create(...) call crashes because the container has no registrations.

  using Foundation;
  using Scandit.DataCapture.Barcode;
  using Scandit.DataCapture.Core;
  using UIKit;

  namespace MyApp;

  [Register("AppDelegate")]
  public class AppDelegate : UIResponder, IUIApplicationDelegate
  {
      [Export("window")]
      public UIWindow Window { get; set; } = null!;

      [Export("application:didFinishLaunchingWithOptions:")]
      public bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
      {
          ScanditCaptureCore.Initialize();
          ScanditBarcodeCapture.Initialize();
          return true;
      }
  }

If the project already has an AppDelegate, add the two Initialize() calls at the top of FinishedLaunching rather than creating a second delegate. This step is only required on Scandit SDK 8.0+ — earlier majors (6.x, 7.x) self-initialized, so for those versions skip this entirely.

Integration flow

Ask the user which barcode symbologies they need to scan. When asking, mention that it's important to only enable the symbologies they actually need, as enabling fewer improves scanning performance and accuracy.

Once the user responds, ask which UIViewController they'd like to integrate SparkScan into. Then write the integration code directly into that file. Do not just show the code in chat; apply it to the file.

After providing the code, show this setup checklist:

Setup checklist: 1. Add <PackageReference Include="Scandit.DataCapture.Barcode" Version="<step-0-version>" /> and <PackageReference Include="Scandit.DataCapture.Core" Version="<step-0-version>" /> to the .csproj (use the version pinned in Step 0 above — do not guess). 2. Ensure <SupportedOSPlatformVersion>15.0</SupportedOSPlatformVersion> is set in the .csproj. 3. Add NSCameraUsageDescription to Info.plist with a short user-facing description. 4. Add ScanditCaptureCore.Initialize() and ScanditBarcodeCapture.Initialize() to AppDelegate.FinishedLaunching (SDK 8.0+). 5. Replace -- ENTER YOUR SCANDIT LICENSE KEY HERE -- with your key from https://ssl.scandit.com.

Step 1 — Create the DataCaptureContext

The DataCaptureContext is the central hub of the SDK. Construct it once and reuse the same reference for the lifetime of the scanning surface.

using Scandit.DataCapture.Core.Capture;

private DataCaptureContext dataCaptureContext =
    DataCaptureContext.ForLicenseKey("-- ENTER YOUR SCANDIT LICENSE KEY HERE --");

Step 2 — Configure SparkScanSettings

Choose which barcode symbologies to scan. By default, all symbologies are disabled — enable each one explicitly. Only enable what you need; each extra symbology adds processing time.

SparkScanSettings is constructed with a plain new — there is no `SparkScanSettings.Create()` factory (unlike BarcodeCaptureSettings.Create()).

using Scandit.DataCapture.Barcode.Data;
using Scandit.DataCapture.Barcode.Spark.Capture;

SparkScanSettings settings = new SparkScanSettings();

HashSet<Symbology> symbologies = new()
{
    Symbology.Ean13Upca,
    Symbology.Ean8,
    Symbology.Upce,
    Symbology.Code39,
    Symbology.Code128,
    Symbology.InterleavedTwoOfFive,
};
settings.EnableSymbologies(symbologies);

// Optional: adjust active symbol counts for variable-length 1D symbologies.
settings.GetSymbologySettings(Symbology.Code39).ActiveSymbolCounts =
    new short[] { 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 };

SparkScanSettings members

Unlike BarcodeCaptureSettings, SparkScanSettings does not expose a LocationSelection property — SparkScan controls scan location through its own SparkScanScanningModeDefault / SparkScanScanningModeTarget modes (see Step 7).

Step 3 — Create the SparkScan mode

this.sparkScan = new SparkScan(settings);

Or, with defaults:

this.sparkScan = new SparkScan();

Note: SparkScan is not auto-attached to a DataCaptureContext from the constructor — the context is associated implicitly through SparkScanView.Create(...) in Step 5. Constructing new SparkScan() is enough to start configuring it.

SparkScan members

Use either `AddListener` or the events — not both for the same handler. The official .NET iOS SparkScan sample uses the events.

Step 4 — Configure SparkScanViewSettings (optional)

SparkScanViewSettings controls UI behavior of the SparkScan view: hold-to-scan, default torch state, scanning mode, mini preview behavior, toast text, and more. All fields have sensible defaults — only set what you need to change.

using Scandit.DataCapture.Barcode.Spark.UI;
using Scandit.DataCapture.Core.Source;

SparkScanViewSettings viewSettings = new SparkScanViewSettings();

// Examples:
viewSettings.SoundEnabled = false;                                       // Mute success beep
viewSettings.HapticEnabled = true;                                       // Vibrate on success (default true)
viewSettings.TriggerButtonCollapseTimeout = TimeSpan.FromSeconds(-1);    // Don't auto-collapse the trigger
viewSettings.InactiveStateTimeout = TimeSpan.FromSeconds(15);            // Time before scanning becomes inactive
viewSettings.DefaultMiniPreviewSize = SparkScanMiniPreviewSize.Regular;  // or Expanded
viewSettings.DefaultCameraPosition = CameraPosition.WorldFacing;         // default; UserFacing for selfie camera

SparkScanViewSettings members

HardwareTriggerKeyCode is not surfaced on dotnet.ios — it is an Android-only property in the .NET binding. Referencing it in iOS code will not compile.

Step 4b — Toast text (SparkScanToastSettings)

The mini preview shows a toast banner for several state transitions; SparkScan provides default English text. To override:

viewSettings.ToastSettings = new SparkScanToastSettings
{
    ToastEnabled = true,
    ToastBackgroundColor = Color.FromArgb(204, 18, 22, 25),
    ToastTextColor = Color.White,
    TargetModeEnabledMessage = "Target mode on",
    TargetModeDisabledMessage = "Target mode off",
    ContinuousModeEnabledMessage = "Continuous mode",
    ContinuousModeDisabledMessage = "Single-scan mode",
    ScanPausedMessage = "Scanning paused",
    ZoomedInMessage = "Zoomed in",
    ZoomedOutMessage = "Zoomed out",
    TorchEnabledMessage = "Torch on",
    TorchDisabledMessage = "Torch off",
    UserFacingCameraEnabledMessage = "Front camera",
    WorldFacingCameraEnabledMessage = "Back camera",
};

Set ToastEnabled = false to suppress all toasts. Individual message strings default to null — when null, the SDK falls back to its built-in text.

Step 5 — Create the SparkScanView

SparkScanView.Create(parentView, context, sparkScan, settings) creates the view and adds it to `parentView` automatically. The parent is just the view controller's View — there is no coordinator-layout container on iOS (that's Android-only).

using Scandit.DataCapture.Barcode.Spark.UI;
using UIKit;

if (this.View == null)
{
    throw new InvalidOperationException("Cannot initialize view");
}

this.sparkScanView = SparkScanView.Create(
    parentView: this.View,
    context: this.dataCaptureContext,
    sparkScan: this.sparkScan,
    settings: viewSettings);

Do not call this.View.AddSubview(this.sparkScanView) — the factory has already done it.

SparkScanView members (iOS)

OnPause / OnResume and HardwareTriggerSupported are Android-only. They are not surfaced on dotnet.ios — referencing them in an iOS source file will not compile.

Step 6 — Handle scans

The official .NET iOS SparkScan sample uses the event API. The handler receives SparkScanEventArgs with Session (containing NewlyRecognizedBarcode), FrameData, and SparkScan.

using CoreFoundation;
using Scandit.DataCapture.Barcode.Data;
using Scandit.DataCapture.Barcode.Spark.Capture;

// In ViewDidLoad / setup, after creating sparkScan:
this.sparkScan.BarcodeScanned += this.BarcodeScanned;

private void BarcodeScanned(object? sender, SparkScanEventArgs args)
{
    var barcode = args.Session.NewlyRecognizedBarcode;
    if (barcode == null) return;

    // Optional: pull a thumbnail out of the frame data. Always wrap in `using` so the
    // image buffer is released — otherwise the preview will freeze.
    using var imageBuffer = args.FrameData?.ImageBuffers.LastOrDefault();
    using var frame = imageBuffer?.ToImage();
    var location = barcode.GetBarcodeLocation(frame);
    var thumbnail = frame?.CropImage(
        (int)location.X, (int)location.Y, (int)location.Width, (int)location.Height);

    // BarcodeScanned runs on a background thread — dispatch UI work.
    DispatchQueue.MainQueue.DispatchAsync(() =>
    {
        var description = new SymbologyDescription(barcode.Symbology).ReadableName;
        // update list / database / UI here
    });
}

If you only need the barcode itself (no frame data), the body collapses to:

private void BarcodeScanned(object? sender, SparkScanEventArgs args)
{
    var barcode = args.Session.NewlyRecognizedBarcode;
    if (barcode == null) return;
    DispatchQueue.MainQueue.DispatchAsync(() => { /* update UI */ });
}

If you prefer the listener interface, implement ISparkScanListener directly on the view controller:

public partial class ViewController : UIViewController, ISparkScanListener
{
    public void OnBarcodeScanned(SparkScan sparkScan, SparkScanSession session, IFrameData? frameData)
    {
        var barcode = session.NewlyRecognizedBarcode;
        if (barcode == null) return;
        DispatchQueue.MainQueue.DispatchAsync(() => /* update UI */);
        // If you accessed frameData, dispose any image buffers you used.
    }

    public void OnSessionUpdated(SparkScan sparkScan, SparkScanSession session, IFrameData? frameData) { }
}

// In ViewDidLoad:
this.sparkScan.AddListener(this);

Heads-up: ISparkScanListener has only two methods — OnBarcodeScanned and OnSessionUpdated. There are no OnObservationStarted / OnObservationStopped callbacks (unlike IBarcodeCaptureListener).

SparkScanSession members

SparkScanEventArgs

Step 7 — Customize feedback (optional)

Implement ISparkScanFeedbackDelegate to return per-barcode feedback (success or error). Assign it to sparkScanView.Feedback. The delegate is called on a background thread — build the feedback objects once and return them, don't dispatch to the UI thread inside the delegate.

using Scandit.DataCapture.Barcode.Spark.Feedback;

public partial class ViewController : UIViewController, ISparkScanFeedbackDelegate
{
    private SparkScanBarcodeSuccessFeedback successFeedback = null!;
    private SparkScanBarcodeErrorFeedback errorFeedback = null!;

    private void SetupSparkScanFeedback()
    {
        this.successFeedback = new SparkScanBarcodeSuccessFeedback();
        this.errorFeedback = new SparkScanBarcodeErrorFeedback(
            message: "Wrong barcode",
            resumeCapturingDelay: TimeSpan.FromSeconds(60));

        this.sparkScanView.Feedback = this;
    }

    SparkScanBarcodeFeedback ISparkScanFeedbackDelegate.GetFeedbackForBarcode(Barcode barcode)
    {
        return IsBarcodeValid(barcode) ? this.successFeedback : this.errorFeedback;
    }

    private static bool IsBarcodeValid(Barcode barcode) => barcode.Data != "123456789";
}

Feedback classes

SparkScanBarcodeFeedback is an abstract base; the two concrete types are:

Returning null from GetFeedbackForBarcode falls back to the default success feedback. The Feedback parameter is Scandit.DataCapture.Core.Common.Feedback.Feedback (the same type used by BarcodeCaptureFeedback).

Step 8 — Lifecycle management

Forward the view controller's ViewWillAppear / ViewWillDisappear calls into PrepareScanning() / StopScanning(). Both calls are required — without them, the camera and preview won't behave correctly across navigation transitions.

public override void ViewWillAppear(bool animated)
{
    base.ViewWillAppear(animated);
    this.sparkScanView.PrepareScanning();
}

public override void ViewWillDisappear(bool animated)
{
    base.ViewWillDisappear(animated);
    this.sparkScanView.StopScanning();
}

SparkScanView handles the camera switching internally — you don't need to call Camera.GetDefaultCamera() / SwitchToDesiredStateAsync(...) yourself, and you do not call OnPause / OnResume (those are Android-only and not surfaced on dotnet.ios).

iOS automatically shows the system camera permission dialog the first time the camera starts. There is no separate runtime-request API to call.

Complete minimal example

using CoreFoundation;
using Foundation;
using UIKit;

using Scandit.DataCapture.Barcode.Data;
using Scandit.DataCapture.Barcode.Spark.Capture;
using Scandit.DataCapture.Barcode.Spark.Feedback;
using Scandit.DataCapture.Barcode.Spark.UI;
using Scandit.DataCapture.Core.Capture;

namespace MyApp;

public partial class ViewController : UIViewController, ISparkScanFeedbackDelegate
{
    public const string SCANDIT_LICENSE_KEY = "-- ENTER YOUR SCANDIT LICENSE KEY HERE --";

    private DataCaptureContext dataCaptureContext = null!;
    private SparkScan sparkScan = null!;
    private SparkScanView sparkScanView = null!;

    private SparkScanBarcodeSuccessFeedback successFeedback = null!;
    private SparkScanBarcodeErrorFeedback errorFeedback = null!;

    // Parameterless ctor for scene-based / programmatic instantiation
    // (the `dotnet new ios` default). If the project is storyboard-based
    // (Info.plist has `UIMainStoryboardFile`), replace this with
    // `public ViewController(IntPtr handle) : base(handle) { }` so storyboard
    // inflation can pass the native handle. Do not call `new ViewController(IntPtr.Zero)`
    // from SceneDelegate — it produces a managed wrapper with no native object
    // and the camera preview will never appear.
    public ViewController() : base() { }

    public override void ViewDidLoad()
    {
        base.ViewDidLoad();
        this.SetupSparkScan();
    }

    public override void ViewWillAppear(bool animated)
    {
        base.ViewWillAppear(animated);
        this.sparkScanView.PrepareScanning();
    }

    public override void ViewWillDisappear(bool animated)
    {
        base.ViewWillDisappear(animated);
        this.sparkScanView.StopScanning();
    }

    private void SetupSparkScan()
    {
        this.dataCaptureContext = DataCaptureContext.ForLicenseKey(SCANDIT_LICENSE_KEY);

        SparkScanSettings settings = new();
        HashSet<Symbology> symbologies = new()
        {
            Symbology.Ean13Upca,
            Symbology.Ean8,
            Symbology.Upce,
            Symbology.Code39,
            Symbology.Code128,
            Symbology.InterleavedTwoOfFive,
        };
        settings.EnableSymbologies(symbologies);

        this.sparkScan = new SparkScan(settings);
        this.sparkScan.BarcodeScanned += this.BarcodeScanned;

        SparkScanViewSettings viewSettings = new();

        if (this.View == null)
        {
            throw new InvalidOperationException("Cannot initialize view");
        }

        this.sparkScanView = SparkScanView.Create(
            parentView: this.View,
            context: this.dataCaptureContext,
            sparkScan: this.sparkScan,
            settings: viewSettings);

        this.SetupSparkScanFeedback();
    }

    private void SetupSparkScanFeedback()
    {
        this.successFeedback = new SparkScanBarcodeSuccessFeedback();
        this.errorFeedback = new SparkScanBarcodeErrorFeedback(
            message: "Wrong barcode",
            resumeCapturingDelay: TimeSpan.FromSeconds(60));

        this.sparkScanView.Feedback = this;
    }

    private void BarcodeScanned(object? sender, SparkScanEventArgs args)
    {
        var barcode = args.Session.NewlyRecognizedBarcode;
        if (barcode == null) return;

        // Optional thumbnail extraction — always wrap in `using` for proper disposal.
        using var imageBuffer = args.FrameData?.ImageBuffers.LastOrDefault();
        using var frame = imageBuffer?.ToImage();
        var location = barcode.GetBarcodeLocation(frame);
        var thumbnail = frame?.CropImage(
            (int)location.X, (int)location.Y, (int)location.Width, (int)location.Height);

        DispatchQueue.MainQueue.DispatchAsync(() =>
        {
            // Update UI on the main thread.
        });
    }

    SparkScanBarcodeFeedback ISparkScanFeedbackDelegate.GetFeedbackForBarcode(Barcode barcode) =>
        IsBarcodeValid(barcode) ? this.successFeedback : this.errorFeedback;

    private static bool IsBarcodeValid(Barcode barcode) => barcode.Data != "123456789";
}

Optional configuration

Build a results list (UITableView pattern)

The minimal Step 6 handler just receives the scan — it doesn't display anything. The official .NET iOS ListBuildingSample displays scans in a UITableView floating beneath the SparkScanView overlay. This subsection is the complete recipe; drop it in if your UI needs to show the scanned barcodes.

No extra NuGet packages are needed — UITableView, UITableViewSource, and UITableViewCell all ship with UIKit.

Z-order matters. Add the table view to this.View before calling SparkScanView.Create(parentView: this.View, …). Subviews added later sit on top, and SparkScanView must float on top of the table to remain interactive (the draggable trigger button, toolbar, and mini preview have to overlay your content, not sit underneath it). The official sample's ViewDidLoad orders calls as SetupHeaderView → SetupTableView → SetupClearView → SetupSparkScan for exactly this reason — SparkScanView is created last.

1. `Models/ListItem.cs` — the row data:

using Scandit.DataCapture.Barcode.Data;

namespace MyApp.Models;

public class ListItem(int number, Symbology symbology, string? data)
{
    public int Number { get; } = number;
    public string Symbology { get; } = new SymbologyDescription(symbology).ReadableName;
    public string Data { get; } = data ?? string.Empty;
}

2. `Models/ListItemManager.cs` — thread-safe singleton with a change event:

namespace MyApp.Models;

public class ListItemManager
{
    private static readonly Lazy<ListItemManager> instance =
        new(() => new ListItemManager(), LazyThreadSafetyMode.PublicationOnly);

    public static ListItemManager Instance => instance.Value;

    private readonly List<ListItem> items = new();

    public event EventHandler? ListsChanged;

    public IEnumerable<ListItem> Inventory => this.items;
    public int TotalItemsCount => this.items.Count;

    public void AddItem(ListItem item)
    {
        this.items.Add(item);
        this.ListsChanged?.Invoke(this, EventArgs.Empty);
    }

    public void Clear()
    {
        this.items.Clear();
        this.ListsChanged?.Invoke(this, EventArgs.Empty);
    }

    private ListItemManager() { }
}

3. `Views/ItemTableViewCell.cs` — a minimal two-label cell:

using Foundation;
using MyApp.Models;
using UIKit;

namespace MyApp.Views;

public class ItemTableViewCell : UITableViewCell
{
    public static readonly NSString Key = new("ItemTableViewCell");

    private UILabel title = null!;
    private UILabel subtitle = null!;

    // `RegisterClassForCellReuse` + `DequeueReusableCell` instantiate cells via this
    // `(IntPtr handle)` ctor with a real native handle. This is the same storyboard-inflation
    // path described in the "Scene-based vs storyboard instantiation" callout above —
    // do NOT call this ctor manually with `IntPtr.Zero`; UIKit's cell pool owns construction.
    public ItemTableViewCell(IntPtr handle) : base(handle) { }

    public void Configure(ListItem item)
    {
        if (this.title == null) this.CreateLabels();
        this.title.Text = $"Item {item.Number}";
        this.subtitle.Text = $"{item.Symbology}: {item.Data}";
    }

    private void CreateLabels()
    {
        this.title = new UILabel
        {
            TranslatesAutoresizingMaskIntoConstraints = false,
            Font = UIFont.BoldSystemFontOfSize(16),
        };
        this.subtitle = new UILabel
        {
            TranslatesAutoresizingMaskIntoConstraints = false,
            Font = UIFont.SystemFontOfSize(14),
            TextColor = UIColor.Gray,
        };
        this.ContentView.AddSubview(this.title);
        this.ContentView.AddSubview(this.subtitle);
        NSLayoutConstraint.ActivateConstraints(new[]
        {
            this.title.LeadingAnchor.ConstraintEqualTo(this.ContentView.LayoutMarginsGuide.LeadingAnchor),
            this.title.TrailingAnchor.ConstraintEqualTo(this.ContentView.LayoutMarginsGuide.TrailingAnchor),
            this.title.TopAnchor.ConstraintEqualTo(this.ContentView.LayoutMarginsGuide.TopAnchor),
            this.subtitle.LeadingAnchor.ConstraintEqualTo(this.title.LeadingAnchor),
            this.subtitle.TrailingAnchor.ConstraintEqualTo(this.title.TrailingAnchor),
            this.subtitle.TopAnchor.ConstraintEqualTo(this.title.BottomAnchor, 4),
            this.subtitle.BottomAnchor.ConstraintEqualTo(this.ContentView.LayoutMarginsGuide.BottomAnchor),
        });
    }
}

4. `Views/TableSource.cs` — bridges ListItemManager to the table:

using Foundation;
using MyApp.Models;
using UIKit;

namespace MyApp.Views;

public class TableSource(IEnumerable<ListItem> items) : UITableViewSource
{
    public override nint RowsInSection(UITableView tableView, nint section) => items.Count();

    public override UITableViewCell GetCell(UITableView tableView, NSIndexPath indexPath)
    {
        var cell = tableView.DequeueReusableCell(ItemTableViewCell.Key, indexPath) as ItemTableViewCell
            ?? throw new InvalidOperationException("Cannot retrieve cell");
        cell.Configure(items.ElementAt(indexPath.Row));
        return cell;
    }
}

Note: the source holds a reference to ListItemManager.Instance.Inventory, which is IEnumerable<ListItem> over the manager's live List<ListItem>. Every ReloadData re-reads the live list — that's why the source itself never needs an Add/Clear API of its own.

5. Wire the table into the view controller. Build it before SparkScanView.Create(...) so the SparkScan overlay lands on top:

private UITableView tableView = null!;

private void SetupTableView()
{
    this.tableView = new UITableView
    {
        TranslatesAutoresizingMaskIntoConstraints = false,
        Source = new TableSource(ListItemManager.Instance.Inventory),
        RowHeight = 70,
    };
    this.tableView.RegisterClassForCellReuse(typeof(ItemTableViewCell), ItemTableViewCell.Key);

    this.View!.AddSubview(this.tableView);
    NSLayoutConstraint.ActivateConstraints(new[]
    {
        this.tableView.LeadingAnchor.ConstraintEqualTo(this.View.LeadingAnchor),
        this.tableView.TrailingAnchor.ConstraintEqualTo(this.View.TrailingAnchor),
        this.tableView.TopAnchor.ConstraintEqualTo(this.View.SafeAreaLayoutGuide.TopAnchor),
        this.tableView.BottomAnchor.ConstraintEqualTo(this.View.SafeAreaLayoutGuide.BottomAnchor),
    });

    ListItemManager.Instance.ListsChanged += (_, _) =>
        DispatchQueue.MainQueue.DispatchAsync(this.tableView.ReloadData);
}

Call SetupTableView from ViewDidLoad before SetupSparkScan:

public override void ViewDidLoad()
{
    base.ViewDidLoad();
    this.SetupTableView();
    this.SetupSparkScan();
}

6. Update the Step 6 scan handler to append to the manager. BarcodeScanned runs on a background thread, but SetupTableView already dispatches ReloadData to the main queue via the ListsChanged subscription, so the handler itself just calls AddItem:

private void BarcodeScanned(object? sender, SparkScanEventArgs args)
{
    var barcode = args.Session.NewlyRecognizedBarcode;
    if (barcode == null) return;

    var number = ListItemManager.Instance.TotalItemsCount + 1;
    ListItemManager.Instance.AddItem(new ListItem(number, barcode.Symbology, barcode.Data));
}

That's the complete pattern — text-only rows, no thumbnails. Want a thumbnail of the scanned barcode in each row? The official ListBuildingSample extracts one from the frame buffer using two helpers it defines locally (the SDK does not ship them):

// Inside BarcodeScanned, after retrieving `barcode`:
using var imageBuffer = args.FrameData?.ImageBuffers.LastOrDefault();
using var frame = imageBuffer?.ToImage();
var location = barcode.GetBarcodeLocation(frame); // custom extension method
var thumbnail = frame?.CropImage(
    (int)location.X, (int)location.Y, (int)location.Width, (int)location.Height); // custom extension method
// then pass `thumbnail` to ListItem

Barcode.GetBarcodeLocation(UIImage?) and UIImage.CropImage(int, int, int, int) are extension methods defined in the sample, not SDK APIs — see Extensions/BarcodeExtensions.cs and Extensions/UIImageExtensions.cs in ListBuildingSample and copy them into your project. IFrameData, the image buffer, and the produced UIImage must all be disposed — the using declarations above are mandatory. Failing to dispose causes the preview to stutter or freeze (this is the same disposal rule called out in the iOS gotchas in SKILL.md). To render the thumbnail, add a UIImage? Image property to ListItem, add a UIImageView to ItemTableViewCell and bind it in Configure, and pass the cropped image when calling AddItem(new ListItem(thumbnail, …)).

Target Mode (aim-to-scan)

For precise scanning in crowded environments, change SparkScanViewSettings.DefaultScanningMode from the default SparkScanScanningModeDefault to SparkScanScanningModeTarget:

using Scandit.DataCapture.Barcode.Spark.UI;

viewSettings.DefaultScanningMode = new SparkScanScanningModeTarget(
    scanningBehavior: SparkScanScanningBehavior.Single,
    previewBehavior: SparkScanPreviewBehavior.Default);

SparkScanScanningModeDefault and SparkScanScanningModeTarget are constructed with new. There is no parameterless constructor in the .NET binding — the (SparkScanScanningBehavior, SparkScanPreviewBehavior) constructor is required.

To let users switch modes from the toolbar at runtime:

this.sparkScanView.TargetModeButtonVisible = true;

Tracking view state

SparkScanView.ViewStateChanged fires every time the view transitions between Initial, Idle, Inactive, Active, and Error:

this.sparkScanView.ViewStateChanged += (sender, args) =>
{
    DispatchQueue.MainQueue.DispatchAsync(() =>
    {
        switch (args.State)
        {
            case SparkScanViewState.Active:
                this.myButton.SetTitle("STOP SCANNING", UIControlState.Normal);
                break;
            default:
                this.myButton.SetTitle("START SCANNING", UIControlState.Normal);
                break;
        }
    });
};

Custom trigger button (hide built-in, control programmatically)

this.sparkScanView.TriggerButtonVisible = false;

// Start scanning from a custom button:
myStartButton.TouchUpInside += (_, _) => this.sparkScanView.StartScanning();

// Pause:
myPauseButton.TouchUpInside += (_, _) => this.sparkScanView.PauseScanning();

Showing toolbar buttons

All toolbar buttons default to invisible (except the torch). Enable them through SparkScanView properties, and listen for taps through the corresponding events:

this.sparkScanView.BarcodeCountButtonVisible = true;
this.sparkScanView.BarcodeCountButtonTapped += (s, e) => { /* open Barcode Count screen */ };

this.sparkScanView.BarcodeFindButtonVisible = true;
this.sparkScanView.BarcodeFindButtonTapped += (s, e) => { /* open Barcode Find screen */ };

this.sparkScanView.LabelCaptureButtonVisible = true;   // dotnet.ios 8.3+
this.sparkScanView.LabelCaptureButtonTapped += (s, e) => { /* open Label Capture screen */ };

this.sparkScanView.ScanningBehaviorButtonVisible = true; // toggle Single ↔ Continuous from toolbar

Custom toast on a scan

this.sparkScanView.ShowToast("Item added");

ShowToast is fire-and-forget — the toast lifetime is controlled by the SDK.

CodeDuplicateFilter

Suppress duplicate scans of the same code within a time window. The .NET SparkScan API uses TimeSpan directly — there are no CodeDuplicate.DefaultDuplicateFilter / CodeDuplicate.ReportDataAndSymbologyOnlyOnce sentinels here (those live on BarcodeCaptureSettings).

// Custom 500 ms window
settings.CodeDuplicateFilter = TimeSpan.FromMilliseconds(500);

// Custom 2.5 s window
settings.CodeDuplicateFilter = TimeSpan.FromSeconds(2.5);

// Disable filtering — every detection is reported
settings.CodeDuplicateFilter = TimeSpan.Zero;

Set this before constructing the SparkScan. To change at runtime, mutate the settings and call sparkScan.ApplySettingsAsync(settings).

ScanIntention

settings.ScanIntention = ScanIntention.Smart;   // default from 7.0
settings.ScanIntention = ScanIntention.Manual;  // legacy v6 behavior

BatterySaving

settings.BatterySaving = BatterySavingMode.Auto;  // default
settings.BatterySaving = BatterySavingMode.Off;
settings.BatterySaving = BatterySavingMode.On;

SparkScanLicenseInfo

Once the SparkScan mode has been associated with a DataCaptureContext and the context emits OnModeAdded, inspect which symbologies the active license allows:

SparkScanLicenseInfo? licenseInfo = this.sparkScan.SparkScanLicenseInfo;
ICollection<Symbology>? licensed = licenseInfo?.LicensedSymbologies;

Available from Scandit.DataCapture.Barcode 6.22 onwards on dotnet.ios.

Async work after a scan (Task-based)

When the scan result requires a network or database call, do not block the scanner thread:

private async void BarcodeScanned(object? sender, SparkScanEventArgs args)
{
    var data = args.Session.NewlyRecognizedBarcode?.Data;
    using var imageBuffer = args.FrameData?.ImageBuffers.LastOrDefault();
    using var frame = imageBuffer?.ToImage();
    if (data == null) return;

    try
    {
        var result = await LookupAsync(data);
        DispatchQueue.MainQueue.DispatchAsync(() => this.UpdateUi(result));
    }
    catch (Exception ex)
    {
        // Log; SparkScan keeps scanning regardless.
    }
}

async void is acceptable here because the event handler signature is void. Always dispose any frame-data image buffers up front before the await so the SDK can recycle them.

Key rules

1. One context per scanning surface — construct DataCaptureContext.ForLicenseKey(key) once and reuse it. 2. `SparkScan` uses `new`, `SparkScanView` uses `Create` — new SparkScan(settings), new SparkScanSettings(), but SparkScanView.Create(parent, context, sparkScan, settings). Don't write SparkScan.Create(...) — it doesn't exist. 3. Parent is `this.View`, no coordinator layout — iOS does not use SparkScanCoordinatorLayout (that's Android-only). The factory adds the view to the parent automatically; do not also call AddSubview. 4. Forward `ViewWillAppear` / `ViewWillDisappear` into `PrepareScanning()` / `StopScanning()` — these are the iOS-specific lifecycle methods on SparkScanView. OnPause / OnResume are Android-only. 5. Event API is idiomatic — prefer sparkScan.BarcodeScanned += handler over AddListener. Both work, but the official sample uses events. 6. Listener has only two callbacks — ISparkScanListener.OnBarcodeScanned and OnSessionUpdated. No OnObservation*. 7. Background thread + main-queue dispatch — BarcodeScanned / OnBarcodeScanned and GetFeedbackForBarcode both run off the UI thread. DispatchQueue.MainQueue.DispatchAsync(() => …) is required for UI updates. 8. Always `using` frame-data image buffers — using var imageBuffer = args.FrameData?.ImageBuffers.LastOrDefault(); using var frame = imageBuffer?.ToImage();. Failing to dispose causes a frozen / stuttering preview. 9. Feedback delegate, eager construction — build SparkScanBarcodeSuccessFeedback / SparkScanBarcodeErrorFeedback once in SetupSparkScan, return cached instances from GetFeedbackForBarcode. 10. SDK 8.0+ requires `AppDelegate` init — ScanditCaptureCore.Initialize() + ScanditBarcodeCapture.Initialize() at the top of FinishedLaunching. 11. `NSCameraUsageDescription` in `Info.plist` is mandatory. 12. `TimeSpan`, not `TimeInterval` — CodeDuplicateFilter, TriggerButtonCollapseTimeout, InactiveStateTimeout, and SparkScanBarcodeErrorFeedback.resumeCapturingDelay are all TimeSpan. 13. Symbologies are PascalCase — Symbology.Ean13Upca, not .ean13UPCA.

SparkScan .NET for iOS Migration Guide

Step 1: Detect the installed SDK version

Before making any changes, find out which version of the Scandit SDK the project currently has installed.

Check .csproj (and Directory.Packages.props if Central Package Management is in use) for the <PackageReference Include="Scandit.DataCapture.Barcode" Version="..." /> (or Scandit.DataCapture.Core) line. Both packages should be pinned to the same version. If they drift, treat the lowest version as the installed one.

Once you know the installed version, determine which migration path applies:

If you cannot find the version, ask the user which version they are migrating from.

Note: SparkScan on dotnet.ios was first published in 6.22. Anything older does not have a SparkScan API on this platform — confirm with the user before assuming a version below 6.22.

---

Step 2: Update the dependency version

Update the SDK version in every <PackageReference>:

• Scandit.DataCapture.Core
• Scandit.DataCapture.Barcode

Restore packages (dotnet restore or rebuild in the IDE) before continuing.

---

Step 3: Apply source-code changes

Search for files that use SparkScan (search for SparkScan, SparkScanSettings, SparkScanView, SparkScanViewSettings, SparkScanEventArgs, ISparkScanListener, ISparkScanFeedbackDelegate) and apply the relevant changes below directly to those files.

---

Migration: 6 → 7

The 6→7 step for .NET iOS SparkScan is primarily about renamed / removed SparkScanView properties and the scan-intention default change. Go through every section below and apply each change that matches the project.

Where these properties live in v6

• On `SparkScanView` — all button-visibility, color, and text properties listed below.
• On `SparkScanViewSettings` — DefaultHandMode only (removed in v7).

When searching the project, look for usages on both the view instance and the settings object.

SparkScanView renames

Apply these renames everywhere they appear. Always replace the old name with the new one, preserving the existing value, regardless of what that value is:

Note on `CameraButtonBackgroundColor`: v7 splits this into three separate color properties for the collapsed state, expanded state, and animation. If the user set a single color, apply it to all three unless they indicate otherwise.

SparkScanView removed APIs

Remove any usage of these properties — they no longer exist in v7 and will cause compile errors:

• CaptureButtonActiveBackgroundColor
• StopCapturingText, StartCapturingText, ResumeCapturingText, ScanningCapturingText — the trigger button no longer displays text
• HandModeButtonVisible
• SoundModeButtonVisible
• HapticModeButtonVisible
• ShouldShowScanAreaGuides

SparkScanViewSettings removed APIs

• DefaultHandMode — removed in v7. Hand-mode is no longer configurable.

TriggerButtonCollapseTimeout default change

The default value changed from "never collapse" to 5 seconds.

• If the project already sets TriggerButtonCollapseTimeout explicitly, leave it as is.
• If the project does not set it, do not add it automatically. Instead, inform the user that the button will now collapse after 5 seconds by default and they can set it to TimeSpan.FromSeconds(-1) to restore the old behavior.

New v7 APIs (optional)

These are available in v7 — mention them only if the user asks:

• SparkScanViewState (enum Initial, Idle, Inactive, Active, Error) + the SparkScanView.ViewStateChanged event of type EventHandler<SparkScanViewStateEventArgs>.
• SparkScanViewSettings.DefaultMiniPreviewSize (SparkScanMiniPreviewSize.Regular / Expanded).
• SparkScanView.PreviewCloseControlVisible, TriggerButtonVisible (defaults to true), TorchControlVisible.
• SparkScanView.TriggerButtonImage (Core.Image?) — set a custom trigger icon.
• SparkScanView.TriggerButtonCollapsedColor / TriggerButtonExpandedColor / TriggerButtonAnimationColor / TriggerButtonTintColor — replacements for v6's color properties.

BarcodeTracking → BarcodeBatch rename

If the project uses BarcodeTracking (MatrixScan) alongside SparkScan, rename all occurrences to BarcodeBatch. The API is otherwise unchanged.

Scan intention default change

The default ScanIntention is now Smart from v7.

• If the project already explicitly sets ScanIntention.Manual (or any other value) on SparkScanSettings, leave it.
• If the project uses a single-image frame source, Smart is incompatible — set settings.ScanIntention = ScanIntention.Manual.
• Otherwise the code still compiles — no change needed. Inform the user that Smart Scan is now the default.

---

Migration: 7 → 8

The 7→8 step for .NET iOS SparkScan is mostly mechanical. Most of the API surface is unchanged. The one required action is adding explicit SDK initialization in AppDelegate.FinishedLaunching — without it, the app crashes on the first Scandit API call.

Explicit SDK initialization is now required

Scandit 8.0 removed the implicit container bootstrap that 6.x/7.x performed automatically. The app must now call ScanditCaptureCore.Initialize() and ScanditBarcodeCapture.Initialize() before any Scandit type is constructed — AppDelegate.FinishedLaunching is the canonical hook.

Open the project's AppDelegate.cs (the class with [Register("AppDelegate")] : UIResponder, IUIApplicationDelegate — or : UIApplicationDelegate in older templates) and add the two calls at the top of FinishedLaunching, before any other launch code:

[Export("application:didFinishLaunchingWithOptions:")]
public bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
    ScanditCaptureCore.Initialize();
    ScanditBarcodeCapture.Initialize();
    // ... existing launch code (window creation, root view controller, etc.) stays below
    return true;
}

Make sure these using directives are present:

using Scandit.DataCapture.Barcode;
using Scandit.DataCapture.Core;

If the project uses a SwiftUI-style App shape (no AppDelegate.cs), put the two calls in the equivalent app-startup entry point — they must run before any Scandit type is referenced.

Symptom if this step is skipped: instant launch crash at the first new SparkScan(...) / SparkScanView.Create(...) call, because the DI container has no registrations.

LabelCaptureButtonVisible / LabelCaptureButtonTapped introduced in 8.3

If the user wants a Label Capture toolbar button, these are available in 8.3+:

this.sparkScanView.LabelCaptureButtonVisible = true;
this.sparkScanView.LabelCaptureButtonTapped += (s, e) => { /* navigate to Label Capture screen */ };

If the project does not use Label Capture, no action is needed.

TargetModeButtonVisible deprecation in 8.5

The target mode button now toggles SparkScanSettings.SelectionMode between SelectionMode.On and SelectionMode.Off. The property name TargetModeButtonVisible will be renamed in 9.0. Existing code keeps compiling — no required change.

SparkScan text scanning (8.x, opt-in)

v8 adds the ability to scan text alongside barcodes in SparkScan. This is purely additive — existing code is unaffected. Mention it only if the user asks about new features.

Reminder: always dispose frame-data image buffers

This rule is not new in v8, but it is worth re-checking during a migration. The official .NET iOS SparkScan sample uses using var imageBuffer = args.FrameData?.ImageBuffers.LastOrDefault(); using var frame = imageBuffer?.ToImage();. Without using / Dispose() the preview can freeze or stutter.

No other breaking SparkScan changes

new SparkScan(settings), ISparkScanListener, the BarcodeScanned / SessionUpdated events, SparkScanSession, SparkScanView.Create(...), PrepareScanning() / StopScanning(), and the feedback delegate are all unchanged in v8 for .NET for iOS.

---

After applying changes

1. Restore NuGet packages (dotnet restore) and rebuild. Fix any remaining compile errors using the API reference (linked in SKILL.md). 2. Let the user know they can check the full list of SDK changes in the official migration guides:

• 6 → 7: https://docs.scandit.com/sdks/net/ios/migrate-6-to-7/
• 7 → 8: https://docs.scandit.com/sdks/net/ios/migrate-7-to-8/

3. Show the user a summary of only the changes actually made: which files were edited, which properties were renamed/removed, and anything that required a judgment call (e.g., how CameraButtonBackgroundColor was split into three properties). Do not list APIs that were already correct or unchanged. 4. If compile errors persist after the changes above, fetch the SparkScan API reference (https://docs.scandit.com/data-capture-sdk/dotnet.ios/barcode-capture/api.html) to find the correct API before guessing.

Third-Party Barcode Scanner → SparkScan Migration (.NET for iOS)

Before anything else

Read the existing code. Do not ask the user to describe what their scanner does. Identify:

• Which framework is in use (read the using directives and <PackageReference> lines).
• Which symbologies are enabled.
• What result handling logic exists (deduplication, filtering, accumulation).
• What data models are defined.
• How the scanner is launched (modal view controller, embedded view, AVFoundation pipeline).

Common third-party scanners in .NET iOS codebases:

• ZXing.Net.Mobile (ZXing.Mobile.MobileBarcodeScanner, ZXing.BarcodeFormat) — modal scanner UI, returns ZXing.Result.
• ZXing.Net — pure decoder, often paired with AVFoundation for camera frames.
• AVFoundation `AVCaptureMetadataOutput` / `AVMetadataMachineReadableCodeObject` — Apple's built-in barcode scanning via AVMetadataObject.TypeQRCode, AVMetadataObject.TypeEan13Code, etc.
• Third-party wrappers around AVFoundation.

---

Remove

• The third-party <PackageReference> entries from the .csproj (e.g. ZXing.Net.Mobile, ZXing.Net.Mobile.Forms).
• All using ZXing.*; directives.
• The scanner instance, its setup code, the callback / listener conformance.
• Any AVCaptureSession, AVCaptureMetadataOutput, IAVCaptureMetadataOutputObjectsDelegate / AVCaptureMetadataOutputObjectsDelegate plumbing — SparkScanView replaces all of it.
• Any UI code specific to the old scanner (modal presentation, preview layer, overlay it provided).

SparkScan replaces the third-party scanner's camera, preview, and UI entirely. There is no separate camera setup or DataCaptureView to wire up — SparkScanView owns its own camera and overlays the trigger button on top of the host view controller's view.

---

Integrate SparkScan

Follow references/integration.md. When configuring SparkScanSettings, map symbologies from the old scanner using the table below. Do not guess or derive Scandit symbology names from the old library's names — they differ (e.g. ZXing's QR_CODE maps to Symbology.Qr, not Symbology.QrCode).

Symbology mapping

If you encounter a symbology not in this table, check the SparkScan API reference for the correct Symbology enum value before writing the code.

---

Preserve

• Custom data models — keep as-is.
• Result accumulation and deduplication logic — move verbatim into the BarcodeScanned event handler (or ISparkScanListener.OnBarcodeScanned). Wrap UI updates in DispatchQueue.MainQueue.DispatchAsync(() => { … }) because the SparkScan callback runs on a background thread.
• Always dispose any image buffers you read from SparkScanEventArgs.FrameData: using var imageBuffer = args.FrameData?.ImageBuffers.LastOrDefault();.
• Any downstream business logic triggered on scan result.
• Validation / reject behavior — if the old scanner displayed an error for invalid codes, port that logic into ISparkScanFeedbackDelegate.GetFeedbackForBarcode(Barcode), returning a SparkScanBarcodeErrorFeedback("...", TimeSpan.FromSeconds(...)).

---

When done, show only what changed. Do not list APIs that were unchanged. Include the setup checklist from references/integration.md so the user knows which NuGet packages, Info.plist key (NSCameraUsageDescription), and AppDelegate initialization (SDK 8.0+) to add.