RGLFunctionality

Objective-C

@interface RGLFunctionality : NSObject

@property(nonatomic, weak, nullable) RGLDocumentReaderBaseCameraViewController *cameraViewController;
/**
 Set this setting to override the default cropping frame on the camera view controller provided by scenarios. Default: RGLDocReaderFrameScenarioDefault.
 */
@property(nonatomic, assign) RGLDocReaderFrame cameraFrame;
/**
 If set, torch (if available) will turn on immediately on camera preview start. Default: false.
 */
@property(nonatomic, assign) BOOL torchTurnedOn;
/**
 If it's set to true, the button that allows you to turn on/off the torch will be displayed. Default: true.
 */
@property(nonatomic, assign) BOOL showTorchButton;
/**
 If it's set to true, the button that allows you to close the camera view controller will be displayed. Default: true.
 */
@property(nonatomic, assign) BOOL showCloseButton;
/**
 If it's set to true, the button that allows you to take a picture and process it as a single frame will be displayed. Default: false.
 */
@property(nonatomic, assign) BOOL showCaptureButton;
/**
 If it's set to true, the button that allows you to change the camera frame type will be displayed. Default: false.
 */
@property(nonatomic, assign) BOOL showChangeFrameButton RGL_DEPRECATED(8.1, "showChangeFrameButton param removed");
/**
 If it's set to true, the button that allows you to change a position of a capture device for the video session will be displayed. Default: false.
 */
@property(nonatomic, assign) BOOL showCameraSwitchButton;
/**
 If it's set to true, the button that allows you to skip processing of the next page of a document will be displayed. Default: true.
 */
@property(nonatomic, assign) BOOL showSkipNextPageButton;
/**
 If it's set to true, camera frames won't be taken for recognition while a camera is focusing. Default: true.
 */
@property(nonatomic, assign) BOOL skipFocusingFrames;
/**
 Allows you to specify the frame resolution.
 */
@property(nonatomic, strong, nullable) AVCaptureSessionPreset videoSessionPreset;
/**
 If it's set to true, camera frames won't be taken for recognition while a device is moving based on motion sensors. Default: true.
 */
@property(nonatomic, assign) BOOL videoCaptureMotionControl;
/**
 Allows you to specify an orientation of the camera view controller. Default: UIInterfaceOrientationMaskAllButUpsideDown.
 */
@property(nonatomic, assign) UIInterfaceOrientationMask orientation;
/**
 If it's set to true, once the scanning process is finished, the camera view controller will be dismissed. Default: true.
 */
@property(nonatomic, assign) BOOL singleResult;
/**
 Allows you to specify a position of a capture device for the video session. Default: AVCaptureDevicePositionUnspecified.
 */
@property(nonatomic, assign) AVCaptureDevicePosition cameraPosition;
/**
 Allows you to specify a name of a Regula device that will be used with Document Reader SDK.
 */
@property(nonatomic, strong, nullable) NSString *btDeviceName RGL_DEPRECATED(6.2, "Use `RGLBluetooth` to control device connection instead.");
/**
 If it's set to true, allows you to connect to the external Regula Bluetooth devices like Regula 1120 and others.
 */
@property(nonatomic, assign, getter=isUseAuthenticator) BOOL useAuthenticator;
/**
 Allows you to specify a time interval when the Capture button has to be displayed after the document is detected. Don't forget to set the "showCaptureButton" to true, otherwise, it won't be displayed. Default: 5.
 */
@property(nonatomic, assign) NSTimeInterval showCaptureButtonDelayFromDetect;
/**
 Allows you to specify a time interval when the Capture button has to be displayed after the scanning process is started. Don't forget to set the "showCaptureButton" to true, otherwise, it won't be displayed. Default: 10.
 */
@property(nonatomic, assign) NSTimeInterval showCaptureButtonDelayFromStart;
/**
 Allows you to specify the video processing mode. Default: RGLCaptureModeAuto.
 */
@property(nonatomic, assign) RGLCaptureMode captureMode;
/**
 If it's set to true, the metadata will be displayed over the camera preview during document processing, namely the perspective angle value. Default: false.
 */
@property(nonatomic, assign) BOOL showMetadataInfo;
/**
 If it's set to true, allows you to adjust a zoom level using the pinch gesture (its range is from 1x to 10x). Default: false.
 */
