SDK/API
SuperViz SDK/API
Add immersive meetings and collaboration to your 3D or digital twin web app with the SuperViz API and SDK.
*No credit card required.
const sdk = await SuperVizSdk.init(<DEVELOPER_TOKEN>, {
userGroup: {
id: <USER_GROUP_ID>,
name: <USER_GROUP_NAME>,
},
user: {
id: <USER_ID>,
name: <USER_NAME>,
isHostCandidate: true,
},
roomId: <ROOM_ID>,
});
GETTING STARTED
Easy Integration
Our easy-to-build, feature-rich SDK gets you up and running with just a few lines of code.
Core Features
Immersive meetings
Full-function video conferencing layer for up to 16 participants, including chat, grid view and screen share.
3D viewer plugins
Automatic Multiplayer enabled integration with avatars, pointers and controls directly inside your favorite 3D viewer.
Realtime data properties
Add an extra layer of collaboration by synchronizing your app properties in real time between meeting participants.
Avatars
Flexible avatar support for glb and GLTF models. Add your own models for meeting participants.
Broadcast
Broadcast mode for up to 230 people. With this mode you can allow audience participants to follow live meetings with chat access.
Dashboard
Developer dashboard with detailed usage statistics and management.
Collaboration with a sense of presence
Increase engagement with the capacity for real-time face-to-face interaction inside digital spaces. Feel like you’re in the same place together, no matter where everyone’s physically located.
ENHANCE COLLABORATION
Realtime data engine
Declare custom properties that will be synchronized between participants in the same meeting room.
You can synchronize 3D models, digital twins, 2D content, States, Selections, Objects, and anything else to meet your needs.
sdk.subscribe('syncPropertyName', onSyncPropertyChange);
onSyncPropertyChange(payload: any) {
// payload is the new value of the property you've changed
// do something
}
sdk.setSyncProperty('syncPropertyName', 'new value');
Plugins
Build your own or use one from our ready-to-go library below.
Matterport, a spatial data company, is digitizing and indexing the built world. The all-in-one 3D data platform enables anyone to turn a space into an accurate and immersive digital twin which can be used to design, build, operate, promote, and understand any location
Coming soon
three.js is the world’s most popular JavaScript framework for displaying 3D content on the web.
three.js is a JavaScript-based WebGL engine that can run GPU-powered games and other graphics-powered apps straight from the browser.
Coming soon
The Forge Viewer is a javascript-based viewer for 2D drawings and 3D models served by Autodesk’s Model Derivative API. It can be embedded in a web page, or any browser-based application. The viewer API allows you to control and customize the Viewer.
*Coming soon
FAQ
Plugins automatically implement avatars, pointers, and controls into your favorite 3D viewer or Library with just a few lines of code. We take care of synchronized avatar and mouse positions without any custom code.
Yes! Plugins are not required. You can choose to build your own plugin by utilizing our real-time data engine or just add our basic SDK functionality into your web-app.
No, we currently only support browser-based web applications.
SuperViz uses a pay-as-you-go plan. You pay per meeting minute per user. See more details on our pricing page.
Yes, the idea is that you always use your own avatars. If you don’t have an avatar, don’t worry, you can create them on our Ready Player Me partner page here: https://superviz.readyplayer.me/
Not currently, but we plan to add support for them soon.
We are happy to help and would love to hear your feature requests and feedback. We use Github’s issue management to track everything. Feel free to create tickets and we’ll get back to you as quickly as possible. Access our GitHub issue management here.