Banuba SDK
BNBRecognizer.h
Go to the documentation of this file.
1 // AUTOGENERATED FILE - DO NOT MODIFY!
2 // This file was generated by Djinni from recognizer.djinni
3 
4 #import "BNBFeatureId.h"
5 #import "BNBFrameData.h"
6 #import "BNBRecognizerMode.h"
7 #import <Foundation/Foundation.h>
8 @class BNBRecognizer;
9 @protocol BNBFeature;
10 
11 
12 
13 #ifndef DJINNI_EXPORT
14  #define DJINNI_EXPORT __attribute__((__visibility__("default")))
15 #endif
16 
18 @interface BNBRecognizer : NSObject
19 
20 + (nullable BNBRecognizer *)create:(BNBRecognizerMode)mode;
21 
22 + (int64_t)getFeatureId:(BNBFeatureId)feature;
23 
24 - (nullable id<BNBFeature>)getFeature:(BNBFeatureId)feature;
25 
26 - (void)setFeatures:(nonnull NSSet<NSNumber *> *)features;
27 
28 - (void)addFeature:(nullable id<BNBFeature>)feature
29  dependencies:(nonnull NSSet<NSNumber *> *)dependencies;
30 
31 - (void)removeFeature:(nullable id<BNBFeature>)feature;
32 
33 /** sets maximum allowed face results, if face tracking feature is present */
34 - (void)setMaxFaces:(int32_t)num;
35 
36 - (void)setOfflineMode:(BOOL)on;
37 
38 /**
39  * Set future frame filtrarion mode.
40  * Produce smoother recognition result (anti jitter), however adds inconsistency in push'ed/pop'ed frames (one frame lag)
41  * Applied only in push_camera_frame/pop_frame_data methods, when offline mode is disabled.
42  * Example: push frame 1 - pop frame 1, push frame 2 - pop frame 1, push frame 3 - pop frame 2, ...
43  */
44 - (void)setUseFutureFilter:(BOOL)on;
45 
46 /**
47  * Set future frame interpolation mode.
48  * Produce faster recognition result (skip even frames), however adds inconsistency in push'ed/pop'ed frames (one frame lag)
49  * Applied only in push_camera_frame/pop_frame_data methods, when offline mode is disabled.
50  * Example: push frame 1 - pop frame 1, push frame 2 - pop frame 1, push frame 3 - pop frame 2, ...
51  */
52 - (void)setUseFutureInterpolate:(BOOL)on;
53 
54 - (void)process:(nullable BNBFrameData *)frameData;
55 
56 - (void)pushCameraFrame:(nullable BNBFrameData *)inputFrameData;
57 
58 - (BOOL)popFrameData:(nullable BNBFrameData *)outputFrameData;
59 
60 /** start the recognizer */
61 - (void)start;
62 
63 /** pause the recognizer */
64 - (void)pause;
65 
66 /** pause + clear */
67 - (void)stop;
68 
69 /** clear input and output buffers and pipeline state, also clean cached features */
70 - (void)clear;
71 
72 @end
-[BNBRecognizer start]
void start()
start the recognizer
-[BNBRecognizer stop]
void stop()
pause + clear
BNBRecognizer
Definition: BNBRecognizer.h:18
BNBRecognizerMode.h
BNBFeature-p
Definition: BNBFeature.h:8
DJINNI_EXPORT
#define DJINNI_EXPORT
for order of values in action units array see action_units_indices enum
Definition: BNBActionUnits.h:9
-[BNBRecognizer pause]
void pause()
pause the recognizer
BNBFrameData.h
BNBFrameData
getters throw exceptions when data are not available android NNs usually output gpu masks
Definition: BNBFrameData.h:35
-[BNBRecognizer clear]
void clear()
clear input and output buffers and pipeline state, also clean cached features
BNBFeatureId.h