ADVANCED - The RoomFurniture component
The RoomFurniture component is an integral part of Breakroom's prefab breakout areas and voice zones. Learn how to create custom audio effects, change the default camera, and more.

Overview

When you select a prefab breakout area or customizable voice zone within Breakroom's Room Editor, you will see a number of components listed in the Inspector window for that object.
An example of the Inspector window, with three components listed for the selected object.
These components control, and permit the customization of, various object factors and behaviors. For example, the Transform component contains information about the virtual object's position and size. You can edit these details manually by entering new values into the fields.
An example of the Transform component.
When it comes to editing and customizing prefab breakout areas and voice zones, the RoomFurniture component is of key importance. In the sections that follow, we will explore the various object factors that the RoomFurniture component controls.
After changing any settings in the Room Editor, it is useful to click "Save" to store your changes and then click the "Reset Zones" button to reset the conference system. If this doesn't seem to push your changes forward, try leaving the region and entering again.

The RoomFurniture component fields

The RoomFurniture component, expanded to display all 15 fields.
To expand the RoomFurniture component, click on the > arrow located to the left of the component name. You will see fifteen separate features appear, each with a single text field.

Zone ID

When you add a breakout area or voice zone to your region, it is automatically assigned a unique zone ID. To change a zone ID, open the Room Editor and manually enter the ID number you want to use. Click the Reset Zones button to push your changes forward, and click Save in the Room Editor once you are satisfied with your changes.
Best practice tip: Grouping certain types of voice zone IDs together can help with project organization. For example, important zones such as a help desk and an auditorium could be identified as Zones 1 and 2 respectively, while breakout rooms could be identified from Zone 10 upwards.

IMPORTANT NOTE ABOUT ZONE IDS

If two breakout areas or voice zones are ever assigned the same zone ID, users in those areas will be considered to be within the same voice zone, even if they are separated by the entire length of a region. This may be just the trick you need to create points of interest and interaction for your users -- or it could result in cross-chatter and confusion.
If you are experiencing issues with voice zones, always check your zone IDs. If you do have duplicate zone IDs within a region, this above notice will appear in the Region Editor to help you identify the source of the problem.

Zone Name

When you add a breakout area or voice zone to your region, it is automatically assigned a zone name. In the case of prefab breakout areas, this zone name will take the form of "Breakout N," where N is a unique number. This naming convention ensures that the breakout area is added to the breakout room teleport menu. In the case of customizable voice zones, the zone name will default to "Workshop."
You can rename a breakout space or voice zone at any time. For instance, you may wish to swap the numbers on two prefab breakout areas, or you may wish to designate a custom voice zone as a breakout area by changing its name to "Breakout N" (where N is a unique number). This will add it to the breakout room teleport menu and stage management tools.
Alternatively, you can also rename a breakout area or custom voice zone in order to link it to the general navigation menu. You can find instructions for doing so on this page.
When you are satisfied with your changes, click the Reset Zones button to push them forward. Then click Save in the Room Editor.
The name of your voice zone will be displayed to your guests in the top left corner of their screen. If you list the voice zone as an area of interest, it will also appear in the navigation system.

Zone Type

As explained in our documentation concerning voice zones and conference permissions, there are three types of voice zone available for use in Breakroom. To review, these are:
  • Audience: Within audience zones, only voice chat will work. There is no webcam or screen share functionality.
  • Meeting: In meeting zones, webcam and screen share are enabled alongside voice chat. This is the standard setting for workshops, breakout rooms, and offices.
  • Presenter: Presenter zones restrict the use of screen and webcam sharing to only the user standing in the designated presenter position. This is the standard setting for auditoriums.
You can change the type of a breakout area or customizable voice zone by manually entering the term "audience," "meeting," or "presenter" in the zone type field. Click the Reset Zones button to push your changes forward, and then click Save in the Room Editor.

Zone Voice

This field controls whether zone-specific voice chat is available to users. To change this option, simply enter "yes" or "no" in the field. Click the Reset Zones button to push your changes forward, and then click Save in the Room Editor.
Note: Turning zone voice off may not disable voice chat entirely for your end users. For instance, a user standing in a breakout area with zone voice deactivated will still be able to hear and participate in chat from the surrounding voice zone (e.g. the global zone). This is useful if you want to use a custom voice zone to create an area where users can share their screens, for example, but still participate in global chat.

Zone Spatial

