@real2u/javascript-ar-sdk

JavaScript SDK for Augmented Reality on the web.

Methods

Defines a global Real2U variable with the following methods

interface Real2U {
  init: (params: {customerId: string}) => Promise<void>;
  isActive: (sku: string) => Promise<boolean>;
  openAR: (params: { sku: string; name: string; resize?: boolean }) => Promise<void>;
  getOpenARLink: (sku: string) => Promise<string>;
  create3DViewer: (params: {
    element: HTMLElement;
    sku: string;
    name: string;
    popup: boolean;
    progressBarPosition?: 'top' | 'middle' | 'bottom';
    poster?: string | null;
  }) => Promise<void>;
}

Integration

Please refer to the real2u-integration repository for more information.