Skip to main content

React API references

Capture IQ is not initialized through GlamAR.init. It is a custom element you put in the DOM; you pass options as attributes (or JSON config) and call methods on the element reference.

Element and React​

  • Tag: <glamar-captureiq>
  • Attributes: Use JSX kebab-case for DOM attributes such as api-key, preset, and optional config (stringified JSON when needed). Full detail: Configuration.
  • Imperative API: Obtain a ref (useRef) to the host element and call async methods: init(), start(), pause(), resume(), capture(), cancel(), destroy().
  • Events: Use addEventListener / removeEventListener on the same element. Naming and payloads: Events.

Method reference​

See the dedicated page for signatures, return values, and error behavior:

Capture IQ methods

Event reference​

Capture IQ events

Configuration reference​

Capture IQ configuration

Together, these pages are the source of truth for the Web Component. The React setup guide shows how to wire them in a typical React app with hooks and cleanup.