BNBFrameData

Objective-C

@interface BNBFrameData : NSObject

/** Creates empty `FrameData`. Use `add*` function to fill it.  */
+ (nullable BNBFrameData *)create;

- (nonnull BNBFullImageFormat *)getFullImgFormat;

- (nonnull NSArray<NSNumber *> *)getFullImgTransform;

/** Get frx_recognition_result or null if not exists */
- (nullable BNBFrxRecognitionResult *)getFrxRecognitionResult;

- (void)setFrxRecognitionResult:(nullable BNBFrxRecognitionResult *)result;

- (nonnull BNBActionUnitsData *)getActionUnits;

- (nonnull BNBAcneRegions *)getAcneRegions;

- (BOOL)getIsSmile;

- (BOOL)getIsMouthOpen;

- (BOOL)getIsBrowsRaised;

- (BOOL)getIsBrowsShifted;

- (BOOL)getIsWearGlasses;

- (float)getRuler;

- (nonnull BNBEyesState *)getEyesState;

- (float)getLightCorrection;

- (nonnull BNBTransformedMaskByte *)getBackground;

- (nonnull BNBTransformedMaskGpu *)getBackgroundGpu;

- (nonnull BNBTransformedMaskByte *)getHair;

- (nonnull BNBTransformedMaskGpu *)getHairGpu;

- (nonnull BNBTransformedMaskByte *)getSkin;

- (nonnull BNBTransformedMaskGpu *)getSkinGpu;

- (nonnull BNBTransformedMaskByte *)getLips;

- (nonnull BNBTransformedMaskGpu *)getLipsGpu;

- (nonnull BNBTransformedMaskByte *)getTeeth;

- (nonnull BNBTransformedMaskByte *)getOcclusion;

- (nonnull BNBTransformedMaskByte *)getBody;

- (nonnull BNBLipsShineMask *)getLipsShine;

- (nonnull BNBBrowsMask *)getBrows;

- (nonnull BNBEyesMask *)getEyes;

- (nonnull BNBTransformedMaskByte *)getFace;

- (nonnull BNBTransformedMaskByte *)getFaceSkin;

- (nullable NSString *)getFaceAttributes;

/** Pupillary distance in mm */
- (float)getPupillaryDistance;

- (void)addFullImg:(nonnull BNBFullImageData *)img;

- (void)replaceFullImg:(nonnull BNBFullImageData *)img;

- (void)addBackground:(nonnull BNBTransformedMaskByte *)mask;

- (void)addExternalFaceData:(BNBFaceDataSource)source
                       data:(nonnull NSArray<BNBExternalFaceData *> *)data;

- (void)addDepthMap:(nonnull BNBDepthMap *)depthMap;

- (void)addFrameNumber:(int64_t)frameNumber;

- (void)addActionUnitsData:(nonnull BNBActionUnitsData *)actionUnits;

/**
 * Extra parameters during in-CPU feature calculations.
 * Reference feature documentation. 
 */
- (void)addFeatureParameters:(nonnull NSDictionary<NSNumber *, NSArray<BNBFeatureParameter *> *> *)params;

/**add frame timestamp in microseconds */
- (void)addTimestampUs:(double)timestampUs;

@end

Swift

class BNBFrameData : NSObject

Undocumented

+create
Creates empty FrameData. Use add* function to fill it.
Declaration
Objective-C

+ (nullable BNBFrameData *)create;
Swift

class func create() -> BNBFrameData?


                    
                    
                    -getFullImgFormat

Undocumented

Declaration

Objective-C

- (nonnull BNBFullImageFormat *)getFullImgFormat;

Swift

func getFullImgFormat() -> BNBFullImageFormat


                    
                    
                    -getFullImgTransform

Undocumented

Declaration

Objective-C

- (nonnull NSArray<NSNumber *> *)getFullImgTransform;

Swift

func getFullImgTransform() -> [NSNumber]


                    
                    
                    -getFrxRecognitionResult

Get frx_recognition_result or null if not exists

Declaration

Objective-C

- (nullable BNBFrxRecognitionResult *)getFrxRecognitionResult;

Swift

func getFrxRecognitionResult() -> BNBFrxRecognitionResult?


                    
                    
                    -setFrxRecognitionResult:

Undocumented

Declaration

Objective-C

- (void)setFrxRecognitionResult:(nullable BNBFrxRecognitionResult *)result;

Swift

func setFrxRecognitionResult(_ result: BNBFrxRecognitionResult?)


                    
                    
                    -getActionUnits

Undocumented

Declaration

Objective-C

- (nonnull BNBActionUnitsData *)getActionUnits;

Swift

func getActionUnits() -> BNBActionUnitsData


                    
                    
                    -getAcneRegions

Undocumented

Declaration

Objective-C

- (nonnull BNBAcneRegions *)getAcneRegions;

Swift

func getAcneRegions() -> BNBAcneRegions

-getIsSmile
Undocumented
Declaration
Objective-C

- (BOOL)getIsSmile;
Swift

func getIsSmile() -> Bool


                    
                    
                    -getIsMouthOpen

Undocumented

Declaration

Objective-C

- (BOOL)getIsMouthOpen;

Swift

func getIsMouthOpen() -> Bool


                    
                    
                    -getIsBrowsRaised

Undocumented

Declaration

Objective-C

- (BOOL)getIsBrowsRaised;

Swift

func getIsBrowsRaised() -> Bool


                    
                    
                    -getIsBrowsShifted

Undocumented

Declaration

Objective-C

- (BOOL)getIsBrowsShifted;

Swift

func getIsBrowsShifted() -> Bool


                    
                    
                    -getIsWearGlasses

Undocumented

Declaration

Objective-C

- (BOOL)getIsWearGlasses;

Swift

func getIsWearGlasses() -> Bool

-getRuler
Undocumented
Declaration
Objective-C

- (float)getRuler;
Swift

func getRuler() -> Float


                    
                    
                    -getEyesState

Undocumented

Declaration

Objective-C

- (nonnull BNBEyesState *)getEyesState;

Swift

func getEyesState() -> BNBEyesState


                    
                    
                    -getLightCorrection

Undocumented

Declaration

Objective-C

- (float)getLightCorrection;

Swift

func getLightCorrection() -> Float


                    
                    
                    -getBackground

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskByte *)getBackground;

Swift

func getBackground() -> BNBTransformedMaskByte


                    
                    
                    -getBackgroundGpu

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskGpu *)getBackgroundGpu;

Swift

func getBackgroundGpu() -> BNBTransformedMaskGpu


                    
                    
                    -getHair

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskByte *)getHair;

Swift

func getHair() -> BNBTransformedMaskByte


                    
                    
                    -getHairGpu

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskGpu *)getHairGpu;

Swift

func getHairGpu() -> BNBTransformedMaskGpu


                    
                    
                    -getSkin

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskByte *)getSkin;

Swift

func getSkin() -> BNBTransformedMaskByte


                    
                    
                    -getSkinGpu

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskGpu *)getSkinGpu;

Swift

func getSkinGpu() -> BNBTransformedMaskGpu


                    
                    
                    -getLips

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskByte *)getLips;

Swift

func getLips() -> BNBTransformedMaskByte


                    
                    
                    -getLipsGpu

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskGpu *)getLipsGpu;

Swift

func getLipsGpu() -> BNBTransformedMaskGpu


                    
                    
                    -getTeeth

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskByte *)getTeeth;

Swift

func getTeeth() -> BNBTransformedMaskByte


                    
                    
                    -getOcclusion

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskByte *)getOcclusion;

Swift

func getOcclusion() -> BNBTransformedMaskByte


                    
                    
                    -getBody

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskByte *)getBody;

Swift

func getBody() -> BNBTransformedMaskByte


                    
                    
                    -getLipsShine

Undocumented

Declaration

Objective-C

- (nonnull BNBLipsShineMask *)getLipsShine;

Swift

func getLipsShine() -> BNBLipsShineMask


                    
                    
                    -getBrows

Undocumented

Declaration

Objective-C

- (nonnull BNBBrowsMask *)getBrows;

Swift

func getBrows() -> BNBBrowsMask


                    
                    
                    -getEyes

Undocumented

Declaration

Objective-C

- (nonnull BNBEyesMask *)getEyes;

Swift

func getEyes() -> BNBEyesMask


                    
                    
                    -getFace

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskByte *)getFace;

Swift

func getFace() -> BNBTransformedMaskByte


                    
                    
                    -getFaceSkin

Undocumented

Declaration

Objective-C

- (nonnull BNBTransformedMaskByte *)getFaceSkin;

Swift

func getFaceSkin() -> BNBTransformedMaskByte


                    
                    
                    -getFaceAttributes

Undocumented

Declaration

Objective-C

- (nullable NSString *)getFaceAttributes;

Swift

func getFaceAttributes() -> String?

-getPupillaryDistance
Pupillary distance in mm
Declaration
Objective-C

- (float)getPupillaryDistance;
Swift

func getPupillaryDistance() -> Float


                    
                    
                    -addFullImg:

Undocumented

Declaration

Objective-C

- (void)addFullImg:(nonnull BNBFullImageData *)img;

Swift

func addFullImg(_ img: BNBFullImageData)


                    
                    
                    -replaceFullImg:

Undocumented

Declaration

Objective-C

- (void)replaceFullImg:(nonnull BNBFullImageData *)img;

Swift

func replaceFullImg(_ img: BNBFullImageData)


                    
                    
                    -addBackground:

Undocumented

Declaration

Objective-C

- (void)addBackground:(nonnull BNBTransformedMaskByte *)mask;

Swift

func addBackground(_ mask: BNBTransformedMaskByte)


                    
                    
                    -addExternalFaceData:data:

Undocumented

Declaration

Objective-C

- (void)addExternalFaceData:(BNBFaceDataSource)source
                       data:(nonnull NSArray<BNBExternalFaceData *> *)data;

Swift

func addExternalFace(_ source: BNBFaceDataSource, data: [BNBExternalFaceData])


                    
                    
                    -addDepthMap:

Undocumented

Declaration

Objective-C

- (void)addDepthMap:(nonnull BNBDepthMap *)depthMap;

Swift

func add(_ depthMap: BNBDepthMap)


                    
                    
                    -addFrameNumber:

Undocumented

Declaration

Objective-C

- (void)addFrameNumber:(int64_t)frameNumber;

Swift

func addFrameNumber(_ frameNumber: Int64)


                    
                    
                    -addActionUnitsData:

Undocumented

Declaration

Objective-C

- (void)addActionUnitsData:(nonnull BNBActionUnitsData *)actionUnits;

Swift

func add(_ actionUnits: BNBActionUnitsData)


                    
                    
                    -addFeatureParameters:

Extra parameters during in-CPU feature calculations. Reference feature documentation.

Declaration

Objective-C

- (void)addFeatureParameters:
    (nonnull NSDictionary<NSNumber *, NSArray<BNBFeatureParameter *> *> *)
        params;

Swift

func addFeatureParameters(_ params: [NSNumber : [BNBFeatureParameter]])


                    
                    
                    -addTimestampUs:

add frame timestamp in microseconds

Declaration

Objective-C

- (void)addTimestampUs:(double)timestampUs;

Swift

func addTimestampUs(_ timestampUs: Double)