CameraViewController

@objcMembers
public final class CameraViewController : UIViewController

Undocumented

  • The object that acts as the delegate of the camera view controller.

    Declaration

    Swift

    public weak var delegate: CameraViewControllerDelegate?

  • Undocumented

    Declaration

    Swift

    public weak var trackingDelegate: CameraScreenTrackingDelegate?

  • Designated initializer for the CameraViewController which allows to set the GiniConfiguration for the camera screen. All the interactions with this screen are handled by CameraViewControllerDelegate.

    Declaration

    Swift

    public init(giniConfiguration: GiniConfiguration, currentDevice: UIDevice = .current)

    Parameters

    giniConfiguration

    GiniConfiguration instance.

    Return Value

    A view controller instance allowing the user to take a picture or pick a document.

  • Returns an object initialized from data in a given unarchiver.

    Warning

    Not implemented.

    Declaration

    Swift

    public required init?(coder aDecoder: NSCoder)

  • Undocumented

    Declaration

    Swift

    public override func loadView()

  • Undocumented

    Declaration

    Swift

    public override func viewDidLoad()

  • Undocumented

    Declaration

    Swift

    public override func viewWillAppear(_ animated: Bool)

  • Undocumented

    Declaration

    Swift

    public override func viewDidAppear(_ animated: Bool)

  • Undocumented

    Declaration

    Swift

    public override func viewDidLayoutSubviews()

  • Undocumented

    Declaration

    Swift

    override public func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator)

  • Undocumented

    Declaration

    Swift

    public func setupCamera()

  • Undocumented

    Declaration

    Swift

    func addConstraints()

Toggle UI elements

  • Show the capture button. Should be called when onboarding is dismissed.

    Declaration

    Swift

    public func showCaptureButton()

  • Hide the capture button. Should be called when onboarding is presented.

    Declaration

    Swift

    public func hideCaptureButton()

  • Show the camera overlay. Should be called when onboarding is dismissed.

    Declaration

    Swift

    public func showCameraOverlay()

  • Hide the camera overlay. Should be called when onboarding is presented.

    Declaration

    Swift

    public func hideCameraOverlay()

  • Show the fileImportTip. Should be called when onboarding is dismissed.

    Declaration

    Swift

    public func showFileImportTip()

  • Hide the fileImportTip. Should be called when onboarding is presented.

    Declaration

    Swift

    public func hideFileImportTip()

  • Show the QR code Tip. Should be called when fileImportTip is dismissed.

    Declaration

    Swift

    public func showQrCodeTip()

  • Hide the QR code Tip. Should be called when onboarding is presented.

    Declaration

    Swift

    public func hideQrCodeTip()

Image capture

  • Used to animate the captured image, first shrinking it and then translating it to the captured images stack view.

    Declaration

    Swift

    public func animateToControlsView(imageDocument: GiniImageDocument, completion: (() -> Void)? = nil)

    Parameters

    imageDocument

    GiniImageDocument to be animated.
    completion

    Completion block.

  • Replaces the captured images stack content with new images.

    Declaration

    Swift

    public func replaceCapturedStackImages(with images: [UIImage])

    Parameters

    images

    New images to be shown in the stack. (Last image will be shown on top)

CameraPreviewViewControllerDelegate

CameraButtonsViewControllerDelegate

  • Undocumented

    Declaration

    Swift

    func cameraButtons(_ viewController: CameraButtonsViewController,
                   didTapOn button: CameraButtonsViewController.Button)

Document import

  • Undocumented

    Declaration

    Swift

    func addValidationLoadingView() -> UIView

  • Handle tooltip dismiss on tap outside.

    Declaration

    Swift

    override public func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?)