SuperViz v6.3.0
This update introduces the Recording feature for our Video Meeting and continues to improve our Real-Time Data Engine.
In addition to the Recording, we've made changes to video-related nomenclatures, i18n keys, icons, and text, and have also added APIs for recording retrieval.
With our Real-time Data Engine, we have introduced new endpoints to facilitate operations with the channels that we made available in our previous update.
What's New
Real-time Data Engine
On the last update we introduced channels and the ability to receive the, via webhook, the events published on your subscription. And now, as we expand our Real-time Data Engine, we are providing a way to publish events from an HTTP Request and more ways to interact with your channel.
Here are three new endpoints:
- Post events to specific channels: This new endpoint allows for the publication of a payload to an event in a specific channel.
- Get channel information: In this endpoint, you can obtain information about a specific channel. With this, you can fetch details such as the list of current active participants, room details, and the last 250 events dispatched to that channel.
- Get participants in a channel: This endpoint allows you to get a list of all participants in a specific channel. It might include information such as participant names, IDs, connection ID, and other relevant details.
Recordings now available
We are excited to announce that we now offer a feature to record your meetings. This new function allows you to capture the contents of your meeting for future reference. This new feature creates a few changes to the Video Conference and a new set of endpoints.
Be aware that when using the recording feature, the cost of the meeting will increase by one participant.
Video Conference
Changed transcript to recording
As we provide the recording feature, we are transitioning from the term "transcript" to "recording". However, please note that transcripts will still be available and a big part of our video meeting experience once a recording from a meeting is completed.
This implies changing some methods and callbacks across the SDK and the React SDK.
| Before | After | Description |
|---|---|---|
transcriptOff | enableRecording | The flag used to enable or disable the transcript on the toolbar, during the VideoConference initialization. |
onToggleTranscript | onToggleRecording | The callback event when a user clicks on the transcription button on the toolbar. |
toggleTranscript | toggleRecording | The method available inside the VideoConference to start or end a transcription. |
With this, we also updated the icons on the toolbar to better represent the action of recording.
New Translations
Some i18n keys have been changed from "transcript" to "recording". Check the table below to better understand the changes.
| Before | After |
|---|---|
transcript.stop.buttonConfirm | recording.stop.buttonConfirm |
transcript.stop.buttonCancel | recording.stop.buttonCancel |
transcript.stop.text | recording.stop.text |
transcript.stop.title | recording.stop.title |
transcript.start.text | recording.start.text |
transcript.start.selectTitle | recording.start.selectTitle |
transcript.start.buttonConfirm | recording.start.buttonConfirm |
transcript.start.title | recording.start.title |
toolbar.transcript | toolbar.recording |
transcript.alert.buttonConfirm | recording.alert.buttonConfirm |
transcript.alert.text | recording.alert.text |
transcript.alert.title | recording.alert.title |
You can check the full list of i18n keys on our Internationalization dedicated page.
Meetings and Recordings APIs
To view the recordings of your meetings, you can access them using Get all recordings endpoint, which retrieves all recordings of meetings associated with your Developer Token. You can also filter by roomId or meetingId.
To make it easier to see the recorded meetings, we also are releasing a new endpoint to facilitate localizing meetings and its stats on your account.
React SDK improvements
We added a new flag, stopAutoStart, to the SuperVizRoomProvider. By default, this flag is set to false.
We also introduced a new hook called useSuperViz. This hook includes the following:
startRoom: () => void;
stopRoom: () => void;
hasJoinedRoom: boolean;
Version numbers
The changes mentioned above are available in the following versions:
| Package | Version |
|---|---|
@superviz/sdk | 6.3.0 |
@superviz/autodesk-viewer-plugin | 1.18.0 |
@superviz/matterport-plugin | 0.21.0 |
@superviz/threejs-plugin | 0.24.0 |
@superviz/react-sdk | 1.8.0 |
Important: Due to recent changes to the three.js library, the minimum required version for the Three.js plugin is now 0.164.0, make sure to update it in your project.