Referencia de la API

Esta página corresponde al SDK 2.0.0. Enumeraciones de maquillaje / remodelado / estilo: Enumeraciones de parámetros. Autenticación: Autenticación y licencia.

Paquete: facebetter. Importación típica:

import {
  BeautyEffectEngine,
  EngineConfig,
  FrameType,
  MirrorMode,
  Reshape,
} from 'facebetter';

EngineConfig

new EngineConfig({
  licenseToken,      // string — required. License token string, or `{token}` JSON
})

Web no acepta appId / appKey en este objeto. Un .lic sin conexión debe coincidir con el origen de la página. Electron no comprueba el origen. isValid() es true cuando licenseToken es una cadena no vacía. Obtén el token desde tu servidor antes de init(). Consulta Autenticación y licencia.

BeautyEffectEngine

const engine = new BeautyEffectEngine(config);
await engine.init({
  onProgress: ({ percent }) => {
    // 0–100 while runtime files download
  },
});

Ciclo de vida

Método	Descripción
`init(options?)`	Inicializa el motor (autenticación y recursos). `options.timeout` (predeterminado `120000`) es el timeout de init en ms. `options.onProgress({ loaded, total, percent })` informa el progreso de descarga de los archivos de runtime.
`setLogConfig({ consoleEnabled, fileEnabled, level, fileName })`	Configuración global de logs. Llama antes de `init()`. `level`: `0` TRACE … `5` CRITICAL. El logging a archivo no se admite en el navegador. Devuelve `Promise<void>`.
`destroy()`	Libera el motor y sus recursos.

engine.initialized es true tras un init() correcto.

Piel

Método	Rango
`setSmoothing(value)`	`[0, 1]`
`setSmoothingStyle(style)`	`SmoothingStyle`
`setWhitening(value)`	`[0, 1]`
`setWhiteningStyle(style)`	`WhiteningStyle`
`setRosiness(value)`	`[0, 1]`
`setBrightness(value)`	`[-1, 1]`
`setContrast(value)`	`[-1, 1]`
`setSaturation(value)`	`[-1, 1]`
`setColorTemperature(value)`	`[-1, 1]`
`setColorTint(value)`	`[-1, 1]`
`setClarity(value)`	`[0, 1]`
`setBeautySkinOnly(enabled)`	`boolean`

Remodelado

setReshape(param, value) — param es Reshape.*, value en [-1.0, 1.0]. Consulta Enumeraciones de parámetros.

Remodelado corporal

setBodyReshape(param, value) — param es BodyReshape.*, value en [0.0, 1.0]. Registra resource_body.fbd con addResourcePack primero. Consulta Enumeraciones de parámetros y Paquetes de recursos opcionales.

Maquillaje

Intensidad [0, 1]. Enumeraciones de estilo / color: Enumeraciones de parámetros.

Intensidad	Estilo / color
`setLipstick`	`setLipstickColor`
`setBlush`	`setBlushStyle`, `setBlushColor`
`setContour`	`setContourStyle`
`setEyeShadow`	`setEyeShadowStyle`, `setEyeShadowColor`
`setEyeLiner`	`setEyeLinerStyle`, `setEyeLinerColor`
`setEyebrow`	`setEyebrowStyle`, `setEyebrowColor`
`setEyelash`	`setEyelashStyle`, `setEyelashColor`
`setPupil`	`setPupilColor`
`setTeethWhiten`	—

Filtro / sticker

Método	Descripción
`setFilter(path \| Uint8Array)`	Aplica un LUT `.fbd` desde URL o bytes
`clearFilter()`	Quita el filtro actual
`setFilterIntensity(intensity)`	`[0, 1]`
`setSticker(path \| Uint8Array)`	Aplica un sticker 2D `.fbd`
`clearSticker()`	Quita el sticker
`addResourcePack(path \| Uint8Array)`	Registra un paquete extra (`resource_3d.fbd` antes de `set3DSticker`, o `resource_body.fbd` antes de `setBodyReshape`)
`set3DSticker(path \| Uint8Array)`	Aplica un sticker 3D `.fbd`
`clear3DSticker()`	Quita el sticker 3D

