RGLConfig


@interface RGLConfig : NSObject

DocumentReader configuration object. Controls initialization time properties such as License and Database filepath.

  • The license binary file loaded as Data.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSData *licenseData;
  • Enables automatic license update check during DocumentReader initialization. Defaults to true.

    Declaration

    Objective-C

    @property (nonatomic) BOOL licenseUpdateCheck;
  • The path to the database file.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *databasePath;
  • Defines whether the DocumentReader delays loading of neural networks. Defaults to false.

    When set to true the initialization starts in the background thread after a completion block passed to the method -[RGLDocReader initializeReaderWithConfig:completion:] is called. If the document processing is initiated before all the networks are loaded, the DocuentReader will wait for it before starting the handling.

    When set to false the initialization is performed during DocumentReader initialization -[RGLDocReader initializeReaderWithConfig:completion:] method.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
              getter=isDelayedNNLoadEnabled) BOOL delayedNNLoadEnabled;
  • Unavailable

    Not the designated initializer.

    Undocumented

    Declaration

    Objective-C

    RGL_EMPTY_INIT_UNAVAILABLE
  • Unavailable

    Not the designated initializer.

    Undocumented

    Declaration

    Objective-C

    RGL_EMPTY_INIT_UNAVAILABLE
  • Creates configuration object for DocumentReader.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLicenseData:(nonnull NSData *)licenseData;

    Parameters

    licenseData

    The license binary file loaded as Data.

  • Creates configuration object for DocumentReader.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLicenseData:(nonnull NSData *)licenseData
                             licenseUpdateCheck:(BOOL)licenseUpdateCheck
                                   databasePath:(nullable NSString *)databasePath
                           delayedNNLoadEnabled:(BOOL)delayedNNLoadEnabled;

    Parameters

    licenseData

    The license binary file loaded as Data.

    licenseUpdateCheck

    Enables automatic license update check during DocumentReader initialization.

    databasePath

    The path to the database file.

  • Creates configuration object for DocumentReader.

    Declaration

    Objective-C

    + (nonnull instancetype)configWithLicenseData:(nonnull NSData *)licenseData;

    Parameters

    licenseData

    The license binary file loaded as Data.

  • Creates configuration object for DocumentReader.

    Declaration

    Objective-C

    + (nonnull instancetype)configWithLicenseData:(nonnull NSData *)licenseData
                               licenseUpdateCheck:(BOOL)licenseUpdateCheck
                                     databasePath:(nullable NSString *)databasePath
                             delayedNNLoadEnabled:(BOOL)delayedNNLoadEnabled;

    Parameters

    licenseData

    The license binary file loaded as `Data

    licenseUpdateCheck

    Enables automatic license update check during DocumentReader initialization.

    databasePath

    The path to the database file.