@property(nonatomic, assign) BOOL isZoomEnabled;
/**
 Allows you to set the desired zoom level (its range from 1x to 10x). Default: 1.0.
 */
@property(nonatomic, assign) CGFloat zoomFactor;
@property(nonatomic, assign) BOOL recordScanningProcess;
@property(nonatomic, weak, nullable) id<RGLRecordScanningProcessDelegate> recordScanningProcessDelegate;
/**
 If it's set to true, scanner operate in manual multipage scanning mode. Set this flag to true, if you wanna create for example, custom logic (or UI) between scanning document pages. Default: false.
 */
@property(nonatomic, assign) BOOL manualMultipageMode;

/**
 Sets a limit on the number of pages to be processed
 */
@property(nonatomic, strong, nullable) NSNumber *forcePagesCount;


@property(nonatomic, strong, nullable) RGLOnlineProcessingConfig *onlineProcessingConfig;

@property(nonatomic, strong, nullable) RGLRecordingTimestampConfig *recordingTimestampConfig;

/**
 The settings used for encoding the media appended to the output. See AVVideoSettings.h for AVMediaTypeVideo for more information on how to construct an output settings dictionary.
 */
@property(nonatomic, strong, nullable) NSDictionary<NSString *, id> *videoOutputSettings;

@end

Swift

class Functionality : NSObject

