GSKCameraViewController

@interface GSKCameraViewController : UIViewController <GSKCameraSessionDelegate>

A GSKCameraViewController is a ready-to-use camera interface for scanning documents.

  • Declaration

    Objective-C

    - (instancetype)initWithCameraSession:(GSKCameraSession *)cameraSession;

    Swift

    init!(cameraSession: GSKCameraSession!)

    Parameters

    cameraSession

    The camera session to use for this view controller

  • The camera view. Use this view in your layout.

    Declaration

    Objective-C

    @property (nonatomic, readonly) UIView *cameraView;

    Swift

    var cameraView: UIView! { get }

  • The view containing the preview layer

    Declaration

    Objective-C

    @property (nonatomic, strong, readwrite) GSKView *captureView;

    Swift

    var captureView: GSKView! { get set }

  • The view appearing when the photo is being taken, similar to a shutter screen on a real camera.

    Declaration

    Objective-C

    @property (nonatomic, readonly) GSKShutterView *shutterView;

    Swift

    var shutterView: GSKShutterView! { get }

  • Trigger the photo

    Declaration

    Objective-C

    - (void)takePhoto;

    Swift

    func takePhoto()

  • If YES, draws the detected document frame overlay in real time. Default is YES.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL drawsDocumentFrameOverlay;

    Swift

    var drawsDocumentFrameOverlay: Bool { get set }

  • Customize the overlay color.

    Declaration

    Objective-C

    @property (nonatomic, copy, readwrite) UIColor *overlayColor;

    Swift

    @NSCopying var overlayColor: UIColor! { get set }

  • The camera session associated to this camera view controller

    Declaration

    Objective-C

    @property (nonatomic, readonly) GSKCameraSession *cameraSession;

    Swift

    var cameraSession: GSKCameraSession! { get }