Fondo virtual / croma

Método	Descripción
`setVirtualBackgroundBlur(level)`	Desenfoque continuo `[0, 1]`. `0` lo borra
`setVirtualBackground(path \| Uint8Array)`	Ruta png/jpg o bytes codificados
`clearVirtualBackground()`	Desactiva desenfoque / imagen
`setChromaKey(color)`	`ChromaKeyColor.Green` / `Blue` / `Red`
`clearChromaKey()`	Vuelve a la máscara de segmentación de retrato
`setChromaKeySimilarity(value)`	`[0, 1]`
`setChromaKeySmoothness(value)`	`[0, 1]`
`setChromaKeyDesaturation(value)`	`[0, 1]`

Callbacks

engine.setCallbacks({
  onEngineEvent,   // (code, message) => void
});

Procesamiento

processImage(input, width, height, frameType = FrameType.Video, mirrorMode = MirrorMode.None) → ImageData

input: ImageData | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | Uint8ClampedArray
width / height solo obligatorios para Uint8ClampedArray
mirrorMode espeja esta imagen de CPU antes de procesar. Web no tiene API de rotación. processTexture no espeja ni rota.

processTexture(textureHandle, width, height, stride, frameType, mirrorMode) → number

Devuelve un handle de salida GL_TEXTURE_2D. En este camino no se aplica espejo ni rotación. Prefiere processImage.

Estadísticas

engine.getStats() → { fps, avgProcessTimeMs, sessionTimeS, gpuLiveTextures, gpuLiveMeshes }

Enumeraciones (JS)

Los valores coinciden con nativo. Tablas completas de maquillaje / remodelado: Enumeraciones de parámetros.

FrameType = { Image: 0, Video: 1 }

MirrorMode = { None: 0, Horizontal: 1, Vertical: 2, Both: 3 }

EngineEventCode = {
  LicenseValidationSuccess: 0,
  LicenseValidationFailed: 1,
  InitializationComplete: 100,
  InitializationFailed: 101,
}

ChromaKeyColor = { Green: 0, Blue: 1, Red: 2 }

Reshape = { FaceThin: 0, FaceVShape: 1, /* … BrowThickness: 25 */ }

También se exportan: SmoothingStyle, WhiteningStyle, LipstickColor, BlushStyle, BlushColor, ContourStyle, EyeShadowStyle, EyeShadowColor, EyeLinerStyle, EyeLinerColor, EyebrowStyle, EyebrowColor, EyelashStyle, EyelashColor, PupilColor.

FacebetterError

class FacebetterError extends Error {
  constructor(message, code = -1)
  // name === 'FacebetterError'
  // code: number or string
}

Códigos numéricos: 0, -1 … -7. Consulta Manejo de errores.

Introducción

Android

iOS

macOS

Windows

Linux

Web

EngineConfig

BeautyEffectEngine

Ciclo de vida

Piel

Remodelado

Remodelado corporal

Maquillaje

Filtro / sticker

Fondo virtual / croma

Callbacks

Procesamiento

Estadísticas

Enumeraciones (JS)

FacebetterError

​EngineConfig

​BeautyEffectEngine

​Ciclo de vida

​Piel

​Remodelado

​Remodelado corporal

​Maquillaje

​Filtro / sticker

​Fondo virtual / croma

​Callbacks

​Procesamiento

​Estadísticas

​Enumeraciones (JS)

​FacebetterError

EngineConfig

BeautyEffectEngine

Ciclo de vida

Piel

Remodelado

Remodelado corporal

Maquillaje

Filtro / sticker

Fondo virtual / croma

Callbacks

Procesamiento

Estadísticas

Enumeraciones (JS)

FacebetterError