react-native-scanbot-barcode-scanner-sdk
Version:
Scanbot Barcode Scanner SDK React Native Plugin for Android and iOS
74 lines (68 loc) • 2.36 kB
TypeScript
import { DeepPartial } from '../core/utils/utils';
/**
Initialize configuration for the Scanbot SDK.
*/
export declare class SdkConfiguration {
/**
Your license key for the Scanbot SDK. See the "License Key" section below.
*/
licenseKey: string;
/**
Optional boolean flag to enable logging. See the "Logging" section below.
Default is false
*/
loggingEnabled: boolean;
/**
Optional boolean flag that enables Scanbot SDK Core native logging (default is false, Android only).
Default is false
*/
enableNativeLogging: boolean;
/**
Optional directory as file URI to override the default storage base directory of the Scanbot SDK. Refer to the section "Storage" for more details.
*/
storageBaseDirectory: string | null;
/**
Optional file encryption mode, 'AES128' or 'AES256'.
*/
fileEncryptionMode: FileEncryptionMode | null;
/**
Optional file encryption password. Refer to the section "Storage Encryption" for more details.
*/
fileEncryptionPassword: string | null;
/**
If set to `true`, PerformanceHintApi is enabled, which lead to increase of performance due of increased use of top CPU cores (Android only), also increase battery usage.
Default is true
*/
performanceHintApi: boolean;
/**
If set to `true`, GPU Acceleration will be enabled for Barcode Scanner, Document Scanner and Generic Document Recognizer (Android only).
Default is true
*/
allowGpuAcceleration: boolean;
/**
Enables/disables XNNPACK acceleration for TensorFlow ML models, which provides highly optimized implementations of floating-point neural network operators (Android only).
Default is true
*/
allowXnnpackAcceleration: boolean;
/** @param source {@displayType `DeepPartial<SdkConfiguration>`} */
constructor(source?: DeepPartial<SdkConfiguration>);
}
/**
File encryption mode.
- `AES128`:
AES 128-bit encryption.
- `AES256`:
AES 256-bit encryption.
*/
export type FileEncryptionMode =
/**
AES 128-bit encryption.
*/
'AES128'
/**
AES 256-bit encryption.
*/
| 'AES256';
/** @hidden */
export declare const FileEncryptionModeValues: ReadonlyArray<FileEncryptionMode>;
//# sourceMappingURL=SdkConfiguration.d.ts.map