Scandit CDN Simple sample

### start() Source: https://docs.scandit.com/data-capture-sdk/capacitor/barcode-capture/api/ui/barcode-pick-view.html Starts the camera and the scanning process. This method is asynchronous and returns a Promise that resolves when the process has started. It can be stopped by calling stop(). ```APIDOC ## start() ### Description Starts the camera and the scanning process. Can be stopped by calling [stop()](#method-scandit.datacapture.barcode.pick.ui.BarcodePickView.Stop "stop() method"). ### Method `start(): Promise` ### Added in version 6.22.0 ``` -------------------------------- ### Start() Source: https://docs.scandit.com/data-capture-sdk/dotnet.android/barcode-capture/api/ui/barcode-ar-view.html Starts the scanning process. ```APIDOC ## Start() ### Description Starts the scanning process. ### Return value void ### Added in version 7.2.0 ``` -------------------------------- ### Complete CDN Example for Scandit Web SDK Source: https://docs.scandit.com/sdks/web/add-sdk This HTML snippet demonstrates a full setup for using the Scandit Web SDK via CDN. It includes import maps for module resolution and initializes the DataCaptureContext with a license key and camera settings for barcode scanning. ```html Scandit CDN Simple sample

``` -------------------------------- ### start() Source: https://docs.scandit.com/data-capture-sdk/android/barcode-capture/api/ui/barcode-ar-view.html Starts the scanning process. The scanning process will actually start only if the lifecycle state is resumed, which can be done by calling onResume(). ```APIDOC ## start() ### Description Starts the scanning process. The scanning process will actually start only if the lifecycle state is resumed, which can be done by calling [onResume()](#method-scandit.datacapture.barcode.ar.ui.BarcodeArView.OnResume "onResume() method"). ### Added in version 7.1.0 ``` -------------------------------- ### start() Source: https://docs.scandit.com/data-capture-sdk/flutter/barcode-capture/api/ui/barcode-pick-view.html Starts the camera and the scanning process. This method can be stopped by calling stop(). ```APIDOC ## start() ### Description Starts the camera and the scanning process. Can be stopped by calling stop(). ### Method Future ### Added in version 6.22.0 ``` -------------------------------- ### start Source: https://docs.scandit.com/data-capture-sdk/web/barcode-capture/api/ui/barcode-ar-view.html Starts the scanning process. This method returns a Promise that resolves when the scanning has started. ```APIDOC ## start ### Description Starts the scanning process. ### Method start() ### Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise")<`void`> ### Added in version 7.1.0 ``` -------------------------------- ### start Source: https://docs.scandit.com/data-capture-sdk/react-native/barcode-capture/api/ui/barcode-ar-view.html Starts the scanning process. Added in version 7.1.0. ```APIDOC ## Method: start() ### Description Starts the scanning process. ### Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise")<`void` ### Added in version 7.1.0 ``` -------------------------------- ### start() Source: https://docs.scandit.com/data-capture-sdk/capacitor/barcode-capture/api/ui/barcode-ar-view.html Initiates the barcode scanning process within the AR view. This method returns a Promise that resolves when the process has started. ```APIDOC ## Method: start() ### Description Starts the scanning process. ### Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise")<`void`> ### Added in version 8.2.0 ``` -------------------------------- ### start Source: https://docs.scandit.com/data-capture-sdk/flutter/barcode-capture/api/barcode-find.html Starts or resumes the search process. ```APIDOC ## start ### Description Starts or resumes the search process. ### Method Signature `Future start()` ``` -------------------------------- ### Build iOS Project to Install CocoaPods Source: https://docs.scandit.com/sdks/cordova/add-sdk After adding plugins and setting up the CocoaPods repository, build your iOS project to ensure all native dependencies are installed correctly. ```bash cordova build ios ``` -------------------------------- ### Start Scanning Process Source: https://docs.scandit.com/data-capture-sdk/dotnet.android/barcode-capture/api/ui/spark-scan-view.html Starts the scanning process programmatically without requiring user interaction. ```csharp StartScanning() ``` -------------------------------- ### BarcodeCapture Usage Example Source: https://docs.scandit.com/data-capture-sdk/flutter/core/api/data-capture-mode.html Illustrates the typical steps for configuring and initializing a capture mode, using BarcodeCapture as an example. This includes creating settings, instantiating the mode, and associating it with a context. Capture modes are enabled by default. ```dart var dataCaptureContext \= ...; var settings \= BarcodeCaptureSettings(); settings.enableSymbology(Symbology.qr, true); var barcodeCapture \= BarcodeCapture.forContext(dataCaptureContext, settings); // Capture modes are enabled by default. The next line is not strictly necessary and // is only listed to make you aware of the possibility to enable/disable modes. barcodeCapture.isEnabled \= true; ``` -------------------------------- ### HIBC Data Format Example Source: https://docs.scandit.com/data-capture-sdk/capacitor/parser/formats.html Example of a HIBC (Health Industry Bar Code) string. HIBC data is used in the medical space and starts with a '+' character. ```plaintext "+HIBCMED121/$1728/S87V" ``` ```plaintext "+$A1234GU" ``` -------------------------------- ### initialize(licenseKey, options, settings) Source: https://docs.scandit.com/data-capture-sdk/cordova/core/api/data-capture-context.html Initializes the singleton context instance with the provided license key, options, and settings. ```APIDOC ## initialize(licenseKey, options, settings) ### Description Initializes the singleton context instance with the provided license key, and returns the same instance. ### Method `static initialize(_licenseKey_: string, _options_: DataCaptureContextCreationOptions | null, _settings_: DataCaptureContextSettings | null)` ### Parameters #### Path Parameters - **licenseKey** (string) - The license key for Scandit Data Capture. - **options** (DataCaptureContextCreationOptions | null) - Optional configuration options for context creation. - **settings** (DataCaptureContextSettings | null) - Optional initial settings for the data capture context. ### Returns `DataCaptureContext` ``` -------------------------------- ### BarcodeCaptureOverlay.Viewfinder Source: https://docs.scandit.com/data-capture-sdk/dotnet.android/barcode-capture/api/ui/barcode-capture-overlay.html Gets or sets the viewfinder for the barcode capture overlay. A viewfinder is displayed on top of the camera preview to guide the user. ```APIDOC ## BarcodeCaptureOverlay.Viewfinder ### Description Sets the viewfinder. By default, the viewfinder is null. Set this to an instance of [IViewfinder](../../../core/api/viewfinder.html#interface-scandit.datacapture.core.ui.IViewfinder "IViewfinder interface") if you want to draw a viewfinder. ### Property Signature ```csharp IViewfinder Viewfinder { get; set; } ``` ### Type [IViewfinder](../../../core/api/viewfinder.html#interface-scandit.datacapture.core.ui.IViewfinder "IViewfinder interface") ``` -------------------------------- ### Vibration Class Source: https://docs.scandit.com/data-capture-sdk/flutter/core/api/feedback.html The Vibration class represents a vibration to be emitted, for example, when a code has been successfully scanned. It is available starting from version 6.7.0. ```APIDOC ## Class: Vibration ### Description A vibration, to be emitted for example when a code has been successfully scanned. ### Added in version 6.7.0 ## Constructor: Vibration() ### Description Initializes a new instance of the Vibration class. ### Added in version 6.7.0 ``` -------------------------------- ### Initialize Capacitor Project Source: https://docs.scandit.com/sdks/capacitor/add-sdk Commands to initialize a new Capacitor project and add iOS and Android platforms. ```bash npx cap init npx cap add ios npx cap add android ``` -------------------------------- ### Code Direction Hint Source: https://docs.scandit.com/stable/c_api/struct_sc_barcode_scanner_settings.html Functions to get and set a hint for the expected direction of barcodes. This can improve scanning performance by guiding the scanner's orientation. ```APIDOC ## sc_barcode_scanner_settings_get_code_direction_hint ### Description Retrieves the current hint for the code direction. ### Parameters - **settings** (*const ScBarcodeScannerSettings**) - Pointer to the scanner settings object. ### Returns - (*ScCodeDirection*) The current code direction hint. ``` ```APIDOC ## sc_barcode_scanner_settings_set_code_direction_hint ### Description Sets a hint for the expected direction of barcodes to potentially improve scanning performance. ### Parameters - **settings** (*ScBarcodeScannerSettings**) - Pointer to the scanner settings object. - **direction** (*ScCodeDirection*) - The direction hint to set. ``` -------------------------------- ### Create Recommended Camera Settings Source: https://docs.scandit.com/data-capture-sdk/android/barcode-capture/api/barcode-capture.html Obtain the recommended CameraSettings for optimal barcode capture performance. ```kotlin fun BarcodeCapture.createRecommendedCameraSettings(): CameraSettings ``` -------------------------------- ### Camera Initialization Source: https://docs.scandit.com/data-capture-sdk/capacitor/core/api/camera.html Get the default camera or create a camera instance with specific settings or position. ```APIDOC ## static get default(): Camera | null ### Description Gets the default camera of the device. It attempts to find a camera in the order: world-facing, user-facing, and unspecified. Returns the first available camera or null if none are found. ### Returns - `Camera | null` - The default camera instance or null. ``` ```APIDOC ## static atPosition(cameraPosition) ### Description Returns a camera instance for the specified position if available, otherwise returns null. ### Parameters - `_cameraPosition_` (`CameraPosition`) - The desired position of the camera (e.g., `CameraPosition.WorldFacing`, `CameraPosition.UserFacing`). ### Returns - `Camera | null` - A camera instance for the specified position or null. ``` ```APIDOC ## static withSettings(settings) ### Description Creates a camera instance with the provided camera settings. ### Parameters - `_settings_` (`CameraSettings`) - The camera settings to apply. ### Returns - `Camera | null` - A camera instance configured with the specified settings, or null if the settings are invalid or not supported. ``` -------------------------------- ### init(context:settings:) Source: https://docs.scandit.com/data-capture-sdk/ios/label-capture/api/label-capture.html Constructs a new label capture mode with the provided context and settings. The capture mode is automatically added to the context if it's not nil. The settings must include at least one LabelDefinition. ```APIDOC ## init(context:settings:) ### Description Constructs a new label capture mode with the provided context and settings. When the context is not nil, the capture mode is automatically added to the context. The settings must contain at least one [LabelDefinition](label-definition.html#class-scandit.datacapture.label.LabelDefinition "LabelDefinition class") that defines the structure and fields of labels to be captured. The label definitions specify what types of data (barcodes, text, dates, etc.) are expected. ### Parameters - **context** ([DataCaptureContext](../../core/api/data-capture-context.html#class-scandit.datacapture.core.DataCaptureContext "DataCaptureContext class")?): The data capture context to associate with the label capture mode. If nil, the mode is not automatically added to any context. - **settings** ([LabelCaptureSettings](label-capture-settings.html#class-scandit.datacapture.label.LabelCaptureSettings "LabelCaptureSettings class") ): The settings for the label capture mode, including label and field definitions. ``` -------------------------------- ### initialGuidelineText Source: https://docs.scandit.com/data-capture-sdk/android/barcode-capture/api/ui/barcode-pick-view-settings.html Configures the text shown when the mode is first launched. ```APIDOC ## initialGuidelineText ### Description Configures the text shown when the mode is first launched. ### Type [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/ "String") ### Added in version 6.19.0 ``` -------------------------------- ### initialize Source: https://docs.scandit.com/data-capture-sdk/capacitor/core/api/data-capture-context.html Initializes the singleton DataCaptureContext instance with a license key, creation options, and settings. Returns the initialized instance. ```APIDOC ## initialize ### Description Initializes the singleton context instance with the provided license key, and returns the same instance. ### Method Signature `static initialize(_licenseKey_: string, _options_: DataCaptureContextCreationOptions | null, _settings_: DataCaptureContextSettings | null): DataCaptureContext` ### Parameters * `_licenseKey_` (string) - The license key for Scandit Data Capture. * `_options_` (DataCaptureContextCreationOptions | null) - Optional creation options. * `_settings_` (DataCaptureContextSettings | null) - Optional settings for the context. ``` -------------------------------- ### Initialize DataCaptureContext, Camera, and HIBC Parser Source: https://docs.scandit.com/data-capture-sdk/react-native/parser/hibc.html Set up the DataCaptureContext, Camera, and BarcodeCapture with HIBC symbology enabled. Then, create an HIBC parser instance. ```javascript const context = DataCaptureContext.forLicenseKey("-- ENTER YOUR SCANDIT LICENSE KEY HERE --"); const camera = Camera.default; context.setFrameSource(camera); const cameraSettings = new CameraSettings(); cameraSettings.preferredResolution = VideoResolution.FullHD; camera.applySettings(cameraSettings); const settings = new BarcodeCaptureSettings(); settings.enableSymbology(Symbology.DataMatrix, true); const barcodeCapture = BarcodeCapture.forContext(context, settings); let parser; Parser.forContextAndFormat(context, ParserDataFormat.HIBC).then(p => parser = p); ``` -------------------------------- ### start Source: https://docs.scandit.com/data-capture-sdk/cordova/barcode-capture/api/barcode-find.html Starts or resumes the barcode search process. ```APIDOC ## start ### Description Starts or resumes the search process. ### Method Signature `start(): Promise` ``` -------------------------------- ### init(context:settings:) Source: https://docs.scandit.com/data-capture-sdk/ios/barcode-capture/api/barcode-capture.html Constructs a new barcode capture mode with the provided context and settings. When the context is not nil, the capture mode is automatically added to the context. ```APIDOC ## init(context:settings:) ### Description Constructs a new barcode capture mode with the provided context and settings. When the context is not nil, the capture mode is automatically added to the context. ### Parameters * **context** (DataCaptureContext) - The data capture context to associate with the barcode capture mode. If nil, the mode is not automatically added to a context. * **settings** (BarcodeCaptureSettings) - The settings to configure the barcode capture mode. ``` -------------------------------- ### stop() Source: https://docs.scandit.com/data-capture-sdk/flutter/barcode-capture/api/ui/barcode-pick-view.html Pauses the camera and the scanning process. It can be started again using start(). ```APIDOC ## stop() ### Description Pauses the camera and the scanning process. It can be started again using start(). ### Method Future ### Added in version 6.24.0 ``` -------------------------------- ### Configure and Instantiate BarcodeCapture Mode Source: https://docs.scandit.com/data-capture-sdk/capacitor/core/api/data-capture-mode.html Illustrates the typical steps for configuring and instantiating a data capture mode, using BarcodeCapture as an example. This involves creating settings, instantiating the mode with a context and settings, and optionally enabling it. ```javascript const settings = new Scandit.BarcodeCaptureSettings(); settings.setSymbologyEnabled(Scandit.Symbology.QR, true); const barcodeCapture = Scandit.BarcodeCapture.forContext( window.captureContext, settings, ); // Capture modes are enabled by default. The next line is not strictly necessary and // is only listed to make you aware of the possibility to enable/disable modes. barcodeCapture.isEnabled = true; ``` -------------------------------- ### Coordinate Conversion Guide Source: https://docs.scandit.com/data-capture-sdk/dotnet.ios/barcode-capture/api.html Guide for converting between different coordinate systems. ```APIDOC ## Coordinate Conversion Guide ### Description Provides guidance and methods for converting coordinates between various systems (e.g., image to view coordinates). ### Type Guide ``` -------------------------------- ### Data Capture Mode Initialization and Configuration Source: https://docs.scandit.com/data-capture-sdk/cordova/core/api/data-capture-mode.html Demonstrates how to create settings, enable a symbology, instantiate a Data Capture Mode (BarcodeCapture in this example), associate it with a context, and manage its enabled state. ```APIDOC ## Data Capture Mode Initialization and Usage ### Description This section outlines the steps to configure and initialize a data capture mode, such as BarcodeCapture, and manage its active state. ### Steps 1. **Configure Settings**: Create `BarcodeCaptureSettings` and enable desired symbologies. 2. **Instantiate Mode**: Create the `BarcodeCapture` mode using `forContext` with the capture context and settings. 3. **Enable/Disable Mode**: Control the processing of frames by setting the `isEnabled` property. ### Code Example ```javascript // 1. Configure the capture mode by first creating settings. const settings = new Scandit.BarcodeCaptureSettings(); settings.setSymbologyEnabled(Scandit.Symbology.QR, true); // 2. Instantiate the capture mode and associate with the context and the settings. const barcodeCapture = Scandit.BarcodeCapture.forContext( window.captureContext, // Assuming window.captureContext is already initialized settings ); // 4. Enabling recognition by setting the isEnabled property to true. // Capture modes are enabled by default. The next line is not strictly necessary and // is only listed to make you aware of the possibility to enable/disable modes. barcodeCapture.isEnabled = true; ``` ### Properties #### `isEnabled` * **Type**: `boolean` * **Description**: Controls whether the data capture mode is actively processing frames. `true` enables processing, `false` disables it. Changing this property has an immediate effect on frame processing. * **Default**: `true` * **Added in version**: 6.1.0 #### `context` * **Type**: `DataCaptureContext | null` * **Description**: The `DataCaptureContext` this mode is attached to. Returns `null` if the mode is not currently attached to a context. * **Readonly**: `true` * **Added in version**: 6.1.0 ``` -------------------------------- ### Install iOS CocoaPods Dependencies Source: https://docs.scandit.com/sdks/react-native/add-sdk After installing React Native node_modules, navigate to the ios directory and install the CocoaPods dependencies. This step is crucial for integrating native iOS libraries. ```bash cd ios && pod install && cd .. ``` -------------------------------- ### initialize Source: https://docs.scandit.com/data-capture-sdk/react-native/core/api/data-capture-context.html Initializes the singleton DataCaptureContext instance with a license key and optional settings. ```APIDOC ## initialize ### Description Initializes the singleton context instance with the provided license key, and returns the same instance. ### Method Signature `static initialize(_licenseKey_: string, _options_: DataCaptureContextCreationOptions | null, _settings_: DataCaptureContextSettings | null): DataCaptureContext` ### Parameters * `_licenseKey_` (string) - The license key for Scandit SDK. * `_options_` (DataCaptureContextCreationOptions | null) - Optional configuration options for context creation. * `_settings_` (DataCaptureContextSettings | null) - Optional initial settings for the data capture context. ``` -------------------------------- ### Turn On Camera with Permission Handling Source: https://docs.scandit.com/data-capture-sdk/android/core/api/camera.html This function demonstrates how to check for camera permission, request it if not granted, and then turn on the camera. It also handles the result of the permission request. ```APIDOC ## Turn On Camera with Permission Handling ### Description This function checks for camera permission, requests it if necessary, and then enables the camera. It also handles the result of the permission request. ### Kotlin ```kotlin private fun turnOnCamera() { if (checkSelfPermission(Manifest.permission.CAMERA) != PERMISSION_GRANTED) { requestPermissions( arrayOf(Manifest.permission.CAMERA), CAMERA_PERMISSION_REQUEST ) } else { camera.switchToDesiredState(FrameSourceState.ON, null) } } override fun onRequestPermissionsResult(requestCode: Int, permissions: Array, grantResults: IntArray) { super.onRequestPermissionsResult(requestCode, permissions, grantResults) if (requestCode == CAMERA_PERMISSION_REQUEST && grantResults.isNotEmpty() && grantResults[0] == PERMISSION_GRANTED) { turnOnCamera() } else { // Show message about denied Camera permission. } } ``` ``` -------------------------------- ### Install Core Plugin Manually via npm Source: https://docs.scandit.com/sdks/react-native/add-sdk Installs the core Scandit plugin from a local path using npm. This method is used when installing from a downloaded SDK archive. ```bash npm install file:../path/to/extracted/scandit-react-native-datacapture-core ``` -------------------------------- ### Install Core Plugin Manually via Yarn Source: https://docs.scandit.com/sdks/react-native/add-sdk Installs the core Scandit plugin from a local path using Yarn. This method is used when installing from a downloaded SDK archive. ```bash yarn add file:../path/to/extracted/scandit-react-native-datacapture-core ``` -------------------------------- ### Initialize Singleton DataCaptureContext Source: https://docs.scandit.com/7.6.14/sdks/react-native/release-notes Initialize the singleton DataCaptureContext with a license key. This step is required once. ```javascript DataCaptureContext.Initialize("YOUR_LICENSE_KEY"); ``` -------------------------------- ### Start Searching Source: https://docs.scandit.com/data-capture-sdk/dotnet.ios/barcode-capture/api/ui/barcode-find-view.html Starts the searching process programmatically without user interaction. ```APIDOC ## StartSearching() ### Description Starts the searching process. You can call this method if you want to trigger the searching process without any user interaction. ### Method `void` ``` -------------------------------- ### init(labelCapture:) Source: https://docs.scandit.com/data-capture-sdk/ios/label-capture/api/ui/label-capture-basic-overlay.html Constructs a new overlay to visualize the process of label capture. The overlay needs to be added through a call to DataCaptureView.addOverlay(). ```APIDOC ## init(labelCapture:) ### Description Constructs a new overlay to visualize the process of label capture. The overlay needs to be added through a call to [DataCaptureView.addOverlay()](../../../core/api/ui/data-capture-view.html#method-scandit.datacapture.core.ui.DataCaptureView.AddOverlay "DataCaptureView.addOverlay() method"). ### Parameters - **labelCapture**: [LabelCapture](../label-capture.html#class-scandit.datacapture.label.LabelCapture "LabelCapture class") - The LabelCapture instance to use. ``` -------------------------------- ### freeze() Source: https://docs.scandit.com/data-capture-sdk/flutter/barcode-capture/api/ui/barcode-pick-view.html Freezes the camera and the highlights position to make the selection easier. The scanning can be started again using start(). ```APIDOC ## freeze() ### Description Freezes the camera and the highlights position to make the selection easier. The scanning can be started again using start(). ### Method Future ### Added in version 6.22.0 ``` -------------------------------- ### Scan Area Guides Source: https://docs.scandit.com/data-capture-sdk/cordova/label-capture/api/ui/label-capture-basic-overlay.html Controls the display of scan area guides over the camera preview for development and debugging purposes. ```APIDOC ## Scan Area Guides ### `shouldShowScanAreaGuides` shouldShowScanAreaGuides: boolean * **Description**: Controls whether scan area guides are displayed over the camera preview. These guides help visualize the active scanning regions during development and debugging. This feature is intended for development purposes only and should not be enabled in production applications. By default this property is false. * **Added in version**: 8.2.0 ``` -------------------------------- ### Initialize Swiss QR Parser and Barcode Capture Source: https://docs.scandit.com/data-capture-sdk/capacitor/parser/swissqr.html Set up the DataCaptureContext, Camera, BarcodeCapture, and Swiss QR parser. Apply camera settings and configure the parser with a minimal version. ```typescript const context = Scandit.DataCaptureContext.forLicenseKey("-- ENTER YOUR SCANDIT LICENSE KEY HERE --"); const camera = Scandit.Camera.default; context.setFrameSource(camera); const cameraSettings = new Scandit.CameraSettings(); cameraSettings.preferredResolution = Scandit.VideoResolution.FullHD; camera.applySettings(cameraSettings); const settings = new Scandit.BarcodeCaptureSettings(); const barcodeCapture = Scandit.BarcodeCapture.forContext(context, settings); let parser; Scandit.Parser.forContextAndFormat(context, Scandit.ParserDataFormat.SwissQR).then(p => { parser = p; parser.setOptions({minimalVersion: 100}); }); ``` -------------------------------- ### Camera Initialization Source: https://docs.scandit.com/data-capture-sdk/ios/core/api/camera.html Initializes a camera with a specified position and optional settings. This is equivalent to calling init() and then apply() consecutively. ```APIDOC ## init?(position: CameraPosition, settings: CameraSettings?) ### Description Initializes the camera with the given position and settings. This is a convenience method that combines initialization and applying settings. ### Parameters - **position** (CameraPosition) - Required - The initial position of the camera. - **settings** (CameraSettings?) - Optional - The initial camera settings to apply. ``` -------------------------------- ### Enable Symbology Example Source: https://docs.scandit.com/data-capture-sdk/dotnet.android/barcode-capture/api/spark-scan-settings.html Example of how to enable a specific symbology (e.g., Code128) and apply the settings to a SparkScan instance. ```APIDOC ## Enable Symbology ### Description This example demonstrates how to enable [Symbology.Code128](symbology.html#value-scandit.datacapture.barcode.Symbology.Code128 "Symbology.Code128 value") and apply the settings to [SparkScan](spark-scan.html#class-scandit.datacapture.barcode.spark.SparkScan "SparkScan class"). ### Code ```csharp var settings = new SparkScanSettings(); settings.EnableSymbology(Symbology.Code128, enabled: true); sparkScan.ApplySettingsAsync(settings); ``` ``` -------------------------------- ### withSettings Source: https://docs.scandit.com/data-capture-sdk/cordova/core/api/camera.html Creates a Camera instance with the specified settings. This is a static method that returns a Camera instance or null. ```APIDOC ## withSettings ### Description Creates a Camera instance with the specified settings. ### Method `static withSettings(settings: CameraSettings): Camera | null` ### Parameters * **settings** (CameraSettings) - The camera settings to apply. ### Returns * **Camera | null** - The Camera instance with the specified settings, or null if the settings are invalid or not supported. ``` -------------------------------- ### Start Scanning Source: https://docs.scandit.com/data-capture-sdk/flutter/barcode-capture/api/ui/spark-scan-view.html Starts the scanning process. You can call this method if you want to trigger the scanning process without any user interaction. ```dart startScanning() ``` -------------------------------- ### Get Default Camera - Kotlin Source: https://docs.scandit.com/data-capture-sdk/android/core/api/camera.html Extension function to get the default camera instance. Returns a nullable Camera object. ```kotlin fun Camera.getDefaultCamera(): Camera? { return this } ``` -------------------------------- ### Create and Configure LabelCaptureSettings Source: https://docs.scandit.com/data-capture-sdk/android/label-capture/api/label-capture-settings.html Use the LabelCaptureSettings.Builder to fluently configure label definitions and capture settings. This example adds two distinct label definitions before building the settings object. ```kotlin val settings = LabelCaptureSettings.Builder() .addLabel(retailLabel) .addLabel(smartDeviceLabel) .build() ``` -------------------------------- ### GS1 Parsing Example Source: https://docs.scandit.com/data-capture-sdk/react-native/parser/gs1ai.html Parses a GS1 barcode string and outputs structured JSON. This example demonstrates the default parsing behavior. ```text 1719060010SCANDIT123 ``` ```json [ { "name" : "17", "parsed" : { "month" : 6, "year" : 2019 }, "rawString" : "190600" }, { "name" : "10", "parsed" : "SCANDIT123", "rawString" : "SCANDIT123" } ] ``` -------------------------------- ### Camera.create Source: https://docs.scandit.com/data-capture-sdk/capacitor/core/api/camera.html Constructs a new camera instance with optional position, settings, desired torch state, and desired frame source state. If no position is specified, the system attempts to use the default camera. If no settings are provided, default camera settings are applied. ```APIDOC ## Camera.create ### Description Constructs a new camera instance with optional position, settings, desired torch state, and desired frame source state. If no position is specified, the system attempts to use the default camera. If no settings are provided, default camera settings are applied. ### Method static ### Parameters #### Path Parameters - **position** (CameraPosition) - Optional - The desired position of the camera. - **settings** (CameraSettings | null) - Optional - The camera settings to apply. Defaults to null, applying default settings. - **desiredTorchState** (TorchState) - Optional - The desired initial state of the torch. - **desiredState** (FrameSourceState) - Optional - The desired initial state of the frame source. ### Returns - **Camera | null** - The created camera instance if successful, otherwise null. ``` -------------------------------- ### Start SparkScanView Scanning Source: https://docs.scandit.com/data-capture-sdk/dotnet.ios/barcode-capture/api/ui/spark-scan-view.html Starts the barcode scanning process programmatically. Use this if you need to initiate scanning without direct user interaction. ```csharp sparkScanView.StartScanning(); ``` -------------------------------- ### Initialize Singleton DataCaptureContext in Capacitor Source: https://docs.scandit.com/7.6.14/sdks/capacitor/release-notes Initialize the singleton `DataCaptureContext` with a license key. This step is required only once. ```javascript await DataCaptureContext.initialize("YOUR_LICENSE_KEY"); ``` -------------------------------- ### Should Show Scan Area Guides Source: https://docs.scandit.com/data-capture-sdk/ios/label-capture/api/ui/label-capture-basic-overlay.html Controls the display of scan area guides over the camera preview, useful for development and debugging. Defaults to `false`. ```APIDOC ## shouldShowScanAreaGuides ### Description Controls whether scan area guides are displayed over the camera preview. These guides help visualize the active scanning regions during development and debugging. This feature is intended for development purposes only and should not be enabled in production applications. ### Property `open var shouldShowScanAreaGuides: Bool { get, set }` ### Added in version 6.0.0 ### Default Value `false` ``` -------------------------------- ### Initialize HIBC Parser Source: https://docs.scandit.com/data-capture-sdk/flutter/parser/hibc.html Set up the DataCaptureContext, Camera, BarcodeCapture, and HIBC parser. Ensure to replace '-- ENTER YOUR SCANDIT LICENSE KEY HERE --' with your actual license key. Preferred resolution can be set for the camera. ```dart var context = DataCaptureContext.forLicenseKey('-- ENTER YOUR SCANDIT LICENSE KEY HERE --'); var camera = Camera.defaultCamera!; context.setFrameSource(camera); const cameraSettings = CameraSettings(); cameraSettings.preferredResolution = VideoResolution.fullHd; camera.applySettings(cameraSettings); var settings = BarcodeCaptureSettings(); settings.enableSymbology(Symbology.dataMatrix, true); var barcodeCapture = BarcodeCapture.forContext(context, settings); var parser = await Parser.forContextAndFormat(context, ParserDataFormat.hibc); ``` -------------------------------- ### Install Scandit Plugins via npm Source: https://docs.scandit.com/sdks/cordova/add-sdk Add multiple Scandit plugins for various functionalities using npm. You can install only the plugins you need. ```bash cordova plugin add scandit-cordova-datacapture-core cordova plugin add scandit-cordova-datacapture-barcode cordova plugin add scandit-cordova-datacapture-parser cordova plugin add scandit-cordova-datacapture-id ``` -------------------------------- ### EPC Code Example Source: https://docs.scandit.com/data-capture-sdk/android/parser/formats.html This is an example of an Electronic Product Code (EPC) string, a common identification scheme used for RFID-based product identification. ```plaintext 303418705048259E449A941C ``` -------------------------------- ### Get Property Source: https://docs.scandit.com/data-capture-sdk/ios/barcode-capture/api/barcode-selection-settings.html Retrieves the value of a previously set property. Use this method to get values of properties that are not yet part of a stable API. ```APIDOC ## value(forProperty:) ### Description Retrieves the value of a previously set property. Use this method to get values of properties that are not yet part of a stable API. ### Parameters * **property** ([String](https://developer.apple.com/documentation/swift/string "String")) - The name of the property to retrieve. ### Returns `Any`? ``` -------------------------------- ### Install Dependencies Source: https://docs.scandit.com/sdks/flutter/add-sdk After updating `pubspec.yaml`, run this command in your terminal to fetch the added dependencies. ```bash flutter pub get ``` -------------------------------- ### Install Barcode Plugin via npm Source: https://docs.scandit.com/sdks/react-native/add-sdk Adds the barcode scanning functionality plugin to your project using npm. Ensure the core plugin is already installed. ```bash npm install scandit-react-native-datacapture-barcode ``` -------------------------------- ### DataCaptureContext.initialize Source: https://docs.scandit.com/data-capture-sdk/ios/core/api/data-capture-context.html Initializes the singleton context instance with the provided arguments, and returns the same instance. ```APIDOC ## DataCaptureContext.initialize (licenseKey:externalID:deviceName:settings:) ### Description Initializes the singleton context instance with the provided arguments, and returns the same instance. ### Method `open class func initialize(licenseKey: String, externalID: String?, deviceName: String?, settings: DataCaptureContextSettings?) -> Self` ### Parameters #### Path Parameters - **licenseKey** (String) - Description: The license key for the Scandit Data Capture SDK. - **externalID** (String?) - Description: An optional external identifier for the context. - **deviceName** (String?) - Description: An optional device name. - **settings** (DataCaptureContextSettings?) - Description: Optional settings for the data capture context. ``` -------------------------------- ### Create Recommended Camera Settings Source: https://docs.scandit.com/data-capture-sdk/cordova/barcode-capture/api/barcode-selection.html Static method to get the recommended camera settings for barcode selection. ```APIDOC ## Create Recommended Camera Settings ### Description Returns a `CameraSettings` object pre-configured with recommended settings for optimal barcode selection performance. ### Method `static createRecommendedCameraSettings(): CameraSettings` ### Returns - **CameraSettings**: The recommended camera settings. ``` -------------------------------- ### Install Barcode Plugin via Yarn Source: https://docs.scandit.com/sdks/react-native/add-sdk Adds the barcode scanning functionality plugin to your project using Yarn. Ensure the core plugin is already installed. ```bash yarn add scandit-react-native-datacapture-barcode ``` -------------------------------- ### Initialize and Enable Barcode Capture Mode Source: https://docs.scandit.com/data-capture-sdk/ios/core/api/data-capture-mode.html Illustrates the typical steps for configuring, instantiating, and enabling a data capture mode like BarcodeCapture. This includes creating settings, initializing the mode with a context and settings, and optionally enabling it. ```swift DataCaptureContext.initialize(...) let settings = BarcodeCaptureSettings(licenseKey: ...) settings.set(symbology: .qr, enabled: true) let barcodeCapture = BarcodeCapture(context: DataCaptureContext.shared, settings: settings) // Capture modes are enabled by default. The next line is not strictly necessary and // is only listed to make you aware of the possibility to enable/disable modes. barcodeCapture.isEnabled = true ``` -------------------------------- ### Install Core Plugin via npm Source: https://docs.scandit.com/sdks/react-native/add-sdk Installs the required core Scandit plugin using npm. This is a necessary first step before adding other functionality plugins. ```bash npm install scandit-react-native-datacapture-core ``` -------------------------------- ### Install Core Plugin via Yarn Source: https://docs.scandit.com/sdks/react-native/add-sdk Installs the required core Scandit plugin using Yarn. This is a necessary first step before adding other functionality plugins. ```bash yarn add scandit-react-native-datacapture-core ``` -------------------------------- ### Create Recommended Camera Settings Source: https://docs.scandit.com/data-capture-sdk/cordova/barcode-capture/api/barcode-capture.html Obtain the recommended camera settings for optimal barcode scanning performance. This static method should be called before configuring the camera. ```javascript const cameraSettings = Scandit.BarcodeCapture.createRecommendedCameraSettings(); ``` -------------------------------- ### init(labelCapture:view:) Source: https://docs.scandit.com/data-capture-sdk/ios/label-capture/api/ui/label-capture-advanced-overlay.html Constructs a new overlay to visualize the process of label capture. When 'view' is non-nil, the overlay is automatically added to the view. Otherwise, the overlay needs to be added through a call to DataCaptureView.addOverlay(). ```APIDOC ## init(labelCapture:view:) ### Description Constructs a new overlay to visualize the process of label capture. When **view** is non-_nil_, the overlay is automatically added to the view. Otherwise, the overlay needs to be added through a call to [DataCaptureView.addOverlay()](../../../core/api/ui/data-capture-view.html#method-scandit.datacapture.core.ui.DataCaptureView.AddOverlay "DataCaptureView.addOverlay() method"). ### Parameters #### Path Parameters - **labelCapture** (LabelCapture) - Description of the label capture instance. - **view** (DataCaptureView?) - Optional DataCaptureView to which the overlay will be added. ### Added in version 6.16.0 ``` -------------------------------- ### Install Scandit Plugins via GitHub Repo Source: https://docs.scandit.com/sdks/cordova/add-sdk Add multiple Scandit plugins for various functionalities directly from their GitHub repositories. You can install only the plugins you need. ```bash cordova plugin add https://github.com/Scandit/scandit-cordova-datacapture-core.git cordova plugin add https://github.com/Scandit/scandit-cordova-datacapture-barcode.git cordova plugin add https://github.com/Scandit/scandit-cordova-datacapture-parser.git cordova plugin add https://github.com/Scandit/scandit-cordova-datacapture-id.git ``` -------------------------------- ### Create() Source: https://docs.scandit.com/data-capture-sdk/dotnet.android/barcode-capture/api/barcode-capture-settings.html Creates new default settings instance. Recognition is setup for recognizing codes in the full image. Symbologies are all disabled. Before passing the settings to the BarcodeCapture instance, make sure to enable the symbologies required by your application. ```APIDOC ## static BarcodeCaptureSettings Create() ### Description Creates new default settings instance. Recognition is setup for recognizing codes in the full image. Symbologies are all disabled. Before passing the settings to the [BarcodeCapture](barcode-capture.html#class-scandit.datacapture.barcode.BarcodeCapture "BarcodeCapture class") instance, make sure to enable the symbologies required by your application. ```