API Document

type SegmentationLevel = 0 | 1 | 2 // since version 1.0.19 
type ModuleConfig = {
  beautify: boolean // The default is `true`.
  segmentation: boolean // The default is `false`
  segmentationLevel: SegmentationLevel // The default is 0.
  handGesture: boolean // Whether to enable gesture recognition, default is false. Supported in versions after 1.0.23.
  handLandmark: boolean // Whether to enable hand tracking, default is false. Supported in versions after 1.0.23. It is not recommended to enable this simultaneously with beautify.
}

type AuthConfig = {
  licenseKey: string // It can be obtained on the **Web licenses** page in the console.
  appId: string // It can be viewed in **Account Info** > **Basic Info** in the console.
  authFunc:() => Promise<{
    signature:string,
    timestamp:string
  }> // Refer to the license configuration.
}

type CameraConfig = {
    width: number, // The video width.
    height: number, // The video height.
    mirror: boolean, // Whether to horizontally flip the video.
    frameRate: number // The capturing frame rate.
}

type BeautifyOptions = {
      whiten?: number, // The brightening effect. Value range: 0-1.
      dermabrasion?: number // The smooth skin effect. Value range: 0-1.
      lift?: number // The slim face effect. Value range: 0-1.
      shave?: number // The face width. Value range: 0-1.
      eye?: number // The big eyes effect. Value range: 0-1.
      chin?: number // The chin effect. Value range: 0-1.
   // The following parameters are only available since version 1.0.11
      darkCircle?: number; // The dark circle effect. Value range: 0-1.
      nasolabialFolds?: number; // The nasolabial folds effect. Value range: 0-1.
      cheekbone?: number; // The cheek bone effect. Value range: 0-1.
      head?: number; // The head effect. Value range: 0-1.
      eyeBrightness?: number; // The eye brightness effect. Value range: 0-1.
      lip?: number; // The lip effect. Value range: 0-1.
      forehead?: number; // The forehead effect. Value range: 0-1.
      nose?: number; // The nose effect. Value range: 0-1.
      usm?: number; // The distinct effect. Value range: 0-1.
}

type BackgroundOptions = {
    type: 'image' | 'blur' | 'transparent' | 'video',  // from version 1.0.23, support video-type dynamic background.
    src?: string, // image | video file address
    edgeBlur ?: number, // supported from version 1.0.25, Range of values: 0-10, which controls the edge blur intensity. The smaller the value, the sharper the edge cut and the lower the blur intensity.
}

type loadingConfig = {
    enable: boolean,
    size?: number
    lineWidth?: number
    strokeColor?: number
}

type proxyServeConfig = {
  webarProxy: string; // Intranet address of the interface proxy
  staticProxy: string; // Intranet address of the resource proxy
}

type BeautifyOptions = {
  whiten?: number, // The brightening effect. Value range: 0-1.
  dermabrasion?: number // The smooth skin effect. Value range: 0-1.
  lift?: number // The slim face effect. Value range: 0-1.
  shave?: number // The face width. Value range: 0-1.
  eye?: number // The big eyes effect. Value range: 0-1.
  chin?: number // The chin shaping effect. Value range: 0-1.
  darkCircle?: number; // The dark circle effect. Value range: 0-1.
  nasolabialFolds?: number; // The nasolabial folds effect. Value range: 0-1.
  cheekbone?: number; // The cheek bone effect. Value range: 0-1.
  head?: number; // The head effect. Value range: 0-1.
  eyeBrightness?: number; // The eye brightness effect. Value range: 0-1.
  lip?: number; // The lip effect. Value range: 0-1.
  forehead?: number; // The forehead effect. Value range: 0-1.
  nose?: number; // The nose effect. Value range: 0-1.
  usm?: number; // The distinct effect. Value range: 0-1.
}

{
    mode: 'AR' | 'VR',
    effectId?: string, // Pass through `effectId` to use the built-in model
    url?: string, // Pass through `url` to use the custom model
    backgroundUrl?: string, // Background image URL, which takes effect only in VR mode.
}

{
    type: 'image|video|blur|transparent', // from version 1.0.23, support video-type dynamic background.
    src: string, // This parameter is required only if `type` is `image` or `video`.
    edgeBlur: number, // supported from version 1.0.25, Range of values: 0-10, which controls the edge blur intensity. The smaller the value, the sharper the edge cut and the lower the blur intensity.
}

{
    type: 'image|video',
    src: string // Resource Path: Base64 or Online URL
}

{
    PageNumber: number, // page number, default is 0
    PageSize: number,// page size,default is 1000
    Name: '', // effect name
    Label: string | Array, // effect label
    Type: 'Custom' | 'Preset' // Custom effect or Preset effect
}

type = 'AR' | 'VR'


{
  input?:MediaStream|HTMLImageElement|String; // The input source 
  camera?:CameraConfig; // Only for camera mode
  mirror?:boolean;  // Mirror or not
}

{
width: number;// image render width
height: number; // image render height
input: string;// image src
}

enum OUTPUT_TYPES {
  IMAGE = 3,
  MEDIA_STREAM = 4,
}

{
    data: Uint8Array, 
    width: number, 
    height: number
}