Banuba SDK
Instance Methods | Class Methods | List of all members
BNBRecognizer Class Reference

#import <BNBRecognizer.h>

Inheritance diagram for BNBRecognizer:

Instance Methods

(nullable id< BNBFeature >) - getFeature:
 
(void) - setFeatures:
 
(void) - addFeature:dependencies:
 
(void) - removeFeature:
 
(void) - setMaxFaces:
 sets maximum allowed face results, if face tracking feature is present More...
 
(void) - setOfflineMode:
 
(void) - setUseFutureFilter:
 Set future frame filtrarion mode. More...
 
(void) - setUseFutureInterpolate:
 Set future frame interpolation mode. More...
 
(void) - process:
 
(void) - pushCameraFrame:
 
(BOOL) - popFrameData:
 
(void) - start
 start the recognizer More...
 
(void) - pause
 pause the recognizer More...
 
(void) - stop
 pause + clear More...
 
(void) - clear
 clear input and output buffers and pipeline state, also clean cached features More...
 

Class Methods

(nullable BNBRecognizer *) + create:
 
(int64_t) + getFeatureId:
 

Detailed Description

Definition at line 18 of file BNBRecognizer.h.

Method Documentation

◆ addFeature:dependencies:

- (void) addFeature: (nullable id< BNBFeature >)  feature
dependencies: (nonnull NSSet< NSNumber * > *)  dependencies 

◆ clear

- (void) clear

clear input and output buffers and pipeline state, also clean cached features

◆ create:

+ (nullable BNBRecognizer *) create: (BNBRecognizerMode)  mode

◆ getFeature:

- (nullable id<BNBFeature>) getFeature: (BNBFeatureId)  feature

◆ getFeatureId:

+ (int64_t) getFeatureId: (BNBFeatureId)  feature

◆ pause

- (void) pause

pause the recognizer

◆ popFrameData:

- (BOOL) popFrameData: (nullable BNBFrameData *)  outputFrameData

◆ process:

- (void) process: (nullable BNBFrameData *)  frameData

◆ pushCameraFrame:

- (void) pushCameraFrame: (nullable BNBFrameData *)  inputFrameData

◆ removeFeature:

- (void) removeFeature: (nullable id< BNBFeature >)  feature

◆ setFeatures:

- (void) setFeatures: (nonnull NSSet< NSNumber * > *)  features

◆ setMaxFaces:

- (void) setMaxFaces: (int32_t)  num

sets maximum allowed face results, if face tracking feature is present

◆ setOfflineMode:

- (void) setOfflineMode: (BOOL)  on

◆ setUseFutureFilter:

- (void) setUseFutureFilter: (BOOL)  on

Set future frame filtrarion mode.

Produce smoother recognition result (anti jitter), however adds inconsistency in push'ed/pop'ed frames (one frame lag) Applied only in push_camera_frame/pop_frame_data methods, when offline mode is disabled. Example: push frame 1 - pop frame 1, push frame 2 - pop frame 1, push frame 3 - pop frame 2, ...

◆ setUseFutureInterpolate:

- (void) setUseFutureInterpolate: (BOOL)  on

Set future frame interpolation mode.

Produce faster recognition result (skip even frames), however adds inconsistency in push'ed/pop'ed frames (one frame lag) Applied only in push_camera_frame/pop_frame_data methods, when offline mode is disabled. Example: push frame 1 - pop frame 1, push frame 2 - pop frame 1, push frame 3 - pop frame 2, ...

◆ start

- (void) start

start the recognizer

◆ stop

- (void) stop

pause + clear


The documentation for this class was generated from the following file: