Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for iOS

ScanditSDKBarcodePicker Class Reference

Inherits SBSBarcodePickerBase.

Instance Methods

(void) - reset
 

Properties

ScanditSDKOverlayControlleroverlayController
 
CGSize size
 
SBSCameraFacingDirection cameraFacingDirection
 
AVCaptureVideoOrientation cameraPreviewOrientation
 
BOOL autoFocusOnTapEnabled
 
BOOL pinchToZoomEnabled
 

Camera Selection

(BOOL) - supportsCameraFacing:
 
(BOOL) - changeToCameraFacing:
 
(BOOL) - switchCameraFacing
 

Torch Control

(void) - switchTorchOn:
 

Zoom control

(BOOL) - setRelativeZoom:
 

Barcode Picker Setup

Initialize and prepare the barcode picker, control standby state and set overlay

(instancetype) - initWithAppKey:
 
(instancetype) - initWithAppKey:cameraFacingPreference:
 
(instancetype) - initWithAppKey:cameraFacingPreference:workingRange:
 

Barcode Decoder Operation

(BOOL) - isScanning
 
(void) - startScanning
 
(void) - stopScanning
 
(void) - stopScanningAndKeepTorchState
 
(void) - stopScanningAndFreeze
 

Analytics Configuration

(void) - setDeviceName:
 

Barcode Decoder Configuration

Adjust the decoding process and area.

(void) - setActiveScanningArea:forOrientation:
 
(CGRect) - activeScanningAreaForOrientation:
 
(void) - restrictActiveScanningArea:
 
(void) - setScanningHotSpotToX:andY:
 
(void) - setScanningHotSpotHeight:
 
(void) - setMicroDataMatrixEnabled:
 
(void) - setInverseDetectionEnabled:
 
(void) - setMotionCompensationEnabled:
 
(void) - setHighDensityModeEnabled:
 
(void) - force2dRecognition:
 

Barcode Symbology Selection

Configure which symbologies are decoded.

(void) - set1DScanningEnabled:
 
(void) - set2DScanningEnabled:
 
(void) - setEan13AndUpc12Enabled:
 
(void) - setEan8Enabled:
 
(void) - setUpceEnabled:
 
(void) - setCode39Enabled:
 
(void) - setCode93Enabled:
 
(void) - setCode128Enabled:
 
(void) - setItfEnabled:
 
(void) - setMsiPlesseyEnabled:
 
(void) - setMsiPlesseyChecksumType:
 
(void) - setGS1DataBarEnabled:
 
(void) - setGS1DataBarExpandedEnabled:
 
(void) - setCodabarEnabled:
 
(void) - setCode11Enabled:
 
(void) - setQrEnabled:
 
(void) - setDataMatrixEnabled:
 
(void) - setPdf417Enabled:
 
(void) - setAztecEnabled:
 
(void) - setMaxiCodeEnabled:
 
(void) - setTwoDigitAddOnEnabled:
 
(void) - setFiveDigitAddOnEnabled:
 
(void) - setGS1DatabarLimitedEnabled:
 
(void) - setMaxNumCodesPerFrame:
 

Camera Frame Access

(void) - sendNextFrameToDelegate:
 

Deprecated Standby Related Setup

With the removal of the standby state in 4.7.0 these functions do not do anything anymore.

(void) - forceRelease
 
(void) - disableStandbyState
 
(void) + prepareWithAppKey:
 
(void) + prepareWithAppKey:cameraFacingPreference:
 
(void) + prepareWithAppKey:cameraFacingPreference:workingRange:
 

Detailed Description

Acquires camera frames, decodes barcodes in those camera frames and updates the ScanditSDKOverlayController.

Example (minimal) usage:

Set up the barcode picker in one of your view controllers:

// Instantiate the barcode picker.
scanditSDKBarcodePicker = [[ScanditSDKBarcodePicker alloc] initWithAppKey:kScanditBarcodeScannerAppKey];
// Set a class as the delegate for the overlay controller to handle events when
// a barcode is successfully scanned or manually entered or the cancel button is pressed.
scanditSDKBarcodePicker.overlayController.delegate = self;
// Present the barcode picker modally
[self presentViewController:scanditSDKBarcodePicker animated:YES completion:nil];
// Start the scanning
[scanditSDKBarcodePicker startScanning];

