FAQ

​

Integration

​

Engine create / init() failed

• EngineConfig must set a non-empty licenseToken. There are no appId / appKey fields on Web config.
• Production: your server must return the auth API body ({success, token} or error JSON). See Auth & License.
• Confirm the page can download the SDK runtime files (bundler / CDN). See Error handling.
• Confirm the page is HTTPS or localhost.
• Check FacebetterError.code (Error handling).

​

How do I pass AppID / AppKey?

​

Can I use an offline .lic in the browser?

​

How do I update the package?

npm install facebetter@2.0.0

​

Effects

​

Beauty looks weak or too strong

​

Filter / sticker does nothing

​

Virtual background is blank

​

Output is black

​

Performance

​

Preview is slow

​

Memory grows in an SPA

​

Compatibility

​

React example

import { useEffect, useRef } from 'react';
import { BeautyEffectEngine, EngineConfig } from 'facebetter';

function BeautyPreview() {
  const engineRef = useRef(null);

  useEffect(() => {
    let engine;
    (async () => {
      const licenseToken = await fetch('/api/facebetter/auth', { method: 'POST' }).then((r) => r.text());
      engine = new BeautyEffectEngine(new EngineConfig({ licenseToken }));
      engineRef.current = engine;
      await engine.init();
    })().catch(console.error);
    return () => {
      engine?.destroy();
      engineRef.current = null;
    };
  }, []);

  return <canvas />;
}

​

Related

• Quick start
• Implement beauty
• Error handling
• Best practices
• API reference