Referência da API

Esta página corresponde ao SDK 2.0.0. Enums de maquiagem / remodelagem / estilo: Enums de parâmetros. Autenticação: Autenticação e licença.

Pacote: facebetter. Import típico:

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

EngineConfig

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

A Web não aceita appId / appKey neste objeto. Um .lic offline precisa corresponder à origem da página. O Electron não verifica a origem. isValid() é verdadeiro quando licenseToken é uma string não vazia. Busque o token no seu servidor antes de init(). Veja Autenticação e licença.

BeautyEffectEngine

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

Ciclo de vida

Método	Descrição
`init(options?)`	Inicializa o mecanismo (autenticação e recursos). `options.timeout` (padrão `120000`) é o timeout de init em ms. `options.onProgress({ loaded, total, percent })` informa o progresso de download dos arquivos de runtime.
`setLogConfig({ consoleEnabled, fileEnabled, level, fileName })`	Config global de log. Chame antes de `init()`. `level`: `0` TRACE … `5` CRITICAL. Logging em arquivo não é suportado no navegador. Retorna `Promise<void>`.
`destroy()`	Libera o mecanismo e seus recursos.

engine.initialized é true após um init() bem-sucedido.

Pele

Método	Faixa
`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`

Remodelagem

setReshape(param, value) — param é Reshape.*, value em [-1.0, 1.0]. Veja Enums de parâmetros.

Remodelagem corporal

setBodyReshape(param, value) — param é BodyReshape.*, value em [0.0, 1.0]. Registre resource_body.fbd com addResourcePack primeiro. Veja Enums de parâmetros e Pacotes de recursos opcionais.

Maquiagem

Intensidade [0, 1]. Enums de estilo / cor: Enums de parâmetros.

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

Filtro / adesivo

Método	Descrição
`setFilter(path \| Uint8Array)`	Aplicar um LUT `.fbd` a partir de URL ou bytes
`clearFilter()`	Remover o filtro atual
`setFilterIntensity(intensity)`	`[0, 1]`
`setSticker(path \| Uint8Array)`	Aplicar um adesivo 2D `.fbd`
`clearSticker()`	Remover o adesivo
`addResourcePack(path \| Uint8Array)`	Registrar um pacote extra (`resource_3d.fbd` antes de `set3DSticker`, ou `resource_body.fbd` antes de `setBodyReshape`)
`set3DSticker(path \| Uint8Array)`	Aplicar um adesivo 3D `.fbd`
`clear3DSticker()`	Remover o adesivo 3D

Fundo virtual / chroma key

Método	Descrição
`setVirtualBackgroundBlur(level)`	Desfoque contínuo `[0, 1]`. `0` limpa
`setVirtualBackground(path \| Uint8Array)`	Caminho png/jpg ou bytes codificados
`clearVirtualBackground()`	Desligar desfoque / imagem
`setChromaKey(color)`	`ChromaKeyColor.Green` / `Blue` / `Red`
`clearChromaKey()`	Voltar à máscara de segmentação de retrato
`setChromaKeySimilarity(value)`	`[0, 1]`
`setChromaKeySmoothness(value)`	`[0, 1]`
`setChromaKeyDesaturation(value)`	`[0, 1]`

Callbacks

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

Processamento

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

input: ImageData | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | Uint8ClampedArray
width / height obrigatórios somente para Uint8ClampedArray
mirrorMode espelha esta imagem de CPU antes do processamento. Web não tem API de rotação. processTexture não espelha nem rotaciona.

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

Retorna um handle de saída GL_TEXTURE_2D. Neste caminho não há espelhamento nem rotação. Prefira processImage.

Estatísticas

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

Enums (JS)

Os valores correspondem ao nativo. Tabelas completas de maquiagem / remodelagem: Enums 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 */ }

Também exportados: 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. Veja Tratamento de erros.

Introdução

Android

iOS

macOS

Windows

Linux

Web

EngineConfig

BeautyEffectEngine

Ciclo de vida

Pele

Remodelagem

Remodelagem corporal

Maquiagem

Filtro / adesivo

Fundo virtual / chroma key

Callbacks

Processamento

Estatísticas

Enums (JS)

FacebetterError

​EngineConfig

​BeautyEffectEngine

​Ciclo de vida

​Pele

​Remodelagem

​Remodelagem corporal

​Maquiagem

​Filtro / adesivo

​Fundo virtual / chroma key

​Callbacks

​Processamento

​Estatísticas

​Enums (JS)

​FacebetterError

EngineConfig

BeautyEffectEngine

Ciclo de vida

Pele

Remodelagem

Remodelagem corporal

Maquiagem

Filtro / adesivo

Fundo virtual / chroma key

Callbacks

Processamento

Estatísticas

Enums (JS)

FacebetterError