Interface AvatarsConfig

Options accepted by loadAvatars to configure the avatars effect.

interface AvatarsConfig {
    faceLandmarker: Partial<FaceLandmarkerConfig>;
    faceScaleFactor: number;
    modelUrl: string;
    threeJs: ThreeJS;
}

Properties

faceLandmarker: Partial<FaceLandmarkerConfig>

Optional overrides for the MediaPipe face-landmarker resources. Any field left unset falls back to the SDK's default CDN URLs.

faceScaleFactor: number

How much larger the avatar appears relative to the detected face. Default: 1.75.

modelUrl: string

URL of the avatar .glb model to load.

threeJs: ThreeJS

Three.js core and GLTFLoader (URLs or pre-loaded modules).