Classes
The following classes are available globally.
-
The output configuration for a camera session.
See moreDeclaration
Objective-C
@interface GSKCameraSessionConfiguration : NSObject
Swift
class GSKCameraSessionConfiguration : NSObject
-
The GSKCameraSession class manages the interactions with the device camera.
See moreDeclaration
Objective-C
@interface GSKCameraSession : NSObject
Swift
class GSKCameraSession : NSObject
-
A GSKCameraViewController is a ready-to-use camera interface for scanning documents.
See moreDeclaration
Objective-C
@interface GSKCameraViewController : UIViewController <GSKCameraSessionDelegate>
Swift
class GSKCameraViewController : UIViewController, GSKCameraSessionDelegate
-
Entry point of the SDK. Use this to initialize the SDK with your license key.
See moreDeclaration
Objective-C
@interface GSK : NSObject
Swift
class GSK : NSObject
-
GSKPDF encapsulate the generation of a PDF document.
See moreDeclaration
Objective-C
@interface GSKPDF : NSObject
Swift
class GSKPDF : NSObject
-
The result of the quadrangle detection operation.
See moreDeclaration
Objective-C
@interface GSKDocumentDetectionResult : NSObject
Swift
class GSKDocumentDetectionResult : NSObject
-
- Performance: A document detector can be expensive to create: it’s recommended to keep a reference to it if it’s needed several times in a row.
Declaration
Objective-C
@interface GSKDocumentDetector : NSObject
Swift
class GSKDocumentDetector : NSObject
-
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 moreDeclaration
Objective-C
@interface GSKEditFrameViewController : UIViewController
Swift
class GSKEditFrameViewController : UIViewController
-
An object to control the logging of the Genius Scan SDK.
See moreDeclaration
Objective-C
@interface GSKLog : NSObject
Swift
class GSKLog : NSObject
-
Describes the structure of a PDF document for the PDF generator.
See moreDeclaration
Objective-C
@interface GSKPDFDocument : NSObject
Swift
class GSKPDFDocument : NSObject
-
Describes a page of a PDF document for the PDF generator.
See moreDeclaration
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
imageA normalized quadrangle: corners expressed in fraction of the image dimensions. Each coordinate will be a floating point between 0 and 1.
See moreDeclaration
Objective-C
@interface GSKQuadrangle : NSObject
Swift
class GSKQuadrangle : NSObject
-
A scan, the result of the camera output. It encapsulates a simple file path as well as additional information on the capture.
See moreDeclaration
Objective-C
@interface GSKScan : NSObject
Swift
class GSKScan : NSObject
-
A GSKCurvatureCorrectionConfiguration defines the behavior of a GSKScanProcessor when applying curvature correction.
See moreDeclaration
Objective-C
@interface GSKCurvatureCorrectionConfiguration : NSObject
Swift
class GSKCurvatureCorrectionConfiguration : NSObject
-
A GSKPerspectiveCorrectionConfiguration defines the behavior of a GSKScanProcessor when applying perspective correction.
See moreDeclaration
Objective-C
@interface GSKPerspectiveCorrectionConfiguration : NSObject
Swift
class GSKPerspectiveCorrectionConfiguration : NSObject
-
A GSKEnhancementConfiguration defines the behavior of a GSKScanProcessor when applying legibility enhancements.
See moreDeclaration
Objective-C
@interface GSKEnhancementConfiguration : NSObject
Swift
class GSKEnhancementConfiguration : NSObject
-
A GSKRotationConfiguration defines the behavior of a GSKScanProcessor when rotating the processed image.
Declaration
Objective-C
@interface GSKRotationConfiguration : NSObject
Swift
class GSKRotationConfiguration : NSObject
-
A GSKResizeConfiguration defines the behavior of a GSKScanProcessor when resizing the processed image.
Declaration
Objective-C
@interface GSKResizeConfiguration : NSObject
Swift
class GSKResizeConfiguration : NSObject
-
A configuration that defines the output of the processing.
See moreDeclaration
Objective-C
@interface GSKOutputConfiguration : NSObject
Swift
class GSKOutputConfiguration : NSObject
-
The result of a resizing operation
Declaration
Objective-C
@interface GSKResizeResult : NSObject
Swift
class GSKResizeResult : NSObject
-
The configuration object to configure the GSKProcessor’s behavior.
You can use the default constructors.
See moreDeclaration
Objective-C
@interface GSKProcessingConfiguration : NSObject
Swift
class GSKProcessingConfiguration : NSObject
-
The document processor is the central class of the GSSDK’s image processing algorithms.
With the document processor, you can correct the distortion in your documents, as well as improve their legibility. If you are only interested in the detecting a document in an image, please refer to GSKDocumentDetector.
See moreDeclaration
Objective-C
@interface GSKScanProcessor : NSObject
Swift
class GSKScanProcessor : 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 moreDeclaration
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 moreDeclaration
Objective-C
@interface GSKTextLayoutToTextConverter : NSObject
Swift
class GSKTextLayoutToTextConverter : NSObject
-
The result of an OCR operation.
See moreDeclaration
Objective-C
@interface GSKOCRResult : NSObject
Swift
class GSKOCRResult : NSObject
-
The configuration for an OCR operation
See moreDeclaration
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.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 GSKScanFlowConfiguration and pass it to the initializer of GSKUIScanner to build the desired scan flow.
See moreDeclaration
Objective-C
@interface GSKScanFlowConfiguration : NSObject
Swift
class GSKScanFlowConfiguration : NSObject
-
The result of a scan flow
See moreDeclaration
Objective-C
@interface GSKScanFlowResult : NSObject
Swift
class GSKScanFlowResult : 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 GSKScanFlowConfiguration.
See moreDeclaration
Objective-C
@interface GSKScanFlow : NSObject
Swift
class GSKScanFlow : NSObject
-
The output result from the scan flow.
See moreDeclaration
Objective-C
@interface GSKScanFlowScan : NSObject
Swift
class GSKScanFlowScan : NSObject