SBSScanCase.h

Go to the documentation of this file.

//
//  SBSScanCase.h
//  ScanditBarcodeScanner
//
//  Created by Luca Torella on 17/02/16.
//  Copyright © 2016 Scandit AG. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>

#import "SBSCommon.h"
#import "SBSScanCaseState.h"

@class SBSScanCaseSettings;
@protocol SBSScanCaseDelegate;

@interface SBSScanCase : NSObject

@property (nonatomic, weak, readwrite, nullable) id<SBSScanCaseDelegate> delegate;

@property (nonatomic, assign, readwrite) SBSScanCaseState state;

@property (nonatomic, assign, readwrite) BOOL volumeButtonToScanEnabled;

@property (nonatomic, assign, readwrite) NSTimeInterval activateDurationAfterVolumeButtonRelease;

+ (nonnull instancetype)acquireWithSettings:(nullable SBSScanCaseSettings *)settings delegate:(nullable id<SBSScanCaseDelegate>)delegate;

- (nonnull instancetype)initWithSettings:(nullable SBSScanCaseSettings *)settings
                                delegate:(nullable id<SBSScanCaseDelegate>)delegate SBS_DESIGNATED_INITIALIZER;

- (nonnull instancetype)initWithSettings:(nullable SBSScanCaseSettings *)settings;

- (void)applySettings:(nonnull SBSScanCaseSettings *)settings
    completionHandler:(nullable void (^)())completionHandler;

- (void)setTimeout:(NSTimeInterval)timeout
         fromState:(SBSScanCaseState)fromState
           toState:(SBSScanCaseState)toState;

- (void)setTimeout:(NSTimeInterval)timeout
         tolerance:(NSTimeInterval)tolerance
         fromState:(SBSScanCaseState)fromState
           toState:(SBSScanCaseState)toState;

- (void)removeTimeoutFromState:(SBSScanCaseState)fromState;

@property (nonnull, nonatomic, readonly, strong) UIViewController *cameraPreview;

@property (nonatomic, assign) BOOL scanBeepEnabled;

@property (nonatomic, assign) BOOL errorSoundEnabled;

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

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

@end