BNBRecognizer Class Reference

#import <BNBRecognizer.h>

Inheritance diagram for BNBRecognizer:

Instance Methods
(nullable id< BNBFeature >)	- getFeature:
(void)	- setFeatures:
(void)	- addFeature:dependencies:needsGpu:
(void)	- removeFeature:
(void)	- setMaxFaces:
	sets maximum allowed face results, if face tracking feature is present More...
(void)	- setOfflineMode:
(void)	- setNnEnable:
	Set flag which enable NN's features. More...
(BOOL)	- getNnEnable
(BOOL)	- isDeviceNnCompatible
	Check if device compatible with NN player. More...
(void)	- setFaceSearchMode:
	Clear pipeline state and set face search 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:maxTokens:
(int64_t)	+ getFeatureId:

Detailed Description

Definition at line 13 of file BNBRecognizer.h.

Method Documentation

addFeature:dependencies:needsGpu:

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

clear

- (void) clear

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

create:maxTokens:

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

Parameters

maxTokens

If greater than 0: recognizer will run processing on push-ed() frame only if it can "consume" a token - and will wait for the token to become available if all maxTokens tokens have been used up. Consumed tokens are "produced" again one-by-one when pop-ping() processed frame(s). This mode prevents processing frames more often than a consumer(e.g. renderer) can use: potentially reducing energy consumption at the cost of higher latency. Only for asynchronous mode.

getFeature:

- (nullable id<BNBFeature>) getFeature:

(BNBFeatureId)

feature

getFeatureId:

+ (int64_t) getFeatureId:

(BNBFeatureId)

feature

getNnEnable

- (BOOL) getNnEnable

isDeviceNnCompatible

- (BOOL) isDeviceNnCompatible

Check if device compatible with NN player.

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

setFaceSearchMode:

- (void) setFaceSearchMode:

(BNBFaceSearchMode)

mode

Clear pipeline state and set face search mode.

setFeatures:

- (void) setFeatures:

(nonnull NSSet< NSNumber * > *)

features

setMaxFaces:

- (void) setMaxFaces:

(int32_t)

num

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

setNnEnable:

- (void) setNnEnable:

(BOOL)

enable

Set flag which enable NN's features.

True by default, if device compatible with NN player When this flag is false, recognizer will skip NN-dependent features during set_features call. In case when device have no NN player support (is_device_nn_compatible return false), setting enable to true have no any effect

setOfflineMode:

- (void) setOfflineMode:

(BOOL)

on

start

- (void) start

start the recognizer

stop

- (void) stop

pause + clear

---

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

• BNBRecognizer.h