Classes

The following classes are available globally.

  • The GSKCameraSession class manages the interactions with the device camera.

    See more

    Declaration

    Objective-C

    @interface GSKCameraSession : NSObject

    Swift

    class GSKCameraSession : NSObject

  • The result of the quadrangle detection operation.

    See more

    Declaration

    Objective-C

    @interface GSKQuadrangleDetectionResult : NSObject

    Swift

    class GSKQuadrangleDetectionResult : NSObject
  • GSK

    The SDK class is your entry point to the low-level SDK features.

    See more

    Declaration

    Objective-C

    @interface GSK : NSObject

    Swift

    class GSK : NSObject

  • GSKPDF encapsulate the generation of a PDF document.

    See more

    Declaration

    Objective-C

    @interface GSKPDF : NSObject

    Swift

    class GSKPDF : NSObject

  • A convenience logger that logs everything using NSLog.

    Declaration

    Objective-C

    @interface GSKDefaultLogger : NSObject <GSKLogger>

    Swift

    class GSKDefaultLogger : NSObject, GSKLogger

  • The GSKEditFrameViewController lets the user change a quadrangle.

    The quadrangle is a drawn as an overlay over an image. This typically lets the user edit the edges of a document to crop it more accurately.

    See more

    Declaration

    Objective-C

    @interface GSKEditFrameViewController : UIViewController

    Swift

    class GSKEditFrameViewController : UIViewController

  • An object to control the logging of the Genius Scan SDK.

    See more

    Declaration

    Objective-C

    @interface GSKLog : NSObject

    Swift

    class GSKLog : NSObject

  • Describes the structure of a PDF document for the PDF generator.

    See more

    Declaration

    Objective-C

    @interface GSKPDFDocument : NSObject

    Swift

    class GSKPDFDocument : NSObject

  • Describes a page of a PDF document for the PDF generator.

    See more

    Declaration

    Objective-C

    @interface GSKPDFPage : NSObject

    Swift

    class GSKPDFPage : NSObject

  • Physical size of a PDF page in inches. If the aspect ratio doesn’t match the aspect ratio of the page in pixels, margins will be added on both sides of the page image. If 0 is provided for the width or height, it is computed to match the aspect ratio of the image. Eg, for a receipt, we usually use width = 3.54f and height = 0.

    Declaration

    Objective-C

    @interface GSKPDFSize : NSObject

    Swift

    class GSKPDFSize : NSObject

  • Represents a quadrangular area of the photo, generally the document for which to correct the perspective.

    A quadrangle should always be expressed in the coordinates of the up image

    A normalized quadrangle: corners expressed in fraction of the image dimensions.

    See more

    Declaration

    Objective-C

    @interface GSKQuadrangle : NSObject

    Swift

    class GSKQuadrangle : NSObject

  • The text layout of a scan

    This is part of the output of the OCR recognition, but can also be part of the input of the PDF generation.

    See more

    Declaration

    Objective-C

    @interface GSKTextLayout : NSObject

    Swift

    class GSKTextLayout : NSObject

  • Converts a text layout to its textual representation

    The goal is to properly recreate lines, paragraphs etc.

    See more

    Declaration

    Objective-C

    @interface GSKTextLayoutToTextConverter : NSObject

    Swift

    class GSKTextLayoutToTextConverter : NSObject

OCR

  • The result of an OCR operation.

    See more

    Declaration

    Objective-C

    @interface GSKOCRResult : NSObject

    Swift

    class GSKOCRResult : NSObject

  • The configuration for an OCR operation

    See more

    Declaration

    Objective-C

    @interface GSKOCRConfiguration : NSObject

    Swift

    class GSKOCRConfiguration : NSObject

  • Provides OCR capability for your application.

    Warning

    The SDK must be initialized with [GSK initWithLicenseKey:error:] first.
    See more

    Declaration

    Objective-C

    @interface GSKOCR : NSObject

    Swift

    class GSKOCR : NSObject

  • Enables configuration of the GSKUIScanner scan flow.

    Set the desired configuration on an instance of GSKScannerUIConfiguration and pass it to the initializer of GSKUIScanner to build the desired scan flow.

    See more

    Declaration

    Objective-C

    @interface GSKScannerUIConfiguration : NSObject

    Swift

    class GSKScannerUIConfiguration : NSObject

  • The result of a scan flow

    See more

    Declaration

    Objective-C

    @interface GSKScannerUIResult : NSObject

    Swift

    class GSKScannerUIResult : NSObject

  • A high-level scanner module.

    You present it and when the user is done, you obtain a result object containing the scanned documents.

    The scan flow can be customized with a GSKScannerUIConfiguration.

    See more

    Declaration

    Objective-C

    @interface GSKScannerUI : NSObject

    Swift

    class GSKScannerUI : NSObject

  • An implementation of GSKScanProtocol. It also keeps references to the enhanced image that we generate in our demo scan flow.

    Declaration

    Objective-C

    @interface GSKScannerUIScan : NSObject <GSKScanProtocol>

    Swift

    class GSKScannerUIScan : NSObject, GSKScanProtocol