Table of Contents

Class SBSDKCameraModel

Namespace
ScanbotSDK.iOS
Assembly
DocumentSDK.NET.iOS.dll
public class SBSDKCameraModel : NSObject
Inheritance
SBSDKCameraModel
Derived
Extension Methods

Constructors

SBSDKCameraModel() 

public SBSDKCameraModel()

SBSDKCameraModel(NSObjectFlag) 

protected SBSDKCameraModel(NSObjectFlag t)

Parameters

t NSObjectFlag

SBSDKCameraModel(NativeHandle) 

protected SBSDKCameraModel(NativeHandle handle)

Parameters

handle NativeHandle

Properties

ActivePreviewLayer 

public virtual CALayer? ActivePreviewLayer { get; }

Property Value

CALayer

ClassHandle 

public override NativeHandle ClassHandle { get; }

Property Value

NativeHandle

Device 

public virtual SBSDKCameraDevice Device { get; set; }

Property Value

SBSDKCameraDevice

EffectiveVideoContentMode 

public virtual SBSDKVideoContentMode EffectiveVideoContentMode { get; }

Property Value

SBSDKVideoContentMode

EffectiveZoomRange 

public virtual SBSDKZoomRange EffectiveZoomRange { get; }

Property Value

SBSDKZoomRange

FocusLockLensPosition 

public virtual NFloat FocusLockLensPosition { get; set; }

Property Value

NFloat

FocusMode 

public virtual SBSDKCameraFocusMode FocusMode { get; set; }

Property Value

SBSDKCameraFocusMode

FrameRate 

public virtual double FrameRate { get; }

Property Value

double

IsAuthorized 

public virtual bool IsAuthorized { get; }

Property Value

bool

IsCameraAdjusting 

public virtual bool IsCameraAdjusting { get; }

Property Value

bool

IsCapturingStillImage 

public virtual bool IsCapturingStillImage { get; }

Property Value

bool

IsDoubleTapToZoomEnabled 

public virtual bool IsDoubleTapToZoomEnabled { get; set; }

Property Value

bool

IsDoubleTapToZoomInteractionEnabled 

public virtual bool IsDoubleTapToZoomInteractionEnabled { get; }

Property Value

bool

IsFrontCameraUsed 

public virtual bool IsFrontCameraUsed { get; }

Property Value

bool

IsFrozen 

public virtual bool IsFrozen { get; }

Property Value

bool

IsInterrupted 

public virtual bool IsInterrupted { get; }

Property Value

bool

IsMirrored 

public virtual bool IsMirrored { get; set; }

Property Value

bool

IsPinchToZoomEnabled 

public virtual bool IsPinchToZoomEnabled { get; set; }

Property Value

bool

IsPinchToZoomInteractionEnabled 

public virtual bool IsPinchToZoomInteractionEnabled { get; }

Property Value

bool

IsPlayingVideo 

public virtual bool IsPlayingVideo { get; }

Property Value

bool

IsPreviewHidden 

public virtual bool IsPreviewHidden { get; }

Property Value

bool

IsRecordingVideo 

public virtual bool IsRecordingVideo { get; }

Property Value

bool

IsScanningPaused 

public virtual bool IsScanningPaused { get; }

Property Value

bool

IsSessionRunning 

public virtual bool IsSessionRunning { get; }

Property Value

bool

IsTapToFocusEnabled 

public virtual bool IsTapToFocusEnabled { get; set; }

Property Value

bool

IsTapToFocusInteractionEnabled 

public virtual bool IsTapToFocusInteractionEnabled { get; }

Property Value

bool

IsTorchAvailable 

public virtual bool IsTorchAvailable { get; }

Property Value

bool

IsTorchLightEnabled 

public virtual bool IsTorchLightEnabled { get; set; }

Property Value

bool

IsZoomAvailable 

public virtual bool IsZoomAvailable { get; }

Property Value

bool

IsZoomInteractionSuppressingFrames 

public virtual bool IsZoomInteractionSuppressingFrames { get; }

Property Value

bool

IsZooming 

public virtual bool IsZooming { get; }

Property Value

bool

IsZoomingEnabled 

public virtual bool IsZoomingEnabled { get; set; }

Property Value

bool

KeepAliveTimeout 

public virtual double KeepAliveTimeout { get; set; }

Property Value

double

LoggingContext 

public virtual string LoggingContext { get; set; }

Property Value

string

MaxOpticalZoom 

public virtual NFloat MaxOpticalZoom { get; }

Property Value

NFloat

MaxZoom 

public virtual NFloat MaxZoom { get; }

Property Value

NFloat

MinZoom 

public virtual NFloat MinZoom { get; }

Property Value

NFloat

NextZoomStepValue 

public virtual NFloat NextZoomStepValue { get; }

Property Value

NFloat

NormalizedZoomFactor 

public virtual NFloat NormalizedZoomFactor { get; }

Property Value

NFloat

PhotoQualityPrioritization 

