Hyperbeam Plugin

Embed a Hyperbeam virtual computer into your media screens. Multiple users can control a single web browser and have a synchronized web experience. 

Watch YouTube videos and other streaming media content, and allow multi-user interaction within a single web interface. 

1. Install Media Share Plugin from Vatom Plugin Marketplace if not already installed in the space.
2. Install Hyperbeam Plugin from Vatom Plugin Marketplace
3. Add Hyperbeam Screen from Insert > Objects menu
4. Get and Enter Hyperbeam API Key(s)
5. Choose Starting Website
6. Adjust Hyperbeam Proximity

1. Install Plugin(s)

The Media Share Plugin must be installed for Hyperbeam to work properly.

Install the "Hyperbeam Web Frame" plugin by Vatom. 

2. Add Hyperbeam Screen

With the plugin installed, you now have a preset object for "Hyperbeam: Remote Web Frame"

Admin Menu > Insert > Objects > Hyperbeam: Remote Web Frame

This creates a media screen with the hyperbeam component installed. Resize and place your screen. 

Hyperbeam Component

You can also add the hyperbeam component as a Media Source to any already existing media screen. 

To display audio and video from hyperbeam, the screen requires the following three components:

• Audio Destination
• Video Destination
• Hyperbeam Source

With the plugin installed, Hyperbeam also appears at the bottom of the Media Controller component.

3. Add Hyperbeam Key

Get your own Hyperbeam API Keys at https://hyperbeam.com/dashboard/. More information at the bottom of this article.

4. Choose starting URL

Choose the URL you would like to browser to open first. You can change this with a button in the component, or by showing the browser UI.

Admins can also right-click the screen and choose Component Actions > Choose URL

5. Hyperbeam Controls

In the hyperbeam component, choose when to capture all inputs into Hyperbeam, and who can interact with the screen. 

"Capture Input" means all user controls are captured by the hyperbeam web frame and not the Vatom metaverse. You will have to click "Stop" input capture before backing out of the screen, changing view, moving around, etc.

Capture Input

What starts full input capture?

• Yes - Shift + Click
• Yes - Any Click
• No

Who can Interact

• Yes - Anyone
• Yes - Admins only
• No

Proximity

How far away from the screen does a user need to be to load the content? Set proximity (in meters) from the centerpoint of the screen.

If Proximity is set too close, the screen may not load. If proximity is too far, everyone in the space will see the screen and too many screens can cause performance issues. 

Get your own Hyperbeam API Key(s)

Visit https://hyperbeam.com/dashboard and choose "I am a Developer"

Log in and return the one-time passcode

In the Dashboard, choose your Test or Production key. 

• Test Key - Testing with up to 2 simultaneous users in 5-minute intervals. The stream will cut out after 5 minutes of continuous use.
• Production Key: Up to 10 users with unlimited duration and 10,000 free minutes before paid use. Upgrade for more time.

Enter your API Key into Vatom Spaces and choose a URL. Once the avatar is within the Proximity distance, the Hyperbeam stream will start.