Banuba SDK Web AR Getting Started

Requirements#

The latest Banuba SDK Web AR release
Banuba client token
An AR effect
Nodejs installed
Browser with support of WebGL 2.0

Obtaining Banuba SDK Web AR#

To get the latest Banuba SDK Web AR release please fill in the form on banuba.com website, or contact us via info@banuba.com.

Obtaining Banuba Client token#

Banuba Client token is required to get Banuba SDK Web AR working.

Generally it's delivered with Banuba SDK Web AR archive.

To receive a new trial client token please fill in the form on banuba.com website, or contact us via info@banuba.com.

Usage#

Create an HTML page like this:

<!DOCTYPE HTML>
<html>
  <head>
    <title>Banuba SDK Web AR</title>
  </head>
  <body>
    <div id="webar"></div>
    <script type="module">
      import { Webcam, Effect, Player, Dom } from "./BanubaSDK.js"

      const run = async () => {
        const player = await Player.create({ clientToken: "PUT YOUR CLIENT TOKEN HERE" })

        player.use(new Webcam())

        player.applyEffect(new Effect("Spider.zip"))

        Dom.render(player, "#webar")
      }

      run()
    </script>
  </body>
</html>

Put BanubaSDK.js, BanubaSDK.wasm, BanubaSDK.data and Spider.zip next to the created HTML page.

Run the command in the folder to start a web server:

npx live-server