Web SDK Reference | Get available AR modes

The getAvailableARModes() method can be called to get an list of the available AR modes.

TypeScript

getAvailableARModes(): Promise<ARMode[]>

Returns

Type	Description
`ARMode[]`	An array of AR modes available on the current device TypeScript `type ARMode = 'webxr' \| 'quicklook'`

Example

TypeScript

async function getAvailableARModes() {
  try {
    const arModes = await window.twikit.getAvailableARModes();
    console.log(arModes); // on android returns ['webxr']
  } catch (error) {
    console.error(error);
  }
}