Skip to main content

Overview

Introduction​

The Matterport integration is designed to seamlessly integrate SuperViz Collaboration into Matterport SDK applications.

The integration consists of two main components:

Before you start​

It's important to note that a Matterport SDK license is required to be able to use the Matterport integration. General knowledge on how to implement a basic Matterport SDK is advanteous as well.

To get started, you should have access to your Matterport API Key as you will need this going forward.

Language support​

The Matterport integration is available in two different Packages: Javascript and React.

  • Javascript SDK: We support both Javascript with a package and JavaScript with CDN. You can use any JavaScript based framework such as React, Vue and Svelte.
  • React SDK: You can choose to use our dedicated React SDK. This package comes with 2 different approaches that simplifies the implementation.

Best practices​

  • When using Video huddle together with the Presence3D, you can enable users to select from our list of avatars by setting the flag defaultAvatars as true on the Video huddle constructor.
  • By default, make sure to use the SDK Bundle and not the SDK for Embeds, but to avoid WebGL performance issues and memory leaks on iOS and iPadOS devices, we recommend disabling avatars and lasers on those devices or using the Matterport Embed library. While this library reduces memory leak issues, the Embed library doesn't support the addition of avatars and lasers.
  • Make sure to only initialize the components once the Matterport Bundle iframe is fully loaded, otherwise you won’t be able to initialize them.

Requirements​

Happy coding!