API Reference ​

Component ​

LiqaEventMap ​

LiqaEventMap: object

LiqaEventMap: object

LIQA event names and corresponding event details.

Type declaration ​

FEATURE ​

const FEATURE: object

const FEATURE: object

Type declaration ​

Feature ​

Feature: typeof FEATURE[keyof typeof FEATURE]

Feature: typeof FEATURE[keyof typeof FEATURE]

LiqaAttributes ​

LiqaAttributes: object

LiqaAttributes: object

LIQA Web component HTML attributes to configure the component look and behavior.

Example ​

<hautai-liqa
  license="xxx-xxx-xxx"
  styles="@import url('/path/to/custom-liqa-styles.css')"
>
</hautai-liqa>

<hautai-liqa
  license="xxx-xxx-xxx"
  styles="@import url('/path/to/custom-liqa-styles.css')"
>
</hautai-liqa>

Type declaration ​

LiqaElement ​

LIQA Web component available as <hautai-liqa></hautai-liqa> tag.

Example ​

<hautai-liqa license="xxx-xxx-xxx"></hautai-liqa>

<hautai-liqa license="xxx-xxx-xxx"></hautai-liqa>

Extends ​

• any

Methods ​

upload ​

upload(files): void

upload(files): void

Programmatically uploads one or more files to LIQA, bypassing the manual file selection UI.

Parameters ​

Returns ​

void

Example ​

// Upload a single file
liqa.upload(file)

// Upload multiple files programmatically
const files = [file1, file2, file3]
liqa.upload(files)

// Upload a single file
liqa.upload(file)

// Upload multiple files programmatically
const files = [file1, file2, file3]
liqa.upload(files)

upload(files): void

upload(files): void

Programmatically uploads one or more files to LIQA.

Parameters ​

Returns ​

void

reset ​

reset(): Promise< void >

reset(): Promise< void >

Programmatically resets LIQA to its initial state, clearing any captured images and stopping the camera.

Returns ​

Promise< void >

Example ​

// Reset LIQA to start over
liqa.reset()

// Reset LIQA to start over
liqa.reset()

reset(): Promise< void >

reset(): Promise< void >

Programmatically resets LIQA to its initial state and resolves after the new session is ready.

Returns ​

Promise< void >

addEventListener ​

addEventListener<K>(
  type,
  listener,
  options?): void

addEventListener<K>(
  type,
  listener,
  options?): void

Subscribes the event listener to the given LIQA event.

Type parameters ​

Parameters ​

Returns ​

void

removeEventListener ​

removeEventListener<K>(
  type,
  listener,
  options?): void

removeEventListener<K>(
  type,
  listener,
  options?): void

Unsubscribes the event listener from the given LIQA event.

Type parameters ​

Parameters ​

Returns ​

void

Component (imperative) ​

Liqa ​

Liqa(config): LiqaElement

Liqa(config): LiqaElement

An imperative way to create LIQA web component.

Parameters ​

Returns ​

LiqaElement

Example ​

const liqa = new Liqa({
  license: "xxx-xxx-xxx",
  target: document.querySelector("#liqa-container"),
  styles: "@import url('/path/to/custom-liqa-styles.css')"
})

const liqa = new Liqa({
  license: "xxx-xxx-xxx",
  target: document.querySelector("#liqa-container"),
  styles: "@import url('/path/to/custom-liqa-styles.css')"
})

Deprecated ​

Use the <hautai-liqa> web component instead.

LiqaConfig ​

LiqaConfig: object

LiqaConfig: object

Options to configure the LIQA‘s look and behavior.

Deprecated ​

Use the <hautai-liqa> web component with the LiqaAttributes instead.

Type declaration ​

Capture ​

ImageCapture ​

Interface for accessing the captured frame in different formats and image types.

Properties ​

Methods ​

blob ​

blob(format?): Promise< Blob >

blob(format?): Promise< Blob >

Converts the captured image to Blob.

Parameters ​

Returns ​

Promise< Blob >

The captured frame as Blob in the specified image format.

Example ​

const imageBlob = await capture.blob()

const imageBlob = await capture.blob()

transform ​

transform(transformations): ImageCapture

transform(transformations): ImageCapture

Parameters ​

Returns ​

ImageCapture

a copy of the ImageCapture with the specified transformations applied.

Example ​

/*
   By default, the image is returned as the camera sees it,
   but it can be flipped horizontally to look like it is in a mirror
*/
const mirroredImageBlob = await capture
   .transform({ horizontalFlip: true })
   .blob()

/*
   By default, the image is returned as the camera sees it,
   but it can be flipped horizontally to look like it is in a mirror
*/
const mirroredImageBlob = await capture
   .transform({ horizontalFlip: true })
   .blob()

CaptureTransformations ​

CaptureTransformations: object

CaptureTransformations: object

Image capture transformations.

Type declaration ​

CaptureFormat ​

CaptureFormat: ImageFormat

CaptureFormat: ImageFormat

Image capture image format.

CaptureMetadata ​

CaptureMetadata: object

CaptureMetadata: object

The capture-related metadata.

Type declaration ​

Analytics ​

AnalyticsEventsMap ​

AnalyticsEventsMap: object

AnalyticsEventsMap: object

LIQA analytics event names and corresponding event payloads. For more information, see CTA Events page.

Type declaration ​

AnalyticsDetails ​

AnalyticsDetails: { [K in keyof AnalyticsEventsMap]: Object }[keyof AnalyticsEventsMap]

AnalyticsDetails: { [K in keyof AnalyticsEventsMap]: Object }[keyof AnalyticsEventsMap]

LIQA analytics event detail.

Example ​

function handleLiqaAnalyticsEvent(event) {
  const { name, payload } = event.detail

  if (name === "photo_capture") {
    if (payload.mode === "auto")
      console.log("LIQA has automatically captured a photo")
    if (payload.mode === "manual")
      console.log("User has manually captured a photo")
  }

  if (name === "photo_upload")
    console.log("User has uploaded a photo")

  if (name === "photo_retake")
    console.log("User decided to retake the photo")
  if (name === "photo_confirm")
    console.log("User has confirmed the photo")
}

function handleLiqaAnalyticsEvent(event) {
  const { name, payload } = event.detail

  if (name === "photo_capture") {
    if (payload.mode === "auto")
      console.log("LIQA has automatically captured a photo")
    if (payload.mode === "manual")
      console.log("User has manually captured a photo")
  }

  if (name === "photo_upload")
    console.log("User has uploaded a photo")

  if (name === "photo_retake")
    console.log("User decided to retake the photo")
  if (name === "photo_confirm")
    console.log("User has confirmed the photo")
}

Errors ​

ErrorCodes ​

Enumeration Members ​

LiqaError ​

Extends ​

• Error

Properties ​

Misc ​

VERSION ​

const VERSION: string

const VERSION: string

The library version.

Example ​

"6.0.0"

"6.0.0"

preload ​

preload(options = {}): Promise< void >

preload(options = {}): Promise< void >

Preloads preset's resources and features in advance. For more information, see Preload Resources page.

Parameters ​

Returns ​

Promise< void >

Example ​

// Preload a preset
preload({ preset: "face" })

// Preload tutorial videos
preload({ feature: "tutorial" })

// Preload both preset and tutorial
preload({ preset: "face", feature: "tutorial" })

// Preload a preset
preload({ preset: "face" })

// Preload tutorial videos
preload({ feature: "tutorial" })

// Preload both preset and tutorial
preload({ preset: "face", feature: "tutorial" })

PreloadOptions ​

PreloadOptions: object

PreloadOptions: object

Type declaration ​