SBSBarcodePicker.h

Go to the documentation of this file.

//
//  SBSBarcodePicker.h
//  ScanditBarcodeScanner
//
//  Created by Marco Biasini on 12/06/15.
//  Copyright (c) 2015 Scandit AG. All rights reserved.
//

#import <UIKit/UIKit.h>
#import <AVFoundation/AVFoundation.h>
#import <CoreGraphics/CoreGraphics.h>
#import <CoreVideo/CoreVideo.h>
#import <CoreMedia/CoreMedia.h>
#import "SBSBarcodeGenerator.h"
#import "SBSCommon.h"
#import "SBSParser.h"
#import "SBSParserDataFormat.h"


@class SBSScanSession;
@class SBSScanSettings;
@class SBSBarcodePicker;
@class SBSOverlayController;
@protocol SBSPropertyObserver;

@protocol SBSProcessFrameDelegate

- (void)barcodePicker:(nonnull SBSBarcodePicker *)barcodePicker
      didProcessFrame:(nonnull CMSampleBufferRef)frame
              session:(nonnull SBSScanSession *)session;

@end

@protocol SBSScanDelegate

- (void)barcodePicker:(nonnull SBSBarcodePicker *)picker didScan:(nonnull SBSScanSession *)session;

@end

@protocol SBSLicenseValidationDelegate

- (void)barcodePicker:(nonnull SBSBarcodePicker *)picker failedToValidateLicense:(nonnull NSString *)errorMessage;

@end

@interface SBSBarcodePicker : UIViewController

@property (nonatomic, assign) UIInterfaceOrientationMask allowedInterfaceOrientations;

@property (nonnull, nonatomic, strong) SBSOverlayController *overlayController;

@property (nullable, nonatomic, weak) id<SBSScanDelegate> scanDelegate;

@property (nullable, nonatomic, weak) id<SBSProcessFrameDelegate> processFrameDelegate;

@property (nullable, nonatomic, weak) id<SBSLicenseValidationDelegate> licenseValidationDelegate;

@property (readonly, nonatomic) SBSCameraFacingDirection cameraFacingDirection;

@property (nonatomic, assign) AVCaptureVideoOrientation cameraPreviewOrientation;

@property (nonatomic, assign) BOOL autoFocusOnTapEnabled;

@property (nonatomic, assign) BOOL pinchToZoomEnabled;

- (nonnull instancetype)initWithSettings:(nullable SBSScanSettings *)settings SBS_DESIGNATED_INITIALIZER;


- (void)applyScanSettings:(nonnull SBSScanSettings *)settings
        completionHandler:(nullable void (^)(void))handler;


- (void)addPropertyObserver:(nullable id<SBSPropertyObserver>)observer SBS_SWIFT_NAME(addPropertyObserver(_:));

- (void)removePropertyObserver:(nullable id<SBSPropertyObserver>)observer SBS_SWIFT_NAME(removePropertyObserver(_:));


- (void)startScanning;

- (void)startScanningInPausedState:(BOOL)paused;

- (void)startScanningInPausedState:(BOOL)paused completionHandler:(nullable void (^)(void))handler;

- (void)stopScanningWithCompletionHandler:(nullable void (^)(void))handler;

- (void)stopScanning;

- (void)resumeScanning;

- (void)resumeScanningWithCompletionHandler:(nullable void (^)(void))handler;

- (void)pauseScanning;

- (void)pauseScanningWithCompletionHandler:(nullable void (^)(void))handler;



- (CGPoint)convertPointToPickerCoordinates:(CGPoint)point;


- (BOOL)isScanning;



- (BOOL)supportsCameraFacing:(SBSCameraFacingDirection)facing;

- (BOOL)changeToCameraFacing:(SBSCameraFacingDirection)facing;

- (BOOL)switchCameraFacing;


- (void)switchTorchOn:(BOOL)on;


- (BOOL)setRelativeZoom:(float)zoom;


- (nullable SBSParser *)parserForFormat:(SBSParserDataFormat)dataFormat error:(NSError * _Nullable * _Nullable)outError;


- (nullable SBSBarcodeGenerator *)barcodeGeneratorForSymbology:(SBSSymbology)symbology error:(NSError * _Nullable * _Nullable)outError;

@end