Quick Start

This page matches SDK 2.0.0. Auth: Auth & License. Makeup / reshape enums: Parameter enums.

Environment Requirements

macOS Version: macOS 10.15 and above
Development Language: Objective-C (AppKit / NSImage)
Architecture Support: x86_64, arm64 (Apple Silicon)

Get Sample Source Code

Clone the GitHub repository locally, and navigate to the demo/macos directory.

# clone
git clone https://github.com/pixpark/facebetter-sdk.git

# Enter macOS Demo directory
cd facebetter-sdk/demo/macos

# Install dependencies
pod install

Xcode 15+ compilation errorIf you are using Xcode 15 or later, you might encounter a Sandbox: rsync.samba deny(1) error during compilation. This is caused by Xcode’s default User Script Sandboxing.Solution:

Select your Project in Xcode.
Navigate to the Build Settings tab.
Search for ENABLE_USER_SCRIPT_SANDBOXING.
Change its value from Yes to No.

Configure Application Information and Keys

Bind Application Bundle ID

Follow Bind Application Information to bind your macOS application Bundle ID in the console, for example: com.example.app.

Get credentials

Follow Get AppID and AppKey to obtain appId and appKey. Open demo/macos/FBExampleObjc/BeautyCameraViewController.m and set credentials on FBEngineConfig.

FBEngineConfig *engineConfig = [[FBEngineConfig alloc] init];
engineConfig.appId = @"your appId";
engineConfig.appKey = @"your appKey";
// Preferred: licenseToken (license token, {token} JSON, or .lic contents)
// engineConfig.licenseToken = @"your license token";

self.beautyEffectEngine = [FBBeautyEffectEngine createEngineWithConfig:engineConfig];

If licenseToken is non-empty, the SDK validates that token locally and does not call /facebetter/v2/auth with appId / appKey. See Auth & License.

Run the Project

Open demo/macos/FBExampleObjc.xcworkspace.

Ensure Xcode project signing is correct.

Allow outgoing network access if you use online appId / appKey auth (App Sandbox).

Build and run.

Select a Mac (or Simulator) and click the build and run button.

Introduction

Android

iOS

macOS

Windows

Linux

Web

Environment Requirements

Get Sample Source Code

Configure Application Information and Keys

Bind Application Bundle ID

Get credentials

Run the Project

​Environment Requirements

​Get Sample Source Code

​Configure Application Information and Keys

​Bind Application Bundle ID

​Get credentials

​Run the Project

Environment Requirements

Get Sample Source Code

Configure Application Information and Keys

Bind Application Bundle ID

Get credentials

Run the Project