Undocumented

  • Undocumented

    Declaration

    Objective-C

    @property(nonatomic, weak, nullable) RGLDocumentReaderBaseCameraViewController *cameraViewController

    Swift

    weak var cameraViewController: RGLDocumentReaderBaseCameraViewController? { get set }

  • Set this setting to override the default cropping frame on the camera view controller provided by scenarios. Default: RGLDocReaderFrameScenarioDefault.

    Declaration

    Objective-C

    @property (nonatomic) RGLDocReaderFrame cameraFrame;

    Swift

    var cameraFrame: DocReaderFrame { get set }

  • If set, torch (if available) will turn on immediately on camera preview start. Default: false.

    Declaration

    Objective-C

    @property (nonatomic) BOOL torchTurnedOn;

    Swift

    var torchTurnedOn: Bool { get set }

  • If it’s set to true, the button that allows you to turn on/off the torch will be displayed. Default: true.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showTorchButton;

    Swift

    var showTorchButton: Bool { get set }

  • If it’s set to true, the button that allows you to close the camera view controller will be displayed. Default: true.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showCloseButton;

    Swift

    var showCloseButton: Bool { get set }

  • If it’s set to true, the button that allows you to take a picture and process it as a single frame will be displayed. Default: false.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showCaptureButton;

    Swift

    var showCaptureButton: Bool { get set }

  • Deprecated

    Deprecated in DocumentReader 8.1. showChangeFrameButton param removed

    If it’s set to true, the button that allows you to change the camera frame type will be displayed. Default: false.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showChangeFrameButton;

    Swift

    var showChangeFrameButton: Bool { get set }

  • If it’s set to true, the button that allows you to change a position of a capture device for the video session will be displayed. Default: false.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showCameraSwitchButton;

    Swift

    var showCameraSwitchButton: Bool { get set }

  • If it’s set to true, the button that allows you to skip processing of the next page of a document will be displayed. Default: true.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showSkipNextPageButton;

    Swift

    var showSkipNextPageButton: Bool { get set }

  • If it’s set to true, camera frames won’t be taken for recognition while a camera is focusing. Default: true.

    Declaration

    Objective-C

    @property (nonatomic) BOOL skipFocusingFrames;

    Swift

    var skipFocusingFrames: Bool { get set }

  • Allows you to specify the frame resolution.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) AVCaptureSessionPreset videoSessionPreset;

    Swift

    var videoSessionPreset: AVCaptureSession.Preset? { get set }

  • If it’s set to true, camera frames won’t be taken for recognition while a device is moving based on motion sensors. Default: true.

    Declaration

    Objective-C

    @property (nonatomic) BOOL videoCaptureMotionControl;

    Swift

    var videoCaptureMotionControl: Bool { get set }

  • Allows you to specify an orientation of the camera view controller. Default: UIInterfaceOrientationMaskAllButUpsideDown.

    Declaration

    Objective-C

    @property (nonatomic) UIInterfaceOrientationMask orientation;

    Swift

    var orientation: UIInterfaceOrientationMask { get set }

  • If it’s set to true, once the scanning process is finished, the camera view controller will be dismissed. Default: true.

    Declaration

    Objective-C

    @property (nonatomic) BOOL singleResult;

    Swift

    var singleResult: Bool { get set }

  • Allows you to specify a position of a capture device for the video session. Default: AVCaptureDevicePositionUnspecified.

    Declaration

    Objective-C

    @property (nonatomic) AVCaptureDevicePosition cameraPosition;

    Swift

    var cameraPosition: AVCaptureDevice.Position { get set }

  • Deprecated

    Deprecated in DocumentReader 6.2. Use RGLBluetooth to control device connection instead.

    Allows you to specify a name of a Regula device that will be used with Document Reader SDK.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *btDeviceName;

    Swift

    var btDeviceName: String? { get set }

  • If it’s set to true, allows you to connect to the external Regula Bluetooth devices like Regula 1120 and others.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isUseAuthenticator) BOOL useAuthenticator;

    Swift

    var isUseAuthenticator: Bool { get set }

  • Allows you to specify a time interval when the Capture button has to be displayed after the document is detected. Don’t forget to set the “showCaptureButton” to true, otherwise, it won’t be displayed. Default: 5.

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval showCaptureButtonDelayFromDetect;

    Swift

    var showCaptureButtonDelayFromDetect: TimeInterval { get set }

  • Allows you to specify a time interval when the Capture button has to be displayed after the scanning process is started. Don’t forget to set the “showCaptureButton” to true, otherwise, it won’t be displayed. Default: 10.

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval showCaptureButtonDelayFromStart;

    Swift

    var showCaptureButtonDelayFromStart: TimeInterval { get set }

  • Allows you to specify the video processing mode. Default: RGLCaptureModeAuto.

    Declaration

    Objective-C

    @property (nonatomic) RGLCaptureMode captureMode;

    Swift

    var captureMode: CaptureMode { get set }

  • If it’s set to true, the metadata will be displayed over the camera preview during document processing, namely the perspective angle value. Default: false.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showMetadataInfo;

    Swift

    var showMetadataInfo: Bool { get set }

  • If it’s set to true, allows you to adjust a zoom level using the pinch gesture (its range is from 1x to 10x). Default: false.

    Declaration

    Objective-C

    @property (nonatomic) BOOL isZoomEnabled;

    Swift

    var isZoomEnabled: Bool { get set }

  • Allows you to set the desired zoom level (its range from 1x to 10x). Default: 1.0.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat zoomFactor;

    Swift

    var zoomFactor: CGFloat { get set }

  • Undocumented

    Declaration

    Objective-C

    @property(nonatomic, assign) BOOL recordScanningProcess

    Swift

    var recordScanningProcess: Bool { get set }

  • Undocumented

    Declaration

    Objective-C

    @property(nonatomic, weak, nullable) id<RGLRecordScanningProcessDelegate> recordScanningProcessDelegate

    Swift

    weak var recordScanningProcessDelegate: RecordScanningProcessDelegate? { get set }

  • If it’s set to true, scanner operate in manual multipage scanning mode. Set this flag to true, if you wanna create for example, custom logic (or UI) between scanning document pages. Default: false.

    Declaration

    Objective-C

    @property (nonatomic) BOOL manualMultipageMode;

    Swift

    var manualMultipageMode: Bool { get set }

  • Sets a limit on the number of pages to be processed

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSNumber *forcePagesCount;

    Swift

    var forcePagesCount: NSNumber? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property(nonatomic, strong, nullable) RGLOnlineProcessingConfig *onlineProcessingConfig

  • Undocumented

    Declaration

    Objective-C

    @property(nonatomic, strong, nullable) RGLRecordingTimestampConfig *recordingTimestampConfig

    Swift

    var recordingTimestampConfig: RGLRecordingTimestampConfig? { get set }

  • The settings used for encoding the media appended to the output. See AVVideoSettings.h for AVMediaTypeVideo for more information on how to construct an output settings dictionary.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDictionary<NSString *, id> *videoOutputSettings;

    Swift

    var videoOutputSettings: [String : Any]? { get set }