Classes

Objective-C

@interface GSKCameraSessionConfiguration : NSObject

Swift

class GSKCameraSessionConfiguration : NSObject

Objective-C

@interface GSKCameraSession : NSObject

Swift

class GSKCameraSession : NSObject

Objective-C

@interface GSKCameraViewController : UIViewController <GSKCameraSessionDelegate>

Swift

class GSKCameraViewController : UIViewController, GSKCameraSessionDelegate

Objective-C

@interface GSK : NSObject

Swift

class GSK : NSObject

Objective-C

@interface GSKPDF : NSObject

Swift

class GSKPDF : NSObject

Objective-C

@interface GSKTIFF : NSObject

Swift

class GSKTIFF : NSObject

Objective-C

@interface GSKDefaultLogger : NSObject <GSKLogger>

Swift

class GSKDefaultLogger : NSObject, GSKLogger

Objective-C

@interface GSKDocumentDetectorConfiguration: NSObject

+ (instancetype)defaultConfiguration;

/**
 A configuration that favors speed over precision.
 */
+ (instancetype)fastConfiguration;

/**
 A configuration that favors precision over speed.
 */
+ (instancetype)highPrecisionConfiguration;

@end

Swift

class GSKDocumentDetectorConfiguration : NSObject

Objective-C

@interface GSKDocumentDetectionResult : NSObject

Swift

class GSKDocumentDetectionResult : NSObject

Objective-C

@interface GSKDocumentDetector : NSObject

Swift

class GSKDocumentDetector : NSObject

Objective-C

@interface GSKEditFrameView : UIView

Swift

class GSKEditFrameView : UIView

Objective-C

@interface GSKEditFrameViewController : UIViewController

Swift

class GSKEditFrameViewController : UIViewController

Objective-C

@interface GSKEditableFrame : UIView

@property (nonatomic, strong) GSKQuadrangle *quadrangle;

@property (nonatomic, weak, nullable) id <GSKEditableFrameDelegate> delegate;

/**
 The color of the area outside of the quadrangle.
 */
@property (nonatomic, copy) UIColor *outsideShadeColor;

/**
 The color of the area inside of the quadrangle.
 */
@property (nonatomic, copy) UIColor *insideShadeColor;

/**
 The color of the area inside of the quadrangle.
 */
@property (nonatomic, copy) UIColor *shadeColor DEPRECATED_MSG_ATTRIBUTE("Deprecated in favor of `insideShadeColor`.");

/**
 The color of the edges and grid lines.
 */
@property (nonatomic, copy) UIColor *lineColor;

/**
 The width of the handle that signify that corners can be dragged.

 Default: 5
 */
@property (nonatomic, assign) CGFloat handleWidth;
@property (nonatomic, assign) BOOL noCrop;

@end

Swift

class GSKEditableFrame : UIView

Objective-C

@interface GSKLog : NSObject

Swift

class GSKLog : NSObject

Objective-C

@interface GSKMagnifierView : UIView

/**
 The style of the crosshair
 */
@property (nonatomic, assign) GSKMagnifierViewCenterStyle centerStyle;

/**
 Default line width for the crosshair.
 */
@property (nonatomic, assign) CGFloat crosshairLineWidth;

/**
 Default line width for the quadrangle.
 */
@property (nonatomic, assign) CGFloat quadrangleLineWidth;


/**
 The color of the quadrangle crosshair.

 This only applies when the crosshair is of style GSKMagnifierCrosshairStyleQuadrangle.
 */
@property (nonatomic, copy) UIColor *quadrangleColor;

- (void)setSourceImage:(UIImage *)sourceImage;
- (void)setSourceImagePosition:(CGPoint)position quadrangle:(GSKQuadrangle *)quadrangle;

@end

Swift

class GSKMagnifierView : UIView

Objective-C

@interface GSKPDFDocument : NSObject

Swift

class GSKPDFDocument : NSObject

Objective-C

@interface GSKPDFGeneratorConfiguration : NSObject

Swift

