GSKScanFlowScan

@interface GSKScanFlowScan : NSObject

The output result from the scan flow.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithOriginalFilePath:(NSString *)originalFilePath;

    Swift

    init!(originalFilePath: String!)

  • The original JPEG out of the camera.

    Note that this image might be rotated, and needs to be read with its EXIF orientation to be properly displayed. UIImage’s methods will properly take care of that.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *originalFilePath;

    Swift

    var originalFilePath: String! { get }

  • The enhanced, processed, image.

    Declaration

    Objective-C

    @property (nonatomic, strong, readwrite) NSString *enhancedFilePath;

    Swift

    var enhancedFilePath: String! { get set }

  • Convenient way to access the original image as an UIImage

    Declaration

    Objective-C

    - (UIImage *)originalImage;

    Swift

    func originalImage() -> UIImage!

  • Convenient way to access the processed image as an UIImage

    Declaration

    Objective-C

    - (UIImage *)enhancedImage;

    Swift

    func enhancedImage() -> UIImage!

  • The quadrangle that was applied during the scan flow

    Declaration

    Objective-C

    @property (nonatomic, strong, readwrite) GSKQuadrangle *appliedQuadrangle;

    Swift

    var appliedQuadrangle: GSKQuadrangle! { get set }

  • The filter that was applied during the scan flow

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    GSKFilterType appliedFilter;

    Swift

    var appliedFilter: GSKFilterType { get set }

  • The rotation that was applied during the scan flow

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    GSKRotation appliedRotation;

    Swift

    var appliedRotation: GSKRotation { get set }

  • If OCR was performed, the recognized text.

    Declaration

    Objective-C

    @property (nonatomic, strong, readwrite) GSKOCRResult *ocrResult;

    Swift

    var ocrResult: GSKOCRResult! { get set }

  • Deletes all the files related to this scan. Convenient to clean up after you copied what you needed.

    Declaration

    Objective-C

    - (void)delete;

    Swift

    func delete()