Error Handling

Beauty setters return int. Compare against ErrorCode. Construction and processImage can also throw or return null.

ErrorCode

public final class ErrorCode {
  public static final int SUCCESS = 0;
  public static final int INVALID_ARGUMENT = -1;
  public static final int NOT_INITIALIZED = -2;
  public static final int LICENSE = -3;
  public static final int UNSUPPORTED = -4;
  public static final int IO = -5;
  public static final int NO_SLOT = -6;
  public static final int PROCESS = -7;
  public static final int OUT_OF_MEMORY = -8;
}

Value	Constant	Typical cause
`0`	`SUCCESS`	Call succeeded
`-1`	`INVALID_ARGUMENT`	`null` / empty path, empty `byte[]`, `null` callbacks
`-2`	`NOT_INITIALIZED`	Engine not initialized, or already released
`-3`	`LICENSE`	Token / online auth rejected
`-4`	`UNSUPPORTED`	Format or feature not available
`-5`	`IO`	Missing `.fbd`, unreadable image, log file path
`-6`	`NO_SLOT`	Resource limit reached
`-7`	`PROCESS`	Frame processing failed
`-8`	`OUT_OF_MEMORY`	Out of memory

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

int ret = engine.setSmoothing(0.5f);
if (ret != ErrorCode.SUCCESS) {
    Log.e(TAG, "setSmoothing failed: " + ret);
}

Construction

new BeautyEffectEngine(context, config) throws IllegalArgumentException when:

context or config is null
config.isValid() is false (no licenseToken and missing appId / appKey)

It does not return null.

BeautyEffectEngine.EngineConfig config = new BeautyEffectEngine.EngineConfig();
config.appId = "your_app_id";
config.appKey = "your_app_key";
// config.licenseToken = "...";

BeautyEffectEngine engine;
try {
    engine = new BeautyEffectEngine(this, config);
} catch (IllegalArgumentException e) {
    Log.e(TAG, "EngineConfig invalid", e);
    return;
}

License and resource init can still fail asynchronously. Subscribe to engine events:

EngineCallbacks callbacks = new EngineCallbacks();
callbacks.onEngineEvent = (code, message) -> {
    if (code == EngineEventCode.LICENSE_VALIDATION_FAILED
        || code == EngineEventCode.INITIALIZATION_FAILED) {
        Log.e(TAG, "engine event " + code + ": " + message);
    }
};
engine.setCallbacks(callbacks);

`EngineEventCode`	Value
`LICENSE_VALIDATION_SUCCESS`	`0`
`LICENSE_VALIDATION_FAILED`	`1`
`INITIALIZATION_COMPLETE`	`100`
`INITIALIZATION_FAILED`	`101`

Auth troubleshooting: Auth & License. Enable logging before construct — see Implement Beauty.

processImage

if (input == null || !input.isValid()) {
    Log.e(TAG, "Invalid input frame");
    return null;
}
if (input.type == null) {
    input.type = ImageFrame.FrameType.VIDEO;
}

ImageFrame output;
try {
    output = engine.processImage(input);
} catch (IllegalArgumentException e) {
    Log.e(TAG, "processImage rejected the frame", e);
    return null;
}
if (output == null) {
    Log.e(TAG, "processImage returned null (engine released or native failure)");
    return null;
}

null input or null type → IllegalArgumentException
Engine already release()d → null (no exception)
Always release() both input and output in a finally block

ImageFrame output = null;
try {
    input.type = ImageFrame.FrameType.VIDEO;
    output = engine.processImage(input);
    return output;
} finally {
    if (input != null) {
        input.release();
    }
}

If you convert the output (convert, toBitmap), release the extra frame too.

Filters, stickers, virtual background

Empty path or empty byte[] returns ErrorCode.INVALID_ARGUMENT. Missing files typically return ErrorCode.IO.

int ret = engine.setFilter(fbdPath);
if (ret == ErrorCode.INVALID_ARGUMENT) {
    Log.e(TAG, "Filter path empty");
} else if (ret == ErrorCode.IO) {
    Log.e(TAG, "Cannot read .fbd: " + fbdPath);
} else if (ret != ErrorCode.SUCCESS) {
    Log.e(TAG, "setFilter: " + ret);
}

Filter / sticker changes take effect on the next processed frame. A successful setter does not prove the texture uploaded; watch later processImage results and SDK logs.

Logging setup

setLogConfig throws if config or level is null. Create parent directories before enabling file logs.

File logFile = new File(getFilesDir(), "facebetter.log");
File parent = logFile.getParentFile();
if (parent != null && !parent.exists() && !parent.mkdirs()) {
    Log.e(TAG, "Cannot create log dir");
    return;
}
BeautyEffectEngine.LogConfig logConfig = new BeautyEffectEngine.LogConfig();
logConfig.consoleEnabled = true;
logConfig.fileEnabled = true;
logConfig.level = BeautyEffectEngine.LogLevel.DEBUG;
logConfig.fileName = logFile.getAbsolutePath();
BeautyEffectEngine.setLogConfig(logConfig);

Out of memory

ErrorCode.OUT_OF_MEMORY or OutOfMemoryError usually means frames are not released, resolution is too high, or heap/direct buffers accumulated.

Use ByteBuffer.allocateDirect for camera / packed pixels
Release every ImageFrame (including convert results)
Prefer FrameType.VIDEO for live camera
Do not construct a new engine every frame

Stats for slow frames

EngineStats stats = engine.getStats();
if (stats.avgProcessTimeMs > 33) {
    Log.w(TAG, "Slow pipeline: " + stats.avgProcessTimeMs + " ms, fps=" + stats.fps);
}

Introduction

Android

iOS

macOS

Windows

Linux

Web

ErrorCode

Construction

processImage

Filters, stickers, virtual background

Logging setup

Out of memory

Stats for slow frames

​ErrorCode

​Construction

​processImage

​Filters, stickers, virtual background

​Logging setup

​Out of memory

​Stats for slow frames

ErrorCode

Construction

processImage

Filters, stickers, virtual background

Logging setup

Out of memory

Stats for slow frames