The zone spatial feature controls the audio spatial distance that users will experience when standing in a breakout area or voice zone. When spatial audio is enabled, voice zones behave much like we would expect in the "real world" -- other avatars (or people) standing nearby will be easy for us to hear, while avatars standing at a distance may be more difficult to hear, if we can hear them at all.
By setting this field to 0, spatial audio can be turned off. This means that everyone in the audio zone will be able to hear one another over voice chat with no spatial volume effects.
If the zone spatial field is set to 1 or above, spatial audio will be enabled. The number represents the number of meters surrounding each avatar wherein their voice feed can be heard by others. 1 would correspond to one meter, 5 corresponds to five meters, etc.
After you've made changes to this field, click the Reset Zones button to push your changes forward, and then click Save in the Room Editor.

Zone Chat

This field controls whether a dedicated, zone-specific text channel is available to users. To change this option, simply enter "yes" or "no" in the field. Click the Reset Zones button to push your changes forward, and then click Save in the Room Editor.
Note: Turning zone chat off will not disable text chat as a whole for end users. It will simply remove the option of having a dedicated text chat within the specified voice zone.

Auto Configure

This field is for internal Breakroom use. You will not need to manually edit it.

Zone Priority

An example of two nested voice zones.
The zone priority field can be used to create "nested" voice zones, or voice zones located within other voice zones. In the image above, you can see that we've created a voice zone at the end of the conference concourse (the transparent green sphere), and that inside of it is a cozy chat area (the transparent green cube). By setting the sphere-shaped voice zone as priority 2 and the cube as priority 3, we can specify that those seated within the chat area should only hear and participate in voice chat that takes place in the cube, even though their avatars are technically also located inside the sphere.
To create nested voice zones, simply enter a number in the zone priority field for each overlapping voice zone. The global voice zone is always number 1; the higher the number, the higher the zone priority. Click the Reset Zones button to push your changes forward, and then click Save in the Room Editor.

Zone Color

When you set down a new prefab breakout area, it will automatically assign itself a unique color. This color will be applied to the design of the physical breakout space, and will also appear as that breakout area's button background in the teleport menu. If you want to change a breakout area's color, you can manually enter any of the following colors in the zone color field:
  • Blue
  • Orange
  • White
  • Grey
  • Magenta
  • Teal
  • Black
  • Cyan
  • Red
  • Purple
  • Pink
  • Green
  • Yellow

Changing the zone color presets

If you like, you can change the hexadecimal presets for each of the color keywords listed above. To do so, follow the steps below.
  1. 1.
    Open the Room Editor, and select the breakout area or voice zone you want to edit in the Objects window. Expand that object by clicking the > arrow located to the left of the object name.
  2. 2.
    Locate the component called Breakroom Voice Zone, and expand that object by clicking the > arrow on the left-hand side.
  3. 3.
    Click on the component called Colors. This will open the Inspector window.
4. In the Inspector window, expand the ScriptingData component by clicking the > arrow next to its name. 5. Enter the hexadecimal color codes you would like to assign to each keyword. 6. Click the Reset Zones button to push your changes forward, and then click Save in the Room Editor.
Color keywords can only be edited on a per-object basis. They cannot be changed on a global basis.

Zone Camera Default

By editing the zone camera default field, you can change which camera angle users first see when they take a seat in a breakout area. Camera options include:
  • Behind
  • Forward
  • Speaker
  • Screen
  • Audience
  • Free
Once you've entered your selection, click the Reset Zones button to push your changes forward, and then click Save in the Room Editor.

Zone Camera List

By editing the zone camera list, you can change which camera angles users will be able to access through the gesture and camera control system. Camera options include:
  • Behind
  • Forward
  • Speaker
  • Screen
  • Audience
  • Free
By default, the zone camera list is blank, indicating that users have access to all of the above listed cameras. If you enter one or more specific cameras, users will be restricted to those choices. You can enter the camera keywords manually, separated by commas. For example:
1
Behind,Speaker
Copied!
Once you are satisfied with your changes, click the Reset Zones button to push your changes forward, and then click Save in the Room Editor.

Zone Visible

This field is used when activating additional navigation menus in a custom region. You can learn more by consulting our advanced region documentation.

Screen options (width, height, scale)

The final three fields in the RoomFunction component affect the aspect ratio and size of the screen used to display user-driven video (such as webcam feeds and screen shares). By manually changing the width and height of the screen area, you can create custom aspect ratios.
You can also edit the final display size of the screen overall by changing the number in the scale field. The default is 1, so you might enter .5 to create a screen half the size, or 2 to create a screen double the size. Our custom voice zone documentation contains an illustrated example of how you might edit this field.
Once you are satisfied with your changes, click the Reset Zones button to push your changes forward, and then click Save in the Room Editor.
Last modified 1mo ago