Barcode Xpress Mobile for iOS
 All Classes Functions Variables Properties Pages
BXRuntime.h
1 /**************************************************************
2  * Copyright 2011 - Accusoft Corporation, Tampa Florida. *
3  * This sample code is provided to Accusoft licensees "as is" *
4  * with no restrictions on use or modification. No warranty *
5  * for use of this sample code is provided by Accusoft. *
6  **************************************************************/
7 
16 #import <CoreMedia/CoreMedia.h>
17 #import <AVFoundation/AVFoundation.h>
18 #import "BarcodeXpressIOS.h"
19 #import "BXiOSAPI.h"
20 
26 @interface BXRuntime : NSObject <AVCaptureVideoDataOutputSampleBufferDelegate, UIAlertViewDelegate> {
27 
28 @public
34 
35 @private
37  AVCaptureSession *m_videoCaptureSession;
38 
44 
46  NSMutableArray *m_threadQueues;
47 
52  id __unsafe_unretained m_cameraReceiver;
53 
59  id __unsafe_unretained m_recognitionReceiver;
60 
65  id __unsafe_unretained m_processingReceiver;
66 
72 
79 
85 
91  BOOL m_isPaused;
92 
98 
105 
109  BXiOSAPI *m_bxInterface;
110 
116 
125 }
126 
128 @property (nonatomic, strong) AVCaptureSession *m_videoCaptureSession;
129 
134 @property (nonatomic, assign) long m_barcodeTypes;
135 
140 @property /* atomic*/(assign) long m_numProcessedFrames;
141 
146 @property (nonatomic, unsafe_unretained) id m_cameraReceiver;
147 
153 @property (nonatomic, unsafe_unretained) id m_recognitionReceiver;
154 
159 @property (nonatomic, unsafe_unretained) id m_processingReceiver;
160 
165 @property (nonatomic, assign) SEL m_cameraCallback;
166 
172 @property (nonatomic, assign) SEL m_recognitionCallback;
173 
178 @property (nonatomic, assign) SEL m_processingCallback;
179 
185 @property (nonatomic, assign) BOOL m_isPaused;
186 
191 @property (nonatomic, assign) BOOL m_licenseAlertIsActive;
192 
198 @property (nonatomic, assign) BOOL m_useBlurDetection;
199 
203 @property (nonatomic, assign) BXiOSAPI* m_bxInterface;
204 
209 @property (nonatomic, assign) CGSize cameraResolution;
210 
218 @property (nonatomic, assign) BOOL m_terminateBackgroundImageSource;
219 
225 -(id)init;
226 
236 -(id)initWithLicense :(BXLicense*)inLicense;
237 
242 -(void)StartCaptureSession;
243 
248 -(void)StopCaptureSession;
249 
255 -(void)StartRecognition;
256 
262 -(void)StopRecognition;
263 
269 -(void)PauseRecognition;
270 
275 -(void)ResumeRecognition;
276 
289 -(void)SetCameraCallback :(id)receiver :(SEL)callback;
290 
306 -(void)SetRecognitionCallback :(id)receiver :(SEL)callback;
307 
320 -(void)SetProcessingCallback :(id)receiver :(SEL)callback;
321 
338 -(enum Status)RecognizeImage :(UIImage*)image result:(BXResult **)result;
339 
358 -(enum Status)RecognizeImage :(void*)image width:(size_t)width height:(size_t)height stride:(size_t)stride result:(BXResult **)result;
359 
365 -(const char *)ReportVersion;
366 
374 -(long)SetBarcodeTypes :(long)types;
375 
382 -(AVCaptureSession*) GetCaptureSession;
383 
384 @end
385 
SEL m_cameraCallback
Method that will be called to receive messages when a video frame has been captured.
Definition: BXRuntime.h:71
BOOL m_isPaused
Set TRUE when recognition should be paused.
Definition: BXRuntime.h:91
SEL m_recognitionCallback
Method that will be called to receive messages when a barcode has been found, or when the recognition...
Definition: BXRuntime.h:78
BOOL m_terminateBackgroundImageSource
Set TRUE if the thread generated video frames from an alternate source (not the video camera) should ...
Definition: BXRuntime.h:124
BOOL m_licenseAlertIsActive
Set YES when an alert has been set because recognition was attempted with an invalid license...
Definition: BXRuntime.h:97
Defines a class that holds information about an Accusoft license to use the Accusoft Barcode Xpress S...
Definition: BXLicense.h:21
CGSize cameraResolution
The camera resolution that is being used.
Definition: BXRuntime.h:115
SEL m_processingCallback
Method that will be called to receive messages when a thread begins to process an image in search of ...
Definition: BXRuntime.h:84
Defines a class that handles the interactions between camera hardware, BXInterface (called by user pr...
Definition: BXRuntime.h:26
BXiOSAPI * m_bxInterface
Object that is the iOS wrapper around Barcode Xpress.
Definition: BXRuntime.h:109
BOOL m_useBlurDetection
Set TRUE when the iOS wrapper for Barcode Xpress should detect and filter out blurred images before s...
Definition: BXRuntime.h:104
Interface that defines a result returned by the iOS Barcode Xpress SDK.
Definition: BarcodeXpressIOS.h:148
long m_numProcessedFrames
The number of frames processed since the object was instantiated, or the most recent barcode recognit...
Definition: BXRuntime.h:33
AVCaptureSession * m_videoCaptureSession
Video camera hardware manager.
Definition: BXRuntime.h:37
long m_barcodeTypes
The types of barcodes that Barcode Xpress should search for and decode.
Definition: BXRuntime.h:43