class GSKPDFGeneratorConfiguration : NSObject

Objective-C

@interface GSKPDFNoopImageProcessor : NSObject <GSKPDFImageProcessor>

@end

Swift

class GSKPDFNoopImageProcessor : NSObject, GSKPDFImageProcessor

Objective-C

@interface GSKPDFPage : NSObject

Swift

class GSKPDFPage : NSObject

Objective-C

@interface GSKPDFSize : NSObject

Swift

class GSKPDFSize : NSObject

Objective-C

@interface GSKQuadrangle : NSObject

Swift

class GSKQuadrangle : NSObject

Objective-C

@interface GSKScan : NSObject

Swift

class GSKScan : NSObject

Objective-C

@interface GSKCurvatureCorrectionConfiguration : NSObject

Swift

class GSKCurvatureCorrectionConfiguration : NSObject

Objective-C

@interface GSKPerspectiveCorrectionConfiguration : NSObject

Swift

class GSKPerspectiveCorrectionConfiguration : NSObject

Objective-C

@interface GSKEnhancementConfiguration : NSObject

Swift

class GSKEnhancementConfiguration : NSObject

Objective-C

@interface GSKRotationConfiguration : NSObject

Swift

class GSKRotationConfiguration : NSObject

Objective-C

@interface GSKResizeConfiguration : NSObject

Swift

class GSKResizeConfiguration : NSObject

Objective-C

@interface GSKOutputConfiguration : NSObject

Swift

class GSKOutputConfiguration : NSObject

Objective-C

@interface GSKProcessingResult: NSObject
/// The output file.
/// It's located in the temporary directory, so you need to move it to a permanent destination.
@property (nonatomic, readonly) NSString *processedImagePath;

/// The quadrangle that was used for perspective correction
@property (nonatomic, strong, readonly) GSKQuadrangle *appliedQuadrangle;

/// The filter that was applied during the enhancement phase
@property (nonatomic, assign, readonly) GSKFilterType appliedFilter;

/**
 The rotation applied during the rotation phase.

 If you specified a rotation angle as part of GSKRotationConfiguration, you will get this angle back here.
 If you requested an automatic orientation detection as part of the GSKRotationConfiguration, appliedRotation will correspond the rotation applied by the SDK
 to rotate the image according to the estimated orientation.

 Note: The output of the processing is always an up-oriented image, even if the original image had an EXIF orientation (see UIImage's imageOrientation property).
 `appliedRotation` doesn't include the rotation applied to the image buffer to remove the EXIF information. The `appliedRotation` only includes the "visual" rotation
 needed to display the image to the user:

 - If the input image imageOrientation is UIImageOrientationUp, and you request a clockwise rotation, appliedRotation will be GSKRotationClockwise.
 - If the input image imageOrientation is UIImageOrientationUp, and you request an automatic rotation, which detects that the image must be rotated clockwise to
  look "straight", appliedRotation will be GSKRotationClockwise.
 - If the input image imageOrientation is UIImageOrientationRight, and you request a clockwise rotation, appliedRotation will be GSKRotationClockwise. The output
  image orientation will be UIImageOrientationUp.
 - If the input image imageOrientation is UIImageOrientationUp, and you request an automatic rotation, which detects that the image must be rotated clockwise to
  look "straight", appliedRotation will be GSKRotationClockwise. The output image orientation will be UIImageOrientationUp.
 */
@property (nonatomic, assign, readonly) GSKRotation appliedRotation;

@end

Swift

class GSKProcessingResult : NSObject

Objective-C

@interface GSKResizeResult : NSObject

Swift

class GSKResizeResult : NSObject

Objective-C

@interface GSKProcessingConfiguration : NSObject

Swift

class GSKProcessingConfiguration : NSObject

Objective-C

@interface GSKScanProcessor : NSObject

Swift

class GSKScanProcessor : NSObject

Objective-C

@interface GSKShutterView : UIView

Swift

class GSKShutterView : UIView

Objective-C

@interface GSKTextLayout : NSObject

Swift

