Skip to main content
Version: Version 1.0

Overview

The Video Huddle component allows you to integrate a reliable video conferencing feature into your web application, enabling real-time video communication among participants.

Quickstart

Follow these steps to add the Video Huddle component to your application:

Before we start

Before adding the Video Huddle component, ensure that a room has been initialized with a defined name and ID for both the participant and the group. This room instance is required to attach the Video Huddle component.

Import the package

Import the VideoConference component from the SuperViz SDK to access video conferencing functionalities:

import { VideoConference } from "@superviz/sdk";

Add the Video Huddle Component

Initialize the VideoConference component by specifying the participantType and enabling the collaborationMode.

When collaborationMode is enabled, the video cameras are displayed in a list view, which facilitates collaboration on shared content instead of occupying the entire screen.
Finally, add the component to the room to activate the video huddle:

const video = new VideoConference({
participantType: "host"
collaborationMode: {
enabled: "true",
},
});

room.addComponent(video);

Next steps

You are now all set! See how you can configure the video huddle:

Resources to get you started

We've prepared a few resources to help you get started with the Video Huddle component and use it along with other components to create a collaborative environment.