Ocavu Reference Guide

Installation - Overview

Requirements:

Three Steps for a Successful Ocavu Installation

  1. Load the Ocavu Web SDK on your website
  2. Embed an Ocavu Experience Launcher or Viewer on your website
  3. Ensure adequate usage tracking is in place

Loading the Ocavu Web SDK

To load the Ocavu Web SDK, include this line of code at the bottom of the body of your webpage:

<script src="https://view.ocavu.com/YOUR_TOKEN_HERE/ocavu.min.js"></script>

Be sure to replace the YOUR_TOKEN_HERE text with your own, for example:

<script src="https://view.ocavu.com/ocavu-web/ocavu.min.js"></script>

For more information visit How can I load the Ocavu Web SDK on my website?


Embedding Ocavu on your Webpage

Ocavu can be installed on your website in a variety of ways to accomodate your particular style or requirements. There are three primary ways of embedding Ocavu AR/3D functionality on a webpage:

  1. Add an Experience Launcher Button to the page
  2. Overlay an Experience Launcher Icon on an image
  3. Integrate a 3D viewer directly into the page

Options 1 and 2 guide your users to launch an immersive full screen AR/3D experience without leaving your website.

Option 3 lets your users immediately interact with your 3D content within your webpage and displays a "Launch AR" button. When the "Launch AR" button is clicked, the experience will transition to full screen Augmented Reality.

Experience Launcher Button
Experience Launcher Icon Yamaha Baby Grand Piano
Integrated 3D Viewer

For more information:


Ensure usage tracking

Ocavu provides basic usage analytics within Ocavu Portal, including total views, views by platform, and views by model.

Conversion tracking can be accomplished by attaching conventional click tracking to the Ocavu Launcher Button or Icon. However, the Ocavu Web SDK also provides an event system to make it easy to track more advanced user interactions within the experience.

For details on the Ocavu Web SDK event system and usage examples visit How do I use the Ocavu Web SDK event system?