public virtual SBSDKCapturePhotoQualityPrioritization PhotoQualityPrioritization { get; set; }

Property Value

SBSDKCapturePhotoQualityPrioritization

PointOfInterest 

public virtual CGPoint PointOfInterest { get; set; }

Property Value

CGPoint

PreviewLayer 

public virtual AVCaptureVideoPreviewLayer? PreviewLayer { get; }

Property Value

AVCaptureVideoPreviewLayer

ReplayPreviewLayer 

public virtual CALayer? ReplayPreviewLayer { get; }

Property Value

CALayer

ShouldAnimateZooming 

public virtual bool ShouldAnimateZooming { get; set; }

Property Value

bool

ShouldControlIdleTimer 

public virtual bool ShouldControlIdleTimer { get; set; }

Property Value

bool

TapToFocusDuration 

public virtual double TapToFocusDuration { get; set; }

Property Value

double

VideoContentMode 

public virtual SBSDKVideoContentMode VideoContentMode { get; set; }

Property Value

SBSDKVideoContentMode

VideoFlipMode 

public virtual SBSDKVideoFlipMode VideoFlipMode { get; set; }

Property Value

SBSDKVideoFlipMode

VideoFrameResolution 

public virtual SBSDKVideoFrameResolution VideoFrameResolution { get; set; }

Property Value

SBSDKVideoFrameResolution

VideoOrientation 

public virtual SBSDKVideoOrientation VideoOrientation { get; set; }

Property Value

SBSDKVideoOrientation

ZoomRange 

public virtual SBSDKZoomRange ZoomRange { get; set; }

Property Value

SBSDKZoomRange

ZoomSteps 

public virtual NSNumber[] ZoomSteps { get; set; }

Property Value

NSNumber[]

ZoomValue 

public virtual NFloat ZoomValue { get; set; }

Property Value

NFloat

Methods

Apply(SBSDKCameraConfiguration) 

public virtual void Apply(SBSDKCameraConfiguration configuration)

Parameters

configuration SBSDKCameraConfiguration

CaptureStillImageWithCompletion(Action<SBSDKBaseScannerFrame, NSError>) 

public virtual void CaptureStillImageWithCompletion(Action<SBSDKBaseScannerFrame, NSError> completion)

Parameters

completion Action<SBSDKBaseScannerFrame, NSError>

EndTapToFocus() 

public virtual void EndTapToFocus()

EndTapToFocusInteraction() 

public virtual void EndTapToFocusInteraction()

FlipCamera() 

public virtual void FlipCamera()

Freeze() 

public virtual void Freeze()

PauseScanning() 

public virtual void PauseScanning()

RefreshCameraPermissionStatusWithRequestIfNeeded(bool, Action<AVAuthorizationStatus?>?) 

public virtual AVAuthorizationStatus? RefreshCameraPermissionStatusWithRequestIfNeeded(bool requestIfNeeded, Action<AVAuthorizationStatus?>? completion)

Parameters

requestIfNeeded bool
completion Action<AVAuthorizationStatus>

Returns

AVAuthorizationStatus

ResetFocus() 

public virtual void ResetFocus()

ResetZoomWithAnimated(bool) 

public virtual void ResetZoomWithAnimated(bool animated)

Parameters

animated bool

ResumeScanning() 

public virtual void ResumeScanning()

SetNormalizedZoomFactor(NFloat, bool) 

public virtual void SetNormalizedZoomFactor(NFloat factor, bool animated)

Parameters

factor NFloat
animated bool

SetPreviewLayerVisible(bool, bool) 

public virtual void SetPreviewLayerVisible(bool visible, bool animated)

Parameters

visible bool
animated bool

SetZoom(NFloat, bool) 

public virtual void SetZoom(NFloat value, bool animated)

Parameters

value NFloat
animated bool

Snapshot() 

public virtual SBSDKCameraConfiguration Snapshot()

Returns

SBSDKCameraConfiguration

Start() 

public virtual void Start()

StartRecordingVideo() 

public virtual void StartRecordingVideo()

StartRecordingVideoWithFormat(SBSDKCameraVideoRecordingFormat, NSData?) 

public virtual void StartRecordingVideoWithFormat(SBSDKCameraVideoRecordingFormat format, NSData? embeddedReportData)

Parameters

format SBSDKCameraVideoRecordingFormat
embeddedReportData NSData

StartReplayWithMockData(SBSDKCameraMockData, Action?) 

public virtual void StartReplayWithMockData(SBSDKCameraMockData mockData, Action? completion)

Parameters

mockData SBSDKCameraMockData
completion Action

StopRecordingVideoWithCompletion(Action<NSUrl>) 

public virtual void StopRecordingVideoWithCompletion(Action<NSUrl> completion)

Parameters

completion Action<NSUrl>

StopReplay() 

public virtual void StopReplay()

Unfreeze() 

public virtual void Unfreeze()

ZoomToNextStepWithAnimated(bool) 

public virtual void ZoomToNextStepWithAnimated(bool animated)

Parameters

animated bool