Data Capture Context Settings

Defined under the namespace Scandit.Datacapture.Core

DataCaptureContextSettings

class DataCaptureContextSettings

Added in version 6.7.0

Holds settings related to the data capture context.

constructor()

constructor()

Added in version 6.7.0

Creates a new settings object with the default values.

getProperty(name)

getProperty(name: string): any

Added in version 6.7.0

Retrieves the value of a previously set property. In case the property does not exist, null is returned.

setProperty(name, value)

setProperty(name: string,
        value: any): void

Added in version 6.7.0

Sets a property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may or may not be used or change in a future release.

frameDataSettings

frameDataSettings: FrameDataSettings

Added in version 7.5.0

Gets or sets the frame data settings for the data capture context. These settings control how frame data is handled, including image quality, file system caching, and automatic rotation.

frameDataSettingsBuilder()

frameDataSettingsBuilder(): FrameDataSettingsBuilder

Added in version 7.5.0

Returns a new FrameDataSettingsBuilder instance configured with the current frame data settings. This provides a fluent interface for modifying frame data settings using the builder pattern.

The following example shows how to configure frame data settings using the builder pattern:

const dataCaptureContextSettings = new DataCaptureContextSettings();
dataCaptureContextSettings.frameDataSettingsBuilder()
  .enableAutoRotate(true)
  .enableFileSystemCache(true)
  .setImageQuality(70);
const dataCaptureContext = DataCaptureContext.forLicenseKeyWithSettings(
  '-- ENTER YOUR SCANDIT LICENSE KEY HERE --',
  dataCaptureContextSettings
);