Data Capture Context

Defined in library scandit_datacapture_core

DataCaptureContextCreationOptions

abstract class DataCaptureContextCreationOptions

Added in version 6.7.0

deviceName

String? deviceName

Added in version 6.7.0

The device name allows to optionally identify the device with a user-provided name. This name is then associated with unique identifier of the device and displayed in the online dashboard.

DataCaptureContext

class DataCaptureContext

Added in version 6.7.0

Data capture context is the main class for running data-capture related tasks. The context manages one or more capture modes, such as BarcodeCapture that perform the recognition. The context itself acts as a scheduler, but does not provide any interfaces for configuring data capture capabilities. Configuration and result handling is handled by the data capture modes directly.

Each data capture context has exactly one frame source (typically a built-in camera). The frame source delivers the frames on which the capture modes should perform recognition on. When a new capture context is created, it’s frame source is null and must be initialized for recognition to work.

Typically a DataCaptureView is used to visualize the ongoing data capture process on screen together with one or more overlays. However it’s also possible to use the data capture context without a view to perform off-screen processing.

DataCaptureContext.forLicenseKey(licenseKey)

DataCaptureContext.forLicenseKey(String licenseKey)

Added in version 6.7.0

Constructs a data capture context with the provided license key.

DataCaptureContext.forLicenseKeyWithOptions(licenseKey, options)

factory DataCaptureContext.forLicenseKeyWithOptions(
        String licenseKey,
        DataCaptureContextCreationOptions? options)

Added in version 6.7.0

Constructs a data capture context with the provided license key and additional options.

DataCaptureContext.forLicenseKeyWithSettings(licenseKey, settings)

factory DataCaptureContext.forLicenseKeyWithSettings(
        String licenseKey,
        DataCaptureContextSettings? settings)

Added in version 6.7.0

Constructs a data capture context with the provided license key and optional settings.

deviceId

static String get deviceId

Added in version 6.18.0

The unique identifier of the device as used by the Scandit Data Capture SDK. This identifier does not contain any device identifying information that would be usable outside of the context of the Scandit Data Capture SDK itself.

setFrameSource(frameSource)

Future<void> setFrameSource(FrameSource frameSource)

Added in version 6.7.0

Set the frame source of this data capture context.

Frame sources produce frames to be processed by the data capture context. The user typically doesn’t create their own frame sources, but use one of the frame sources provided by the Scandit Data Capture SDK. Typical frame sources are web cams, or built-in cameras of a mobile device.

Setting the frame source to null will effectively stop recognition of this capture context.

frameSource

FrameSource? get frameSource

Added in version 6.7.0

Readonly attribute to get the current frame source. To change the frame source use setFrameSource().

addListener(listener)

void addListener(DataCaptureContextListener listener)

Added in version 6.7.0

Adds the listener to this data capture context. Context listeners receive events when new data capture modes are added, or the frame source changes.

In case the same listener is already observing this instance, calling this method will not add the listener again.

removeListener(listener)

void removeListener(DataCaptureContextListener listener)

Added in version 6.7.0

Removes a previously added listener from this data capture context.

In case the listener is not currently observing this instance, calling this method has no effect.

addMode(mode)

void addMode(DataCaptureMode mode)

Added in version 6.7.0

Adds the specified data capture mode to this capture context. Please note that it is not possible to add a mode associated with a context to a different context. If the mode is already associated with this context, this call has no effect.

Multiple data capture modes can be associated with the same context. However, there are restrictions on which data capture modes can be used together. These restrictions are expressed in terms of capabilities that the capture modes require, .e.g. barcode scanning, tracking. No two capture modes that require the same capabilities can be used with the same data capture context. When conflicting requirements are detected, the data capture context will not process any frames and report an error.

removeMode(mode)

void removeMode(DataCaptureMode mode)

Added in version 6.7.0

Removes the mode from this capture context. If the capture mode is currently not associated to the context, this call has no effect.

removeAllModes()

void removeAllModes()

Added in version 6.7.0

Removes all modes from this capture context. If there currently are no captures modes associated to the context, this call has no effect.

licenseInfo

LicenseInfo? get licenseInfo

Added in version 6.7.0

Information about the license the context was created for.

Note

This value is available with a small delay. To make sure it is available, set a listener and as soon as DataCaptureContextListener.didStartObservingContext() was called, it is available.

applySettings(settings)

Future<void> applySettings(DataCaptureContextSettings settings)

Added in version 6.7.0

Applies the given settings to the data capture context.