class GSKTextLayout : NSObject

Objective-C

@interface GSKTextLayoutToTextConverter : NSObject

Swift

class GSKTextLayoutToTextConverter : NSObject

Objective-C

@interface GSKTextLayoutToTextConverterResult : NSObject
- (nonnull instancetype)initWithStatus:(GSKTextLayoutToTextConverterStatus)status
                                  text:(nonnull NSString *)text
                 averageWordConfidence:(int32_t)averageWordConfidence
                             wordCount:(int32_t)wordCount;
+ (nonnull instancetype)textLayoutToTextConverterResultWithStatus:(GSKTextLayoutToTextConverterStatus)status
                                                             text:(nonnull NSString *)text
                                            averageWordConfidence:(int32_t)averageWordConfidence
                                                        wordCount:(int32_t)wordCount;

/** The status of the conversion. If failure, the other values in the result must not be used. */
@property (nonatomic, readonly) GSKTextLayoutToTextConverterStatus status;

/** The text reconstructed from the text layout. */
@property (nonatomic, readonly, nonnull) NSString * text;

/**
 * The average word confidence of the recognized text.
 * A value between 0 and 100
 */
@property (nonatomic, readonly) int32_t averageWordConfidence;

/**
 * The number of words in the recognized text.
 * This is the number of words on which the average word confidence has been computed.
 */
@property (nonatomic, readonly) int32_t wordCount;

@end

Swift

class GSKTextLayoutToTextConverterResult : NSObject

Objective-C

@interface GSKTriggerDecider : NSObject

Swift

class GSKTriggerDecider : NSObject

Objective-C

@interface GSKView : UIView

// Handle interface orientation change
- (void)initializeRotationWithInterfaceOrientation:(UIInterfaceOrientation)orientation;
- (void)rotateWithCoordinator:(id<UIViewControllerTransitionCoordinator>)coordinator;

// Displays the focus indicator at the requested location
- (void)animateFocusAtLocation:(CGPoint)location;

/// Updates the quadrangle overlay. Removes the quadrangle if @param quadrangle is nil.
- (void)updateQuadrangle:(GSKQuadrangle *)quadrangle;

- (void)setCaptureSession:(AVCaptureSession *)session;

/**
 Freeze the capture preview. This is very fast as this doesn't interrupt the camera session.
 */
- (void)pausePreview;

/**
 Resumes the capture preview.
 */
- (void)resumePreview;

@property (nonatomic, readonly) UIView *previewView;

/**
 The document frame layer
 */
@property (nonatomic, readonly) CAShapeLayer *frameLayer;
@property (nonatomic, readonly) CAShapeLayer *snapFrameLayer;

@property (nonatomic, copy) UIColor *overlayColor;

@property (nonatomic, weak) id <GSCViewDelegate> delegate;

@end

Swift

class GSKView : UIView

Objective-C

@interface GSKOCRResult : NSObject

Swift

class GSKOCRResult : NSObject

Objective-C

@interface GSKOCRConfiguration : NSObject

Swift

class GSKOCRConfiguration : NSObject

Objective-C

@interface GSKOCR : NSObject

Swift

class GSKOCR : NSObject

Objective-C

@interface GSKScanFlowOCRConfiguration : NSObject

Swift

class GSKScanFlowOCRConfiguration : NSObject

Objective-C

@interface GSKScanFlowConfiguration : NSObject

Swift

class GSKScanFlowConfiguration : NSObject

Objective-C

@interface GSKScanFlowOCRResult : NSObject

Swift

class GSKScanFlowOCRResult : NSObject

Objective-C

@interface GSKScanFlowScan : NSObject

Swift

class GSKScanFlowScan : NSObject

Objective-C

@interface GSKScanFlowResult : NSObject

Swift

class GSKScanFlowResult : NSObject

Objective-C

@interface GSKScanFlow : NSObject

Swift

class GSKScanFlow : NSObject

Objective-C

@interface GSKScanFlowScanInternal : NSObject

Swift

class GSKScanFlowScanInternal : NSObject