SBSOverlayController.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>

#import <UIKit/UIKit.h>
#import "AudioToolbox/AudioServices.h"

#import "SBSCommon.h"

@class SBSOverlayController;
@class SBSBarcodePicker;

@protocol SBSOverlayControllerDidCancelDelegate

- (void)overlayController:(nonnull SBSOverlayController *)overlayController
      didCancelWithStatus:(nullable NSDictionary *)status;

@end

SBS_ENUM_BEGIN(SBSCameraSwitchVisibility) {
    SBSCameraSwitchVisibilityNever,
    SBSCameraSwitchVisibilityOnTablet,
    SBSCameraSwitchVisibilityAlways,
    CAMERA_SWITCH_NEVER SBS_DEPRECATED = SBSCameraSwitchVisibilityNever,
    CAMERA_SWITCH_ON_TABLET SBS_DEPRECATED = SBSCameraSwitchVisibilityOnTablet,
    CAMERA_SWITCH_ALWAYS SBS_DEPRECATED = SBSCameraSwitchVisibilityAlways
} SBS_ENUM_END(SBSCameraSwitchVisibility);

SBS_ENUM_BEGIN(SBSMatrixScanHighlightingState) {
    SBSMatrixScanHighlightingStateLocalized,
    SBSMatrixScanHighlightingStateRecognized,
    SBSMatrixScanHighlightingStateRejected,
} SBS_ENUM_END(SBSMatrixScanHighlightingState);

typedef SBSCameraSwitchVisibility CameraSwitchVisibility SBS_DEPRECATED;


@interface SBSOverlayController : UIViewController


@property (nullable, nonatomic, strong, readonly) UIToolbar *toolBar;

@property (nullable, nonatomic, weak) id<SBSOverlayControllerDidCancelDelegate> cancelDelegate;

@property (nonatomic, assign) SBSGuiStyle guiStyle;


- (void)setBeepEnabled:(BOOL)enabled;

- (void)setVibrateEnabled:(BOOL)enabled;

- (BOOL)setScanSoundResource:(nonnull NSString *)path ofType:(nonnull NSString *)extension;



- (void)setTorchEnabled:(BOOL)enabled;

- (BOOL)setTorchOnImage:(nonnull UIImage *)torchOnImage
                pressed:(nonnull UIImage *)torchOnPressedImage SBS_SWIFT_NAME(setTorchOnImage(torchOnImage:torchOnPressedImage:));

- (BOOL)setTorchOnImageResource:(nonnull NSString *)fileName
                pressedResource:(nonnull NSString *)pressedFileName
                         ofType:(nonnull NSString *)extension;

- (BOOL)setTorchOffImage:(nonnull UIImage *)torchOffImage
                 pressed:(nonnull UIImage *)torchOffPressedImage SBS_SWIFT_NAME(setTorchOffImage(torchOffImage:torchOffPressedImage:));

- (BOOL)setTorchOffImageResource:(nonnull NSString *)fileName
                 pressedResource:(nonnull NSString *)pressedFileName
                          ofType:(nonnull NSString *)extension;

- (void)setTorchButtonLeftMargin:(float)leftMargin
                       topMargin:(float)topMargin
                           width:(float)width
                          height:(float)height SBS_SWIFT_NAME(setTorchButton(leftMargin:topMargin:width:height:));

- (void)setTorchOffButtonAccessibilityLabel:(nonnull NSString *)label
                                       hint:(nonnull NSString *)hint;

- (void)setTorchOnButtonAccessibilityLabel:(nonnull NSString *)label
                                      hint:(nonnull NSString *)hint;




- (void)setCameraSwitchVisibility:(SBSCameraSwitchVisibility)visibility;

- (BOOL)setCameraSwitchImage:(nonnull UIImage *)cameraSwitchImage
                     pressed:(nonnull UIImage *)cameraSwitchPressedImage;

- (BOOL)setCameraSwitchImageResource:(nonnull NSString *)fileName
                     pressedResource:(nonnull NSString *)pressedFileName
                              ofType:(nonnull NSString *)extension;

- (void)setCameraSwitchButtonRightMargin:(float)rightMargin
                               topMargin:(float)topMargin
                                   width:(float)width
                                  height:(float)height SBS_SWIFT_NAME(setCameraSwitchButton(rightMargin:topMargin:width:height:));

- (void)setCameraSwitchButtonBackAccessibilityLabel:(nonnull NSString *)label
                                               hint:(nonnull NSString *)hint;

- (void)setCameraSwitchButtonFrontAccessibilityLabel:(nonnull NSString *)label
                                                hint:(nonnull NSString *)hint;




- (void)setTextRecognitionSwitchVisible:(BOOL)visible;



- (void)drawViewfinder:(BOOL)draw SBS_DEPRECATED;

- (void)setViewfinderHeight:(float)h
                      width:(float)w
            landscapeHeight:(float)lH
             landscapeWidth:(float)lW SBS_SWIFT_NAME(setViewfinder(height:width:landscapeHeight:landscapeWidth:));

- (void)setViewfinderPortraitWidth:(float)w
                            height:(float)h SBS_SWIFT_NAME(setViewfinderPortrait(width:height:));


- (void)setViewfinderLandscapeWidth:(float)w
                             height:(float)h SBS_SWIFT_NAME(setViewfinderLandscape(width:height:));

- (void)setViewfinderColor:(float)r green:(float)g blue:(float)b SBS_SWIFT_NAME(setViewfinderColor(red:green:blue:));

- (void)setViewfinderDecodedColor:(float)r green:(float)g blue:(float)b SBS_SWIFT_NAME(setViewfinderDecodedColor(red:green:blue:));


- (void)resetUI;



- (void)showToolBar:(BOOL)show;

- (void)setToolBarButtonCaption:(nonnull NSString *)caption;



- (void)setMissingCameraPermissionInfoText:(nonnull NSString *)infoText;

- (void)setMatrixScanHighlightingColor:(nonnull UIColor *)color forState:(SBSMatrixScanHighlightingState)state;

@end