As of version 4.7.0, we encourage to use SBSBarcodePicker instead of the ScanditSDKBarcodePicker for scanning of barcodes. No new features will be added to the ScanditSDKBarcodePicker class. Improvements to the barcode scanning process itself (performance, recognition rates) will automatically become available for code using the ScanditSDKBarcodePicker.

Since
1.0.0

Copyright Scandit AG

Method Documentation

- (instancetype) initWithAppKey: (NSString *)  appKey

Initiate the barcode picker with the default camera orientation (CameraFacingDirectionBack).

Note that the initial invocation of this method will activate the Scandit Barcode Scanner SDK, after which the device will count towards your device limit.

Since
2.0.0
Parameters
appKeyYour Scandit SDK App Key (available from your Scandit account).
- (instancetype) initWithAppKey: (NSString *)  appKey
cameraFacingPreference: (SBSCameraFacingDirection facing 

Initializes the barcode picker with the desired camera orientation.

Note that the initial invocation of this method will activate the Scandit Barcode Scanner SDK, after which the device will count towards your device limit.

Since
2.1.7
Parameters
appKeyYour Scandit SDK app key (available from your Scandit account).
facingThe desired camera direction.
- (instancetype) initWithAppKey: (NSString *)  appKey
cameraFacingPreference: (SBSCameraFacingDirection facing
workingRange: (SBSWorkingRange workingRange 

Initializes the barcode picker with the desired camera orientation and working range.

Note that the initial invocation of this method will activate the Scandit Barcode Scanner SDK, after which the device will count towards your device limit.

Since
4.2.0
Parameters
appKeyYour Scandit SDK app key (available from your Scandit account).
facingThe desired camera direction.
workingRangeThe desired working range for the auto-focus.
- (BOOL) isScanning

Returns YES if scanning is in progress.

Since
1.0.0
Returns
boolean indicating whether scanning is in progress.

Implements SBSBarcodePickerBase.

- (void) startScanning

Starts/restarts the scanning process.

Start or continue scanning barcodes after the creation of the barcode picker or a previous call to stopScanning, stopScanningAndKeepTorchState, or stopScanningAndFreeze.

Since
1.0.0
- (void) stopScanning

Stops the scanning process.

See also
- stopScanningAndKeepTorchState:
Since
1.0.0
- (void) stopScanningAndKeepTorchState

Stops the scanning process but keeps the torch on if it is already turned on.

This is useful when the scan user interface remains visible after a successful barcode scan. To prevent additional scans of the same barcode, the scanner needs to be stopped at least temporarily. To avoid making the user switch on the torch again for the next scan, we recommend using this method instead of :stopScanning:

Since
3.0.0
- (void) stopScanningAndFreeze

Stops the scanning process and stops the camera feed, freezing it. This will result in a reset of the focus and take longer to focus on a new code when started again.

Since
3.2.4
- (void) reset

Resets the state of the barcode picker.

Since
1.0.0
- (void) setDeviceName: (NSString *)  deviceName

Sets the device name to identify this device when looking at analytics tools. Sends a request to the server to set this as soon as a connection is available.

Parameters
deviceNameThe device name to be used.
- (void) setActiveScanningArea: (CGRect)  rect
forOrientation: (SBSOrientation orientation 

Sets the active scan area for either portrait mode scanning.

By default, the ScanditSDK searches the whole image for a barcode. Use this method to define the area in which barcodes are to be searched. Rectangle coordinates run from 0 to 1.

Calling this method will automatically enable restricted active area scanning (restrictActiveScanningArea:).

Since
4.4

Calling this method with other orientation parameters is a no-op.

Parameters
rectthe new active scan area. The coordinates (top, left, right, bottom) are defined as seen by the user.
orientationthe device orientation for which to set the scan area. Must be either SBSOrientationLandscape for landscape orientations (landscape-right and landscape-left), or SBSOrientationPortrait for portrait orientations.

Invoking this method with invalid rectangles, e.g. rectangles whose top, left, right, or bottom attributes are outside the allowed range of 0.0-1.0, or rectangles with negative width/height will have no effect.

- (CGRect) activeScanningAreaForOrientation: (SBSOrientation orientation

Returns the scan area that is going to be used for the given orientation.

Since
4.4
Parameters
orientationthe device orientation. Must either be SBSOrientationPortrait, or SBSOrientationLandscape
Returns
The rectangle, or null when orientation is not one of the allowed values. When restricted area scanning is disabled a full-screen area (top=0, left=0, right=1, bottom=1) is returned, otherwise the area from either specifying the scanning hotspot/height or calls to setActiveScanningArea:forOrientation: is returned.
See also
- setActiveScanningArea:forOrientation:
- (void) restrictActiveScanningArea: (BOOL)  enabled

Reduces the area in which barcodes are detected and decoded.

When activated, the active scanning area is defined by setScanningHotSpotHeight: and setScanningHotSpotToX:andY:. If this method is not enabled, barcodes in the full camera image are detected and decoded.

See also
- setScanningHotSpotToX:andY:
- setScanningHotSpotHeight:

By default this is not enabled.

Since
3.0.0
Parameters
enabledWhether the scanning area should be restricted.
- (void) setScanningHotSpotToX: (float)  x
andY: (float)  y 

Sets the location in the image where barcodes are decoded with the highest priority.

This method shows a slightly different behavior depending on whether the full screen scanning is active or not. In Full screen scanning mode:

Sets the location in the image which is decoded with the highest priority when multiple barcodes are present in the image.

In restrictActiveScanningArea mode (activated with restrictActiveScanningArea:):

Changes the location of the spot where the barcode decoder actively scans for barcodes.

X and Y can be between 0 and 1, where 0/0 corresponds to the top left corner and 1/1 to the bottom right corner.

The default hotspot is set to 0.5/0.5

See also
- restrictActiveScanningArea:
- setScanningHotSpotHeight:
Since
1.0.0
Parameters
xThe hotspot's relative x coordinate.
yThe hotspot's relative y coordinate.
- (void) setScanningHotSpotHeight: (float)  height

Changes the height of the area where barcodes are decoded in the camera image when restrictActiveScanningArea is activated.

The height of the active scanning area is relative to the height of the screen and has to be between 0.0 and 0.5.

This only applies if the active scanning area is restricted.

The default is 0.25

See also
- restrictActiveScanningArea:
- setScanningHotSpotToX:andY:
Since
1.0.0
Parameters
heightThe relative height of the active scanning area.
- (void) setMicroDataMatrixEnabled: (BOOL)  enabled

Enable the detection/decoding of tiny Data Matrix codes.

When this mode is enabled, a dedicated localization algorithm is activated that searches for small Datamatrix codes in the central part of the camera image. This algorithm requires additional resources and slows down the recognition of other barcode symbologies. We recommend using the method only when your application requires the decoding of tiny Datamatrix codes.

By default this mode is disabled.

Since
2.0.0
Parameters
enabledWhether this mode should be enabled.
- (void) setInverseDetectionEnabled: (BOOL)  enabled

Enables the detection of white on black codes. This option currently only works for Data Matrix and QR codes.

By default this mode is disabled.

Since
2.0.0 (4.4.0 for QR)
Parameters
enabledWhether this mode should be enabled.
- (void) setMotionCompensationEnabled: (BOOL)  enabled

Enable/disable motion compensation.

When motion compensation is enabled, special algorithms are run to improve the image quality when the phone or the barcode to be scanned are moving. Motion compensation requires an OpenGLES 3.0 compatible device. For devices that do not support OpenGLES 3.0, setting the motion compensation flag has no effect.

Motion compensation is enabled by default.

Since
4.6.0
- (void) setHighDensityModeEnabled: (BOOL)  enabled

Changes the camera frame resolution to the highest possible but a max of 1920x1080.

- (void) force2dRecognition: (BOOL)  force

Forces the barcode scanner to always run the 2D decoders (QR,Datamatrix, etc.), even when the 2D detector did not detect the presence of a 2D code.

This slows down the overall scanning speed, but can be useful when your application only tries to read QR codes. It is by default enabled when the micro Datamatrix mode is enabled.

By default, this is disabled.

Parameters
forceboolean indicating whether this mode should be enabled.
Since
2.0.0
- (void) set1DScanningEnabled: (BOOL)  enabled

Enables or disables the recognition of all 1D barcode symbologies supported by the particular Scandit SDK edition you are using.

By default all 1D symbologies except for MSI Plessey and GS1 DataBar are enabled.

Since
1.0.0
Parameters
enabledWhether all 1D symbologies should be enabled.
- (void) set2DScanningEnabled: (BOOL)  enabled

Enables or disables the recognition of 2D barcode symbologies supported by the particular Scandit SDK edition you are using.

By default only QR is enabled.

Since
1.0.0
Parameters
enabledboolean indicating whether all 2D symbologies are enabled
- (void) setEan13AndUpc12Enabled: (BOOL)  enabled

Enables or disables the barcode decoder for EAN13 and UPC12/UPCA codes.

By default scanning of EAN13 and UPC barcodes is enabled.

Since
1.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setEan8Enabled: (BOOL)  enabled

Enables or disables the barcode decoder for EAN8 codes.

By default scanning of EAN8 barcodes is enabled.

Since
1.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setUpceEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for UPCE codes.

By default scanning of UPCE barcodes is enabled.

Since
1.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setCode39Enabled: (BOOL)  enabled

Enables or disables the barcode decoder for Code39 codes.

By default scanning of Code39 barcodes is enabled. Note: CODE39 scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
1.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setCode93Enabled: (BOOL)  enabled

Enables or disables the barcode decoder for Code93 codes.

By default scanning of Code93 barcodes is disabled. Note: CODE93 scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
4.0.1
Parameters
enabledWhether this symbology should be enabled.
- (void) setCode128Enabled: (BOOL)  enabled

Enables or disables the barcode decoder for Code128 codes.

By default scanning of Code128 barcodes is enabled. Note: CODE128 scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
1.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setItfEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for ITF (2 out of 5) codes.

By default scanning of ITF barcodes is enabled. Note: ITF scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
1.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setMsiPlesseyEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for MSI Plessey codes.

By default scanning of MSI Plessey barcodes is disabled. Note: MSI Plessey scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
3.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setMsiPlesseyChecksumType: (SBSMsiPlesseyChecksumType type

Sets the type of checksum that is expected of the MSI Plessey codes.

MSI Plessey is used with different checksums. Set the checksum your application uses with this method.

By default it is set to CHECKSUM_MOD_10.

Since
3.0.0
Parameters
typeThe MSIPlesseyChecksumType your application uses.
- (void) setGS1DataBarEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for GS1 DataBar codes.

By default scanning of GS1 DataBar barcodes is disabled. Note: GS1 DataBar scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
4.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setGS1DataBarExpandedEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for GS1 DataBar Expanded codes.

By default scanning of GS1 DataBar Expanded barcodes is disabled. Note: GS1 DataBar scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
4.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setCodabarEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for Codabar codes.

By default scanning of Codabar barcodes is disabled. Note: Codabar scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
4.0.0
Parameters
enabledboolean indicating whether this symbology should be enabled.
- (void) setCode11Enabled: (BOOL)  enabled

Enables or disables the barcode decoder for Code11 codes.

By default scanning of Code11 barcodes is disabled. Note: Code11 scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
4.9.0
Parameters
enabledboolean indicating whether this symbology should be enabled.
- (void) setQrEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for QR codes.

By default scanning of QR barcodes is enabled.

Since
2.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setDataMatrixEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for Datamatrix codes.

By default scanning of Datamatrix codes is enabled.

Note: Datamatrix scanning is only available with the Scandit SDK Enterprise Premium Package.

Since
2.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setPdf417Enabled: (BOOL)  enabled

Enables or disables the barcode decoder for PDF417 codes.

By default scanning of PDF417 codes is disabled (since 3.2.0).

Note: PDF417 scanning is only available with the Scandit SDK Enterprise Premium Package.

Since
3.0.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setAztecEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for Aztec codes.

By default scanning of Aztec codes is disabled.

Note: Aztec scanning is only available with the Scandit SDK Enterprise Premium Package.

Since
4.3.0
Parameters
enabledWhether this symbology should be enabled.
- (void) setMaxiCodeEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for MaxiCode codes.

By default scanning of MaxiCode barcodes is disabled. Note: MaxiCode scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
4.9.0
Parameters
enabledboolean indicating whether this symbology should be enabled.
- (void) setTwoDigitAddOnEnabled: (BOOL)  enabled

Enables or disables the recognition of two-digit add-ons for EAN and UPC barcodes.

Note that you also need to enable scanning of EAN13/UPCA, EAN8, or UPCE codes in order to scan two-digit add-ons and must set the maximum number of codes per frame to at least 2.

Since
4.5.0
Parameters
enabledWhether it should be enabled. Default is false.
- (void) setFiveDigitAddOnEnabled: (BOOL)  enabled

Enables or disables the recognition of five-digit add-ons for EAN and UPC barcodes.

Note that you also need to enable scanning of EAN13/UPCA, EAN8, or UPCE codes in order to scan five-digit add-ons and must set the maximum number of codes per frame to at least 2.

Since
4.5.0
Parameters
enabledWhether it should be enabled. Default is false.
- (void) setGS1DatabarLimitedEnabled: (BOOL)  enabled

Enables or disables the barcode decoder for Databar Limited codes.

By default scanning of Databar Limited barcodes is disabled. Note: Databar Limited scanning is only available with the Scandit SDK Enterprise Basic or Enterprise Premium Package.

Since
4.11.0
Parameters
enabledboolean indicating whether this symbology should be enabled.
- (void) setMaxNumCodesPerFrame: (int)  num

Set the maximum number of codes to be decoded per frame.

By default at most one code is decoded per frame. Use this method to enable scanning multiple codes.

Since
4.7.0
Parameters
numthe new maximum number of codes to be decoded per frame. Values are clamped to the range 1...6.
- (void) sendNextFrameToDelegate: (id< ScanditSDKNextFrameDelegate >)  delegate

Sets the delegate to which the next frame should be sent.

The next frame from the camera is then converted to a JPEG image and the ScanditSDKBarcodePicker will pass the jpg image, width and height to the delegate. We recommend to not call this method repeatedly while the barcode scanner is running, since the JPG conversion of the camera frame is very slow.

Since
2.0.0
Parameters
delegateimplementing the ScanditSDKNextFrameDelegate protocol
+ (void) prepareWithAppKey: (NSString *)  scanditSDKAppKey

Prepares a ScanditSDKBarcodePicker which accelerates the camera start.

We no longer recommend to use this method since the impact on performance is no longer as significant with iOS7/8 and the recent generation of ios devices.

Note that the initial invocation of this method will activate the Scandit Barcode Scanner SDK, after which the device will count towards your device limit.

The method prepares the default backwards facing camera.

Since
3.0.0
Parameters
scanditSDKAppKeyyour Scandit SDK App Key (available from your Scandit account)
+ (void) prepareWithAppKey: (NSString *)  scanditSDKAppKey
cameraFacingPreference: (CameraFacingDirection facing 

Prepares a ScanditSDKBarcodePicker which accelerates the camera start with the desired camera orientation.

We no longer recommend to use this method since the impact on performance is no longer as significant with iOS7/8 and the recent generation of ios devices.

Note that the initial invocation of this method will activate the Scandit Barcode Scanner SDK, after which the device will count towards your device limit.

Since
3.0.0
Parameters
scanditSDKAppKeyyour Scandit SDK App Key (available from your Scandit account)
facingthe desired camera direction
+ (void) prepareWithAppKey: (NSString *)  scanditSDKAppKey
cameraFacingPreference: (CameraFacingDirection facing
workingRange: (WorkingRange range 

Prepares a ScanditSDKBarcodePicker which accelerates the camera start with the desired camera orientation and working range.

Note that the initial invocation of this method will activate the Scandit Barcode Scanner SDK, after which the device will count towards your device limit.

Parameters
scanditSDKAppKeythe Scandit Barcode Scanner (ScanditSDK) app key.
facingthe preferred camera facing direction to use.
rangeThe working range for the auto-focus
Since
4.2.0
- (void) forceRelease

Forces the release of the barcode picker and all attached objects.

By default the camera is being held in a standby mode when the barcode picker object is released. Forcing a release will lead to the deallocation of all resources and shut down the camera completely. This frees up resources (memory, power), but also increases the startup time and time to a successful scan for subsequent scanning attempts.

See also
- disableStandbyState:
Since
3.0.3
- (void) disableStandbyState

Prevents the camera from entering a standby state after the barcode picker object is deallocated.

This will free up resources (power, memory) after each scan that are used by the camera in standby mode, but also increases the startup time and time to successful scan for subsequent scans. This method is not enabled by default. We recommend enabling it when conserving battery power is important.

Since
3.0.0
- (BOOL) supportsCameraFacing: (SBSCameraFacingDirection facing

Returns whether the specified camera facing direction is supported by the current device.

Since
3.0.0
Parameters
facingThe camera facing direction in question.
Returns
Whether the camera facing direction is supported
- (BOOL) changeToCameraFacing: (SBSCameraFacingDirection facing

Changes to the specified camera facing direction if it is supported.

Since
3.0.0
Parameters
facingThe new camera facing direction
Returns
Whether the change was successful
- (BOOL) switchCameraFacing

Changes to the opposite camera facing if it is supported.

Since
3.0.0
Returns
Whether the change was successful
- (void) switchTorchOn: (BOOL)  on

Switches the torch (if available) on or off programmatically.

There is also a method in the ScanditSDKOverlayController to add a torch icon that the user can click to activate the torch.

Parameters
onYES when the torch should be switched on, NO if the torch should be turned off.

By default the torch switch is off.

Since
2.0.0
- (BOOL) setRelativeZoom: (float)  zoom

Sets the zoom to the given percentage of the maximum analog zoom possible.

Parameters
zoomThe percentage of the max zoom (between 0 and 1)
Returns
Whether setting the zoom was successful
Since
4.7.0

Property Documentation

- (ScanditSDKOverlayController*) overlayController
readwritenonatomicstrong

The overlay controller controls the scan user interface.

The Scandit SDK contains a default implementation that developers can inherit from to define their own scan UI (enterprise licensees only).

Since
1.0.0
- (CGSize) size
readwritenonatomicassign

The size of the scan user interface.

Change the size if you want to scale the picker (see example in the demo project). By default it is set to full screen.

Since
2.1.9
- (SBSCameraFacingDirection) cameraFacingDirection
readnonatomicassigninherited

The facing direction of the used camera.

Since
2.0.0
- (AVCaptureVideoOrientation) cameraPreviewOrientation
readwritenonatomicassigninherited

The orientation of the camera preview.

The orientation of the camera preview. In general the preview's orientation will be as wanted, but there may be cases where it needs to be set individually. This does not change the orientation of the overlayed UI elements.

Possible values are: AVCaptureVideoOrientationPortrait, AVCaptureVideoOrientationPortraitUpsideDown, AVCaptureVideoOrientationLandscapeLeft, AVCaptureVideoOrientationLandscapeRight

- (BOOL) autoFocusOnTapEnabled
readwritenonatomicassigninherited

Whether tapping on the screen should trigger an auto-focus.

By default, the camera triggers an auto-focus whenever the user taps the screen. To disable this feature, set this property to NO.

- (BOOL) pinchToZoomEnabled
readwritenonatomicassigninherited

Whether pinch to zoom is enabled.

By default, the camera preview zoom factor can be changed by using a pinch gesture. To disable this feature, set this property to NO. The feature is only available on devices with iOS 7 and greater.

Since
4.15

The documentation for this class was generated from the following file: