API Reference

This page matches SDK 2.0.0. Preset meanings: Parameter enums. Auth: Auth & License.

iOS and macOS share this Objective-C API. iOS-only: +[FBImageFrame createWithUIImage:]. Minimum OS: iOS 12.0, architecture arm64.

Logging

`FBLogLevel`

typedef NS_ENUM(NSInteger, FBLogLevel) {
  FBLogLevel_Trace = 0,
  FBLogLevel_Debug,
  FBLogLevel_Info,
  FBLogLevel_Warn,
  FBLogLevel_Error,
  FBLogLevel_Critical,
};

`FBLogConfig`

Property	Type	Description
`consoleEnabled`	`BOOL`	Console output
`fileEnabled`	`BOOL`	File output
`level`	`FBLogLevel`	Minimum level
`fileName`	`NSString *`	Log path (used when `fileEnabled` is `YES`)

FB_OBJC_API @interface FBLogConfig : NSObject
@property(nonatomic, assign) BOOL consoleEnabled;
@property(nonatomic, assign) BOOL fileEnabled;
@property(nonatomic, assign) FBLogLevel level;
@property(nonatomic, copy, nullable) NSString *fileName;
- (instancetype)init;
@end

Call +[FBBeautyEffectEngine setLogConfig:] before createEngineWithConfig:. Returns FBErrorCode (0 success, -1 if config is nil).

Engine configuration

`FBEngineConfig`

Property	Type	Description
`appId`	`NSString *`	Dashboard App ID (online auth)
`appKey`	`NSString *`	Dashboard App Key (online auth)
`licenseToken`	`NSString *`	License token string, `{token}` JSON, or native `.lic` contents
`externalContext`	`BOOL`	Default `NO`. `YES`: use the caller’s OpenGL ES context; SDK does not create one

Auth priority: if licenseToken is non-empty, validate that token locally and skip /facebetter/v2/auth. Otherwise use appId + appKey for online auth. Bind the app Bundle ID in the Dashboard.

FB_OBJC_API @interface FBEngineConfig : NSObject
@property(nonatomic, copy) NSString *appId;
@property(nonatomic, copy) NSString *appKey;
@property(nonatomic, copy, nullable) NSString *licenseToken;
@property(nonatomic, assign) BOOL externalContext;
- (instancetype)init;
@end

`FBFrameType`

Set on FBImageFrame.type before processImage:. Not a method argument.

typedef NS_ENUM(NSInteger, FBFrameType) {
  FBFrameTypeImage = 0,  // stills
  FBFrameTypeVideo = 1   // live / camera
};

`FBBeautyEffectEngine`

FB_OBJC_API @interface FBBeautyEffectEngine : NSObject

+ (int)setLogConfig:(FBLogConfig *)config;
+ (instancetype)createEngineWithConfig:(FBEngineConfig *)config;

- (int)setSmoothing:(float)intensity;
- (int)setSmoothingStyle:(FBSmoothingStyle)style;
- (int)setWhitening:(float)intensity;
- (int)setWhiteningStyle:(FBWhiteningStyle)style;
- (int)setSharpening:(float)intensity;
- (int)setRosiness:(float)intensity;
- (int)setReshape:(FBReshape)param intensity:(float)value;
- (int)setBodyReshape:(FBBodyReshape)param intensity:(float)value;
- (int)setBeautySkinOnly:(BOOL)enabled;

- (int)setLipstick:(float)intensity;
- (int)setLipstickColor:(FBLipstickColor)color;
- (int)setBlush:(float)intensity;
- (int)setBlushStyle:(FBBlushStyle)style;
- (int)setBlushColor:(FBBlushColor)color;
- (int)setContour:(float)intensity;
- (int)setContourStyle:(FBContourStyle)style;
- (int)setEyeShadow:(float)intensity;
- (int)setEyeShadowStyle:(FBEyeShadowStyle)style;
- (int)setEyeShadowColor:(FBEyeShadowColor)color;
- (int)setEyeLiner:(float)intensity;
- (int)setEyeLinerStyle:(FBEyeLinerStyle)style;
- (int)setEyeLinerColor:(FBEyeLinerColor)color;
- (int)setEyebrow:(float)intensity;
- (int)setEyebrowStyle:(FBEyebrowStyle)style;
- (int)setEyebrowColor:(FBEyebrowColor)color;
- (int)setEyelash:(float)intensity;
- (int)setEyelashStyle:(FBEyelashStyle)style;
- (int)setEyelashColor:(FBEyelashColor)color;
- (int)setPupil:(float)intensity;
- (int)setPupilColor:(FBPupilColor)color;

- (int)setChromaKey:(FBChromaKeyColor)color;
- (int)clearChromaKey;
- (int)setChromaKeySimilarity:(float)value;
- (int)setChromaKeySmoothness:(float)value;
- (int)setChromaKeyDesaturation:(float)value;
- (int)setVirtualBackgroundBlur:(float)level;
- (int)setVirtualBackground:(NSString *)imagePath;
- (int)setVirtualBackgroundWithData:(NSData *)imageData;
- (int)clearVirtualBackground;

- (int)setFilter:(NSString *)fbdFilePath;
- (int)setFilterWithData:(NSData *)fbdData;
- (int)clearFilter;
- (int)setFilterIntensity:(float)intensity;
- (int)setSticker:(NSString *)fbdFilePath;
- (int)setStickerWithData:(NSData *)fbdData;
- (int)clearSticker;
- (int)addResourcePack:(NSString *)fbdFilePath;
- (int)addResourcePackWithData:(NSData *)fbdData;
- (int)set3DSticker:(NSString *)resource;
- (int)set3DStickerWithData:(NSData *)fbdData;
- (int)clear3DSticker;

- (FBEngineStats *)getStats;
- (int)setCallbacks:(FBEngineCallbacks *)callbacks;
- (FBImageFrame * _Nullable)processImage:(FBImageFrame *)imageFrame;

@end

createEngineWithConfig: returns nil on failure. Integer methods return FBErrorCode (0 = success).

Skin

Method	Range / notes
`setSmoothing:`	`[0, 1]` intensity
`setSmoothingStyle:`	Style; intensity still from `setSmoothing:`
`setWhitening:`	`[0, 1]`
`setWhiteningStyle:`	Swaps the whitening LUT
`setSharpening:`	`[0, 1]`
`setRosiness:`	`[0, 1]`
`setBeautySkinOnly:`	`YES` = skin regions only

Reshape

setReshape:intensity: — intensity [-1.0, 1.0], 0 off. FBReshape values 0–25: FBReshape_FaceThin … FBReshape_BrowThickness. Directions: Parameter enums.

typedef NS_ENUM(NSInteger, FBReshape) {
  FBReshape_FaceThin = 0,
  FBReshape_FaceVShape = 1,
  FBReshape_FaceNarrow = 2,
  FBReshape_FaceShort = 3,
  FBReshape_Cheekbone = 4,
  FBReshape_Jawbone = 5,
  FBReshape_Chin = 6,
  FBReshape_NoseSlim = 7,
  FBReshape_EyeSize = 8,
  FBReshape_EyeDistance = 9,
  FBReshape_FaceSmall = 10,
  FBReshape_Forehead = 11,
  FBReshape_NoseLong = 12,
  FBReshape_Philtrum = 13,
  FBReshape_MouthSize = 14,
  FBReshape_MouthPosition = 15,
  FBReshape_MouthSmile = 16,
  FBReshape_LipThickness = 17,
  FBReshape_EyeRound = 18,
  FBReshape_EyePosition = 19,
  FBReshape_EyeAngle = 20,
  FBReshape_EyeCornerOpen = 21,
  FBReshape_LowerEyelid = 22,
  FBReshape_BrowPosition = 23,
  FBReshape_BrowDistance = 24,
  FBReshape_BrowThickness = 25,
};

Body reshape

setBodyReshape:intensity: — intensity [0.0, 1.0], 0 off. Requires resource_body.fbd via addResourcePack: first. FBBodyReshape values 0–8. See Parameter enums and Optional resource packs.

typedef NS_ENUM(NSInteger, FBBodyReshape) {
  FBBodyReshape_BodySlim = 0,
  FBBodyReshape_WaistSlim = 1,
  FBBodyReshape_LegSlim = 2,
  FBBodyReshape_ShoulderSlim = 3,
  FBBodyReshape_ArmSlim = 4,
  FBBodyReshape_LegLong = 5,
  FBBodyReshape_BustEnhance = 6,
  FBBodyReshape_LegStretch = 7,
  FBBodyReshape_TorsoLong = 8,
};

FBSmoothingStyle: Natural, Texture, Smooth. FBWhiteningStyle: ColdWhite, PinkWhite, WarmWhite, Wheat, Tan.

Makeup

Intensity methods take [0, 1]. Shape / color types: Parameter enums.

Intensity	Style	Color
`setLipstick:`	—	`setLipstickColor:`
`setBlush:`	`setBlushStyle:`	`setBlushColor:`
`setContour:`	`setContourStyle:`	—
`setEyeShadow:`	`setEyeShadowStyle:`	`setEyeShadowColor:`
`setEyeLiner:`	`setEyeLinerStyle:`	`setEyeLinerColor:`
`setEyebrow:`	`setEyebrowStyle:`	`setEyebrowColor:`
`setEyelash:`	`setEyelashStyle:`	`setEyelashColor:`
`setPupil:`	—	`setPupilColor:`

Virtual background and chroma key

Method	Description
`setChromaKey:`	Mask from green / blue / red. Fill is still blur or image.
`clearChromaKey`	Restore portrait-segmentation mask; does not clear fill
`setChromaKeySimilarity:`	Key tightness `[0, 1]`
`setChromaKeySmoothness:`	Edge feather `[0, 1]`
`setChromaKeyDesaturation:`	Spill suppression `[0, 1]`
`setVirtualBackgroundBlur:`	Blur fill `[0, 1]`; `0` clears virtual background
`setVirtualBackground:`	png/jpg file path (must be non-empty)
`setVirtualBackgroundWithData:`	Encoded png/jpg `NSData`
`clearVirtualBackground`	Clear blur and image fill

typedef NS_ENUM(NSInteger, FBChromaKeyColor) {
  FBChromaKeyColor_Green = 0,
  FBChromaKeyColor_Blue,
  FBChromaKeyColor_Red,
};

Filters and stickers

No register-by-id. Path or bytes; GPU resources are created on the next processImage: (GL thread / external context).

Method	Description
`setFilter:`	LUT from `.fbd` path
`setFilterWithData:`	LUT from `.fbd` bytes
`clearFilter`	Remove LUT
`setFilterIntensity:`	`[0, 1]`
`setSticker:`	2D sticker `.fbd` path
`setStickerWithData:`	Sticker bytes
`addResourcePack:`	Extra capability pack path (`resource_3d.fbd` before `set3DSticker:`, or `resource_body.fbd` before `setBodyReshape:`)
`addResourcePackWithData:`	Extra pack bytes
`set3DSticker:`	3D sticker `.fbd` path
`set3DStickerWithData:`	3D sticker bytes
`clear3DSticker`	Remove the 3D sticker
`clearSticker`	Remove sticker

Empty path / nil or empty NSData → FBErrorCode_InvalidArgument.

Process

- (FBImageFrame * _Nullable)processImage:(FBImageFrame *)imageFrame;

Reads imageFrame.type (FBFrameTypeImage or FBFrameTypeVideo). Output format matches input. Returns nil on failure.

Error codes

typedef NS_ENUM(NSInteger, FBErrorCode) {
  FBErrorCode_Success = 0,
  FBErrorCode_InvalidArgument = -1,
  FBErrorCode_NotInitialized = -2,
  FBErrorCode_License = -3,
  FBErrorCode_Unsupported = -4,
  FBErrorCode_IO = -5,
  FBErrorCode_NoSlot = -6,
  FBErrorCode_Process = -7,
  FBErrorCode_OutOfMemory = -8,
};

-1 is invalid argument. -2 is not initialized.

Stats and callbacks

`FBEngineStats`

Property	Type	Description
`fps`	`double`	Frames per second
`avgProcessTimeMs`	`double`	Average `processImage:` time (ms)
`sessionTimeS`	`double`	Session duration (seconds)

- (FBEngineStats *)getStats;

`FBEngineEventCode`

Value	Symbol
`0`	`FBEngineEventCodeLicenseValidationSuccess`
`1`	`FBEngineEventCodeLicenseValidationFailed`
`100`	`FBEngineEventCodeInitializationComplete`
`101`	`FBEngineEventCodeInitializationFailed`

`FBEngineCallbacks`

FB_OBJC_API @interface FBEngineCallbacks : NSObject
@property(nonatomic, copy, nullable) void (^onFaceLandmarks)
    (NSArray<FBFaceDetectionResult *> * _Nullable results);
@property(nonatomic, copy, nullable) void (^onEngineEvent)
    (FBEngineEventCode code, NSString * _Nullable message);
@end

Face result types

FB_OBJC_API @interface FBPoint2d : NSObject
@property(nonatomic, assign) float x;
@property(nonatomic, assign) float y;
- (instancetype)initWithX:(float)x y:(float)y;
@end

FB_OBJC_API @interface FBRect : NSObject
@property(nonatomic, assign) float x;
@property(nonatomic, assign) float y;
@property(nonatomic, assign) float width;
@property(nonatomic, assign) float height;
- (instancetype)initWithX:(float)x y:(float)y width:(float)width height:(float)height;
@end

FB_OBJC_API @interface FBFaceDetectionResult : NSObject
@property(nonatomic, strong) FBRect *rect;
@property(nonatomic, copy, nullable) NSArray<FBPoint2d *> *keyPoints;  // 111 points
@property(nonatomic, copy, nullable) NSArray<NSNumber *> *visibility;  // [0, 1]
@property(nonatomic, assign) int faceId;
@property(nonatomic, assign) float score;
@property(nonatomic, assign) float pitch;  // up -, down +; [-π, π]
@property(nonatomic, assign) float roll;   // left -, right +
@property(nonatomic, assign) float yaw;    // left -, right +
@end

`FBImageFrame`

Create

Method	Notes
`createWithData:width:height:format:`	Raw buffer + `FBImageFormat`
`createWithRGBA:width:height:stride:`
`createWithBGRA:width:height:stride:`
`createWithRGB:width:height:stride:`
`createWithBGR:width:height:stride:`
`createWithI420:...`	Y / U / V planes
`createWithNV12:...`	Y + UV
`createWithNV21:...`	Y + VU
`createWithFile:`	png / jpg path
`createWithTexture:width:height:stride:`	`GL_TEXTURE_2D` in the current context; `stride` usually `width * 4`
`createWithUIImage:`	iOS only

Operations

Method	Description
`rotate:`	`FBImageRotation`; returns `FBErrorCode`
`mirror:`	`"horizontal"` / `"vertical"` / `"both"` (case-insensitive); mutates pixels
`setMirror:`	Flag for `processImage:` (avoids extra conversions). `nil` / `@""` clears
`convert:`	Returns a new frame in the target `FBImageFormat`
`toFile:quality:`	quality `0`–`100`
`toFile:`	quality `90`

Properties and accessors

width, height, stride, size, type. Methods: data, format, texture (0 if not a texture). YUV: dataY / dataU / dataV / dataUV, strideY / strideU / strideV / strideUV (NULL / 0 if not YUV).

typedef NS_ENUM(NSInteger, FBImageFormat) {
  FBImageFormatI420,
  FBImageFormatNV12,
  FBImageFormatNV21,
  FBImageFormatBGRA,
  FBImageFormatRGBA,
  FBImageFormatBGR,
  FBImageFormatRGB,
  FBImageFormatTexture,
};

typedef NS_ENUM(NSInteger, FBImageRotation) {
  FBImageRotation0,
  FBImageRotation90,   // clockwise
  FBImageRotation180,
  FBImageRotation270,
};

FBImageFrame *frame = [FBImageFrame createWithUIImage:image];
frame.type = FBFrameTypeImage;
FBImageFrame *out = [engine processImage:frame];

Makeup / style enums

Objective-C symbols live in FBBeautyParams.h. Do not duplicate meaning tables here — see Parameter enums.

FBSmoothingStyle, FBWhiteningStyle
FBLipstickColor
FBBlushStyle, FBBlushColor
FBContourStyle
FBEyeShadowStyle, FBEyeShadowColor
FBEyeLinerStyle, FBEyeLinerColor
FBEyebrowStyle, FBEyebrowColor
FBEyelashStyle, FBEyelashColor
FBPupilColor

Introduction

Android

iOS

macOS

Windows

Linux

Web

Logging

`FBLogLevel`

`FBLogConfig`

Engine configuration

`FBEngineConfig`

`FBFrameType`

`FBBeautyEffectEngine`

Skin

Reshape

Body reshape

Makeup

Virtual background and chroma key

Filters and stickers

Process

Error codes

Stats and callbacks

`FBEngineStats`

`FBEngineEventCode`

`FBEngineCallbacks`

Face result types

`FBImageFrame`

Create

Operations

Properties and accessors

Makeup / style enums

​Logging

​FBLogLevel

​FBLogConfig

​Engine configuration

​FBEngineConfig

​FBFrameType

​FBBeautyEffectEngine

​Skin

​Reshape

​Body reshape

​Makeup

​Virtual background and chroma key

​Filters and stickers

​Process

​Error codes

​Stats and callbacks

​FBEngineStats

​FBEngineEventCode

​FBEngineCallbacks

​Face result types

​FBImageFrame

​Create

​Operations

​Properties and accessors

​Makeup / style enums

Logging

`FBLogLevel`

`FBLogConfig`

Engine configuration

`FBEngineConfig`

`FBFrameType`

`FBBeautyEffectEngine`

Skin

Reshape

Body reshape

Makeup

Virtual background and chroma key

Filters and stickers

Process

Error codes

Stats and callbacks

`FBEngineStats`

`FBEngineEventCode`

`FBEngineCallbacks`

Face result types

`FBImageFrame`

Create

Operations

Properties and accessors

Makeup / style enums