Table of Contents

Class SBSDKBaseScannerViewController

Namespace
ScanbotSDK.iOS
Assembly
DocumentSDK.NET.iOS.dll
public class SBSDKBaseScannerViewController : UIViewController
Inheritance
SBSDKBaseScannerViewController
Derived
Extension Methods

Constructors

SBSDKBaseScannerViewController()

public SBSDKBaseScannerViewController()

SBSDKBaseScannerViewController(NSCoder)

public SBSDKBaseScannerViewController(NSCoder coder)

Parameters

coder NSCoder

SBSDKBaseScannerViewController(NSObjectFlag)

protected SBSDKBaseScannerViewController(NSObjectFlag t)

Parameters

t NSObjectFlag

SBSDKBaseScannerViewController(NativeHandle)

protected SBSDKBaseScannerViewController(NativeHandle handle)

Parameters

handle NativeHandle

Properties

ApplicationStateDidChangeHandler

public virtual Action<SBSDKApplicationState>? ApplicationStateDidChangeHandler { get; set; }

Property Value

Action<SBSDKApplicationState>

BackgroundColor

public virtual UIColor BackgroundColor { get; set; }

Property Value

UIColor

CameraDevice

public virtual SBSDKCameraDevice CameraDevice { get; set; }

Property Value

SBSDKCameraDevice

CameraZoomFactor

public virtual NFloat CameraZoomFactor { get; set; }

Property Value

NFloat

CameraZoomFactorAbsolute

public virtual NFloat CameraZoomFactorAbsolute { get; }

Property Value

NFloat

ClassHandle

public override NativeHandle ClassHandle { get; }

Property Value

NativeHandle

CurrentSecondaryViewFinderRect

public virtual CGRect CurrentSecondaryViewFinderRect { get; }

Property Value

CGRect

CurrentViewFinderRect

public virtual CGRect CurrentViewFinderRect { get; }

Property Value

CGRect

EnergyConfiguration

public virtual SBSDKBaseScannerEnergyConfiguration EnergyConfiguration { get; set; }

Property Value

SBSDKBaseScannerEnergyConfiguration

FinderSafeArea

public virtual CGRect FinderSafeArea { get; set; }

Property Value

CGRect

FlashLightDidChangeHandler

public virtual Action? FlashLightDidChangeHandler { get; set; }

Property Value

Action

GeneralConfiguration

public virtual SBSDKBaseScannerGeneralConfiguration GeneralConfiguration { get; set; }

Property Value

SBSDKBaseScannerGeneralConfiguration

IsCameraFrozen

public virtual bool IsCameraFrozen { get; }

Property Value

bool

IsCameraUsageAuthorized

public virtual bool IsCameraUsageAuthorized { get; }

Property Value

bool

IsCapturingStillImage

public virtual bool IsCapturingStillImage { get; }

Property Value

bool

IsEnergySavingActive

public virtual bool IsEnergySavingActive { get; }

Property Value

bool

IsFlashLightAvailable

public virtual bool IsFlashLightAvailable { get; }

Property Value

bool

IsFlashLightEnabled

public virtual bool IsFlashLightEnabled { get; set; }

Property Value

bool

IsFocusLockEnabled

public virtual bool IsFocusLockEnabled { get; }

Property Value

bool

IsRecognitionEnabled

public virtual bool IsRecognitionEnabled { get; set; }

Property Value

bool

IsSessionInterrupted

public virtual bool IsSessionInterrupted { get; }

Property Value

bool

IsVisible

public virtual bool IsVisible { get; }

Property Value

bool

OverlayView

public virtual UIView OverlayView { get; }

Property Value

UIView

TimeIntervalSinceLastSuccessfulRecognition

public virtual double TimeIntervalSinceLastSuccessfulRecognition { get; }

Property Value

double

ViewFinderConfiguration

public virtual SBSDKBaseScannerViewFinderConfiguration ViewFinderConfiguration { get; set; }

Property Value

SBSDKBaseScannerViewFinderConfiguration

ViewFinderRectDidChangeHandler

public virtual Action<CGRect?>? ViewFinderRectDidChangeHandler { get; set; }

Property Value

Action<CGRect>

ViewFinderStyle

public virtual SBSDKFinderViewStyle ViewFinderStyle { get; set; }

Property Value

SBSDKFinderViewStyle

ZoomConfiguration

public virtual SBSDKBaseScannerZoomConfiguration ZoomConfiguration { get; set; }

Property Value

SBSDKBaseScannerZoomConfiguration

ZoomFactorDidChangeHandler

public virtual Action<NFloat>? ZoomFactorDidChangeHandler { get; set; }

Property Value

Action<NFloat>

Methods

AttachWithParentViewController(UIViewController, UIView)

public virtual bool AttachWithParentViewController(UIViewController parentViewController, UIView parentView)

Parameters

parentViewController UIViewController
parentView UIView

Returns

bool

BeginFocusLockAtLensPosition(NFloat)

public virtual bool BeginFocusLockAtLensPosition(NFloat lensPosition)

Parameters

lensPosition NFloat

Returns

bool

CaptureStillImageWithCompletionHandler(Action<UIImage, NSError>?)

public virtual void CaptureStillImageWithCompletionHandler(Action<UIImage, NSError>? completion)

Parameters

completion Action<UIImage, NSError>

EndEnergySaving()

public virtual void EndEnergySaving()

EndFocusLock()

public virtual void EndFocusLock()

FreezeCamera()

public virtual void FreezeCamera()

PlayBleepSound()

public virtual void PlayBleepSound()

ResetZoom()

public virtual void ResetZoom()

SetCameraZoomFactor(NFloat, bool)

public virtual void SetCameraZoomFactor(NFloat factor, bool animated)

Parameters

factor NFloat
animated bool

StartEnergySaving()

public virtual void StartEnergySaving()

TraitCollectionDidChange(UITraitCollection?)

public virtual void TraitCollectionDidChange(UITraitCollection? previousTraitCollection)

Parameters

previousTraitCollection UITraitCollection

UnfreezeCamera()

public virtual void UnfreezeCamera()

ViewDidAppear(bool)

public virtual void ViewDidAppear(bool animated)

Parameters

animated bool

ViewDidDisappear(bool)

public virtual void ViewDidDisappear(bool animated)

Parameters

animated bool

ViewDidLayoutSubviews()

public virtual void ViewDidLayoutSubviews()

ViewDidLoad()

public virtual void ViewDidLoad()

ViewWillAppear(bool)

public virtual void ViewWillAppear(bool animated)

Parameters

animated bool

ViewWillDisappear(bool)

public virtual void ViewWillDisappear(bool animated)

Parameters

animated bool

ViewWillTransitionToSizeWithTransitionCoordinator(CGSize, IUIViewControllerTransitionCoordinator)

public virtual void ViewWillTransitionToSizeWithTransitionCoordinator(CGSize size, IUIViewControllerTransitionCoordinator coordinator)

Parameters

size CGSize
coordinator IUIViewControllerTransitionCoordinator