Android API Reference

This page documents all public classes, methods, and constants in the Perfectly Clear Android SDK (photos.eyeq.pfcsdk.perfectlyclear package). The API is written in Kotlin with native JNI bindings.

V10

The main SDK interface class. Manages the engine lifecycle, image analysis, correction apply, scene detection, and creative look operations.

class V10

Constructor

V10()

Creates a new SDK instance and loads the native libraries.

Engine lifecycle

createEngine

Creates a new engine instance for use in the image processing pipeline. Reuse the engine across multiple images; destroy it when done.

external fun createEngine(): ByteBuffer

Returns a ByteBuffer handle representing the native engine.

destroyEngine

Destroys an engine instance and releases all associated native resources.

external fun destroyEngine(bbEngine: ByteBuffer)

loadAIEngine

Loads AI models into the engine and validates the license. Call this once after createEngine().

external fun loadAIEngine(
    engine: ByteBuffer,
    apiKey: String,
    cert: String,
    modelDynamic: ByteBuffer,
    modelSceneDetection: ByteBuffer,
    modelSkintone: ByteBuffer,
    modelAicolor: ByteBuffer,
    modelFDFront: ByteBuffer,
    modelFDBack: ByteBuffer,
    modelFaceMesh: ByteBuffer,
    modelBlendShape: ByteBuffer,
    useGpu: Boolean
): Int

Parameters:

Returns a positive value on success (bitwise sum of loaded feature flags), or a negative error code on failure.

loadScenePresets

Loads scene detection presets from a .preset file buffer.

external fun loadScenePresets(engine: ByteBuffer, scenePresets: ByteBuffer): Int

loadAddonLooks

Loads creative looks from a .looks file buffer. Use this when the filesystem is not available.

external fun loadAddonLooks(engine: ByteBuffer, addonLooks: ByteBuffer): Int

Image processing

calc

Performs initial analysis on an image and creates a profile containing detected faces, noise levels, and scene data.

external fun calc(
    width: Int,
    height: Int,
    stride: Int,
    @PixelFormat pixelFormat: Int,
    buffer: ByteBuffer,
    widthds: Int = 0,
    heightds: Int = 0,
    strideds: Int = 0,
    bufferds: ByteBuffer? = null,
    engine: ByteBuffer,
    bFastFAE: Int = 0,
    bNoTintCalc: Int = 0
): ByteBuffer

Parameters:

Returns a ByteBuffer profile handle. Release it with releaseProfile() when done.

apply

Applies correction parameters to an image pixel buffer in place.

external fun apply(
    width: Int,
    height: Int,
    stride: Int,
    @PixelFormat pixelFormat: Int,
    buffer: ByteBuffer,
    engine: ByteBuffer,
    profile: ByteBuffer,
    param: PFCParam
): Int

Parameters:

Returns APPLY_SUCCESS (0) on success, or a negative APPLY_* error code.

autoCorrect

Single convenience function that performs the full correction pipeline (calc + apply) in one call. Suitable for batch processing where you do not need to inspect the profile.

external fun autoCorrect(
    width: Int, height: Int, stride: Int,
    @PixelFormat pixelFormat: Int, buffer: ByteBuffer,
    widthds: Int, heightds: Int, strideds: Int, bufferds: ByteBuffer,
    param: PFCParam, bFastFAE: Int
): Int

autoCorrectPreset

Same as autoCorrect but uses a built-in preset ID instead of a PFCParam.

external fun autoCorrectPreset(
    width: Int, height: Int, stride: Int,
    @PixelFormat pixelFormat: Int, buffer: ByteBuffer,
    widthds: Int, heightds: Int, strideds: Int, bufferds: ByteBuffer,
    @PresetId presetID: Int, bFastFAE: Int
): Int

Scene detection and presets

getDetectedScene

Returns the canonical scene label detected during calc().

external fun getDetectedScene(profile: ByteBuffer): Int

readScenePreset

Populates a PFCParam with tuned settings for a detected scene. Requires scene presets to have been loaded with loadScenePresets().

external fun readScenePreset(param: PFCParam, engine: ByteBuffer, scene: Int): Int

setParam

Initializes a PFCParam with a built-in preset.

external fun setParam(param: PFCParam, @PresetId id: Int): Int

readPresets

Loads settings from a .preset file on disk into a PFCParam. The first preset in the file is used.

external fun readPresets(param: PFCParam, filename: String): Int

readPresetsFromStream

Loads settings from a preset XML string into a PFCParam.

external fun readPresetsFromStream(param: PFCParam, s: String): Int

Strength and analysis

applyStrengthToParam

Applies an overall strength multiplier to all parameters. Range 0–200, where 100 is the default (no change).

external fun applyStrengthToParam(param: PFCParam, strength: Int): Int

getDetectedSkintoneParams

Populates PFCParam with detected skin tone values from the profile. Sets core_bSkintoneAuto = true and core_iSkintoneAutoStrength = 100.

external fun getDetectedSkintoneParams(profile: ByteBuffer, param: PFCParam): Int

abnormalTintDetected

Queries whether abnormal tint was detected at a given detection sensitivity.

external fun abnormalTintDetected(
    profile: ByteBuffer,
    @TintCorrection tintMethod: Int
): Boolean

isNoiseDetected

Queries whether noise was detected above a given preset threshold.

external fun isNoiseDetected(profile: ByteBuffer, iNoisePreset: Int): Boolean

Face detection

fbFaceCount

Returns the number of faces detected for Face Beautification.

external fun fbFaceCount(profile: ByteBuffer): Int

getFaceInfo

