Frame Data Settings

Defined in library scandit_datacapture_core

FrameDataSettings
class FrameDataSettings

Added in version 7.5.0

This class can be used to configure frame retrieval through file system caching. Users can enable or disable caching, specify the quality of the image to use when compressing frames into JPEG/PNG format, and configure automatic rotation in case the image isn’t following the rotation of the phone. The defaults are chosen to provide a good balance between performance and quality for most use cases.

FrameDataSettings()
 FrameDataSettings()

Added in version 7.5.0

Creates new default frame settings. isFileSystemCacheEnabled is set to false, imageQuality is set to 100, and isAutoRotateEnabled is set to false.

isFileSystemCacheEnabled
bool isFileSystemCacheEnabled

Added in version 7.5.0

Enables or disables the file system cache for frames. When enabled, processed frames are cached to the file system for improved performance.

The default value is false.

imageQuality
int imageQuality

Added in version 7.5.0

Sets the quality of the saved frame images. Higher values produce better quality images but larger file sizes. Valid range is 0-100.

  • 0: Lowest quality, smallest file size

  • 100: Highest quality, largest file size

The default value is 100. Throws an Error if the value is not between 0 and 100.

isAutoRotateEnabled
bool isAutoRotateEnabled

Added in version 7.5.0

Enables or disables automatic rotation of frames.

The default value is false.