Key Concepts
Miscellaneous
Room
In the SuperViz SDK, a 'Room' serves as the central hub for accessing all the SDK's functionality. Every collaboration begins in a room where participants can gather together. It offers all the methods and options necessary for adding components such as Video Conference, Presence, and more.
Dashboard
The dashboard allows you to track the usage of all our products, and manage your subscription and billing as well as your SuperViz Tokens.
By default, you will have a Development and Production environment available. Note: Upgrading from the free account is required to move to production.
SuperViz Token
To use our SDK, you’ll need to pass a SuperViz Token, as this token is essential for associating SDK requests with your account. You can retrieve development and production SuperViz Token from the developer page on the dashboard.
Groups
You can set a room as part of a group; this allows you to organize participants into groups when initializing the SuperViz SDK. Groups are recommended for segmenting companies or organizations during SDK initialization.
Participants
Every user in any room is considered a participant. Participants are defined when initializing the room.
Plugins
Plugins automatically integrate Presence features and/or Contextual Comments into your preferred 3D viewer or Library with minimal code.
Video Conference
The Video Conference product is a key component of the SuperViz SDK, allowing you to embed video conferencing into your web application. When adding the Video component, an overlay is automatically added on top of your existing content.
Participant Type
Participant types determine permission levels within a video conference call, including roles such as host, guest, or audience.
We currently support up to 16 host or guest participants and up to 230 audience participants in the same meeting.
Guests
Guests are participants who do not have any host controls available. A guest can never enter a meeting without a host present. A 'Waiting for host' message is displayed when a Guest attempts to join a meeting without a host present.
Host
The host is the participant presenting the meeting. They have control of the meeting room and can perform specific actions that other participants cannot.
In each meeting, there's only one active host at a time. The first participant with the host type to join a room becomes the host. If others with host type enter the same room, they can use the 'Take control' feature to become the new host.
A host can kick other participants out of a meeting or give control to other participants with the host user type.
Hosts also have access to presence controls such as Follow, Gather, and Goto
Collaboration mode
Collaboration mode is used in video conferences alongside the content area of an application. In this mode, cameras are arranged in a list format, allowing participants to view content while in a meeting. It's often used with other products like Presence or Contextual Comments.
Avatars
An avatar is a digital representation of a participant in a SuperViz-enabled 3D space. While the SuperViz SDK provides a range of default 3D avatars for meetings, you have the flexibility to enrich this experience by adding your custom avatar for participants.
Presence
The Presence product consists of multiple components that enable users to identify each other on the same page or document. These components integrate seamlessly with other SuperViz products.
Real-time Data Engine
The Real-time Data Engine is a component of the SDK that allows you to synchronize states between participants in a room. This enables various functionalities such as real-time data sharing, and event-driven communication for seamless collaborative experiences.
You can synchronize 3D models, digital twins, 2D content, states, selections, objects, and anything else to meet your needs.
Real-time Mouse Pointers
The Real-time Mouse Pointers is a component that enables real-time tracking of participants' cursor movements, allowing seamless collaboration within the same room.
Contextual Comments
Contextual Comments is a SuperViz product that embeds a customizable commenting experience into your product, enabling collaborative interactions. Users can initiate comment threads on any element inside your app for spontaneous and relevant dialogues.
Pin
A pin is a marker that defines where a comment has been added. We support out-of-the-box pins for regular HTML canvas and for 3D viewers through our plugins.
Custom pins are coming soon.
Presence Controls
Follow
The Follow feature is a default-enabled functionality of Presence3D and Who-is-Online. When it's on, the person being followed becomes the tour guide. Everyone else will automatically go where they go in the 3D model or to their mouse pointer location, but they can still look around on their own.
Gather all
This Gather all is part of Presence3D, as a default enabled functionality, and only the host can turn it on. To activate it, the host simply clicks the 'Gather all' button on the webcam frame. It's a one-click action that brings everyone to the host's view, so everyone looks in the same direction.
Go-To
The Go-To feature in Presence3D and Who-is-Online lets any participant click on someone's to instantly go to where they are in the 3D model or to their mouse pointer location. It's a handy way to quickly locate someone in the space. It is enabled by default.