Fills a FaceInfo object with bounding box and eye coordinates for the face at the given index.

external fun getFaceInfo(profile: ByteBuffer, pFace: FaceInfo, index: Int): Boolean

faeFaceCount

Returns the number of faces detected for Face Aware Exposure.

external fun faeFaceCount(profile: ByteBuffer): Int

getFAEFaceRect

Fills a FaceRect object with detailed face geometry and attributes for the face at the given index.

external fun getFAEFaceRect(profile: ByteBuffer, pFace: FaceRect, index: Int): Boolean

hasFaceBeautification

Checks whether Face Beautification models are loaded and available.

external fun hasFaceBeautification(engine: ByteBuffer): Boolean

Status

profileStatus

Returns the status of the profile calculation.

external fun profileStatus(profile: ByteBuffer): Int

coreStatus

Returns the status of core correction precalculation.

external fun coreStatus(profile: ByteBuffer): Int

fbStatus

Returns the status of Face Beautification precalculation.

external fun fbStatus(profile: ByteBuffer): Int

nrStatus

Returns the status of Noise Reduction precalculation.

external fun nrStatus(profile: ByteBuffer): Int

reStatus

Returns the status of Red Eye precalculation.

external fun reStatus(profile: ByteBuffer): Int

getREStatus

Returns the status of Red Eye correction (alternate accessor).

external fun getREStatus(profile: ByteBuffer): Int

returnCodeCore

Extracts the core correction status from a combined apply result code.

fun returnCodeCore(code: Int): Int

returnCodeFB

Extracts the Face Beautification status from a combined apply result code.

fun returnCodeFB(code: Int): Int

returnCodeNR

Extracts the Noise Reduction status from a combined apply result code.

fun returnCodeNR(code: Int): Int

returnCodeRE

Extracts the Red Eye status from a combined apply result code.

fun returnCodeRE(code: Int): Int

Memory management

allocNativeBuffer

Allocates a native ByteBuffer of the given capacity. Use this for pixel data buffers.

external fun allocNativeBuffer(capacity: Int): ByteBuffer?

freeNativeBuffer

Deallocates a buffer previously allocated with allocNativeBuffer.

external fun freeNativeBuffer(b: ByteBuffer?)

getMemorySize

Returns the total native memory size in bytes.

external fun getMemorySize(): Long

getMemoryUsed

Returns the amount of native memory currently in use.

external fun getMemoryUsed(): Long

getMemoryAvailable

Returns the amount of native memory available.

external fun getMemoryAvailable(): Long

setMemoryLimit

Sets the memory limit as a fraction of total memory (e.g. 0.8f = 80%).

external fun setMemoryLimit(limit: Float)

Creative looks (LUT)

getLooks3DLut

Returns the 3D LUT data for a creative look identified by its GUID. The output is a 16×16×16 RGB lookup table written into the provided FloatArray.

external fun getLooks3DLut(
    engine: ByteBuffer,
    lookGuid: String,
    strength: Int,
    contrast: Int,
    saturation: Int,
    final3Dlut: FloatArray
): Int

setAddonPath

Sets the directory path where the SDK searches for add-on files (e.g. .looks).

external fun setAddonPath(s: String)

releaseAddonPath

Releases resources from a previous setAddonPath call.

external fun releaseAddonPath()

Utility

releaseProfile

Releases a profile handle and its associated native resources.

external fun releaseProfile(profile: ByteBuffer)

checkCertificate

Validates a license key and certificate. Returns the number of days remaining, -1 if expired, or -2 if the key/cert combination is invalid.

external fun checkCertificate(apiKey: String, certificate: String): Int

getVersion

Returns the SDK version string.

fun getVersion(): String

getGitCommitSha

Returns the git commit SHA of the SDK build.

fun getGitCommitSha(): String

PFCParam

Image processing parameters. Pass an instance to V10.apply() to control which corrections are applied and at what strength.

class PFCParam

Each correction group has an enable flag (core_bEnabled, fb_bEnabled, nr_bEnabled, re_bEnabled) that must be true for its settings to take effect.

Constructor

PFCParam()

Creates a parameter object with default values.

Methods

reset

Resets all parameters to default values.

fun reset()

read

Copies all parameter values from another PFCParam instance.

fun read(pfcParam: PFCParam)

Core correction parameters

Enable flags

Enum/mode settings

Float parameters

Integer parameters

Skin tone parameters

Color parameters

Face Beautification parameters

Enable flags

Level parameters (all Int, range 0–100)

Mode/type parameters

Color parameters

Noise Reduction parameters

Red Eye parameters

V3 advanced parameters

Enable flags

Dynamic and white balance

Portrait light

Color channels

Finishing tools (all Int, range -100–100)

Color and density

Creative looks (LUT)

Input LUTs

FaceInfo

Face geometry data returned by V10.getFaceInfo() for Face Beautification.

class FaceInfo

Properties

FaceRect

Detailed face geometry with attributes, returned by V10.getFAEFaceRect() for Face Aware Exposure.

class FaceRect

Properties

Face bounding box

Left eye

Right eye

Image dimensions

Attributes

SelectiveColor

Per-hue-range color adjustment model. Eight instances are stored in PFCParam.core_oSelectiveColor.

class SelectiveColor

Properties

Constants

All constants are defined as properties on V10.Companion and accessed via V10.CONSTANT_NAME.

Pixel formats

Preset IDs

Apply status codes

Aggressiveness

Bias modes

Contrast types

DCF modes

Catchlight types

Skin modes

Skin smooth types

Skin toning types

Lip sharpen types

Tint correction modes