LogoLogo
Tutorial VideosScripting DocumentationLegalHome
Breakroom
Breakroom
  • Welcome to Breakroom
  • GETTING STARTED
    • Helpful terms
    • UI tour
    • Keyboard shortcuts
    • Customizing your avatar
      • Choosing a starter avatar
      • Editing avatars in the Outfit window
      • Using the Sine Wave Shop
    • Controlling your avatar
    • Controlling your camera
    • Communicating with other users
    • Using the conference system
      • Troubleshooting audio and video issues
    • Using Breakroom for Training
    • Settings
    • Language and accessibility
    • Reporting issues
  • EXPLORING BREAKROOM
    • Region navigation tools
    • Bookmarks and teleport invites
    • Using the Explore window
    • Using the Meetings window
    • Networking with other users
      • People
      • Groups
    • Snapshots
  • BUILDING NEW WORLDS
    • Breakroom Dashboard tour
    • Creating and managing Regions
    • Default Landing and Orientation Regions
    • Region settings
    • Region template descriptions
  • CREATING CUSTOM EXPERIENCES
    • Branding tools
    • UI customization options
    • Filtering the Sine Wave Shop
    • Selecting default avatars
      • Default avatar collections
    • Using the Region Editor
      • Editing and moving objects
      • Editing terrain and sky
      • The Region Editor ADVANCED window
    • Exploring the Breakroom Toolkit
      • Breakroom Video Player
      • Breakroom Web Browser
      • Breakroom Image Viewer
      • Breakroom Info Kiosk
      • Breakroom Teleport Portal
      • Breakroom Web Collab
      • Breakroom Note Board
      • Breakroom Games
      • Breakroom Reactives
      • Breakroom Orientation Quest
      • Breakroom Tour Cameras
      • Conference rooms and booths
      • Add-on seats
      • Breakroom Start Here UI
      • Breakroom Basic Emojis
      • Breakroom 360° Video Player
    • Managing your Media Library
  • OPENING THE DOORS
    • Seats and concurrency
    • Creating and managing user accounts
      • World-level user permissions
      • Region-level user permissions
      • Single sign-on
      • Eventbrite integration
    • World Stream
      • Purchasing and managing World Credits
      • Pre-allocation campaigns
      • World Stream viewer toolbars
      • World Stream keyboard shortcuts
      • Troubleshooting World Stream issues on Chrome
      • Troubleshooting World Stream issues on macOS
    • Desktop viewers
    • Privacy Policies, EULAs, and data collection
    • Analytics
    • Toggling World availability
  • RUNNING YOUR EVENT
    • Understanding the conference system
      • Voice zones, zone types, and conference permissions
      • Voice chat and spatial audio
    • Customizing the conference system components
      • Adding breakout areas
      • Creating custom voice zones
      • Setting up Presenter and Audience zones
      • Designating triage zones
      • Troubleshooting duplicate zone errors
      • The RoomFurniture component
    • Setting up Breakroom for Training courses
    • Moderator tools
      • Broadcast messages
      • Crowd management
      • Audience questions
      • Raised hands
      • Presentation controls
      • Hidden UI toggle
      • Participation
      • Audio streams
  • TIPS FOR SUCCESS
    • Region Editor best practices
    • Onboarding new users
  • ADVANCED TUTORIALS
    • Uploading your own Region
      • Installing Unity and the Breakroom SDK
      • Reducing poly counts on CAD files
      • Uploading a Region from Unity to Breakroom
      • Creating and uploading custom chairs
      • Testing items on the preview server
      • Pushing items to the live server
      • Installing the conference system components
    • Uploading your own virtual objects
    • Uploading your own virtual clothing
    • Creating and copying avatar shapes
    • Installing the Quest System
    • Registration and grid APIs
    • Video streaming
    • Sinespace scripting documentation
  • HELP
    • Where to find support
    • Tutorial video playlists
      • Platform basics
      • Dashboard
      • Moderator tools
      • Breakroom Games
      • Creator Core
      • Breakroom for Training - Students
      • Breakroom for Training - Instructors
      • Breakroom for Training - Dashboard and Backend
    • Account management
    • System requirements
    • Troubleshooting network ports and firewalls
  • RELEASE NOTES
    • Breakroom SDK
    • Breakroom Viewer
    • Breakroom Dashboard
Powered by GitBook

©2008-2024 Sine Wave Entertainment Ltd. All Rights Reserved.

On this page
  • Overview
  • Setting up the Breakroom Image Viewer
  • Adding an image
  • Adding a webpage URL
  • Image viewer options
  • Editing the Breakroom Image Viewer collider zone
  • Tips for best performance
Export as PDF
  1. CREATING CUSTOM EXPERIENCES
  2. Exploring the Breakroom Toolkit

Breakroom Image Viewer

Brand your event with engaging signage and graphics—anywhere, anytime. Here you'll learn how to deploy and customize the Breakroom Image Viewer.

PreviousBreakroom Web BrowserNextBreakroom Info Kiosk

Last updated 7 months ago

Overview

Setting up the Breakroom Image Viewer

When users click on a web-enabled viewer, they will only see the Open URL button. Clicking this button will open the associated URL in an external browser tab.

Adding an image

To display an image using the Breakroom Image Viewer, follow these steps:

  1. Locate the Breakroom Image Viewer object you want to edit.

  2. Click on the image viewer, and then click the Open Admin button to open the control panel.

    1. To choose an image you've already uploaded to Breakroom, click the Image Library button. This will open the image picker. Click on the image you want to use.

    2. To upload a new image from your computer, or click the Upload New Image button. This will open a standard file picker on your computer. Locate the image you want to use, click on it, and then click the Open button.

  3. Your selected image will display in the preview window. Make sure everything looks good, and then click the Save and Close button.

Adding a webpage URL

To link a webpage to your Breakroom Image Viewer, follow these steps:

  1. Locate the Breakroom Image Viewer object you want to edit.

  2. Click on the image viewer, and then click the Open Admin button to open the control panel.

  3. Paste your URL into the Webpage URL field.

  4. Click the Save and Close button.

Now when users click on the Breakroom Image Viewer, they will see an Open URL button. Clicking this button will open the associated URL in an external browser tab.

Image viewer options

The Breakroom Image Viewer control panel also allows you to customize the way images are displayed.

To edit the image display options, follow these steps:

  1. Locate the Breakroom Image Viewer object you want to edit.

  2. Click on the image viewer, and then click the Open Admin button to open the control panel.

  3. Click the ON or OFF button located next to each image display option.

  4. Click the Save and Close button.

Display setting
Function

Post FX

Pops Out

Editing the Breakroom Image Viewer collider zone

Several image viewer options are triggered when an avatar enters the Breakroom Image Viewer collider zone. The size and position of this collider zone can be customized using the Region Editor.

To edit the Breakroom Image Viewer collider zone, follow these steps:

  1. Open the Region Editor by clicking the Edit Region button at the bottom of your screen.

  2. Locate the Breakroom Image Viewer object you want to edit. Click on it to highlight it in the Objects window.

  3. In the Objects window, click the > arrow to the left of the Breakroom Image Viewer object to expand it. Then click on the Collider component.

  4. When you are satisfied, click the Save button to store your changes.

Tips for best performance

  • Images have a 5MB size limit. We recommend that image files used for signage or decorative purposes be no longer than 1024px along one side.

The Breakroom Image Viewer allows Object Owners and users with appropriate or permissions to upload static images—including company logos, informational signage, and event branding or advertising—and display them almost anywhere. Event coordinators can also create clickable images that will direct users to a webpage.

In your Inventory, you'll see the Breakroom Image Viewer represented by this icon:

For help installing the Breakroom Video Player, please review our information on using the .

The Breakroom Image Viewer control panel is only accessible to the Object Owner and users with appropriate or permissions. To access it, click on the Breakroom Image Viewer and then click the Open Admin button.

If set to ON, will turn off various graphics settings within the image viewer that could distort the image or on-screen text.

If set to ON, video player screen will "pop out" to user screen when users enter the image viewer . The offset and scale of this pop-out screen can be customized by entering values into the associated fields.

The instructions provided below presume an advanced working knowledge of Breakroom. Please consult our documentation if you need help and virtual objects, or editing the .

Using the or the , move, rotate, and resize the collider to meet your specifications.

The Breakroom Image Viewer will automatically adjust its dimensions to match the aspect ratio of the image displayed on it. As a result, you may find that a finished image panel cuts through the floor of your Region, or is otherwise too large or small for its intended purpose. You can use the to adjust the of the image viewer as needed.

To resize an image viewer while maintaining the proper aspect ratio, hold down the Shift key while dragging the . This will allow you to make the image viewer larger or smaller without distorting the image.

World-
Region-level
Region Editor
World-
Region-level
installing
positioning
RoomFurniture component
Region Editor
position, rotation, and scale
collider zone
collider zone
Region Editor tools
Transform component
scaling gizmo
Highlighted: The Breakroom Image Viewer access buttons.
Pictured: The Breakroom Image Viewer settings.
Pictured: The Webpage URL option in the Breakroom Image Viewer control panel.
Pictured: Settings available in the Breakroom Image Viewer control panel.
Pictured: The Region Editor, with a Breakroom Image Viewer object selected. The transparent green box indicates the size and location of the collider zone. In the Objects window, you can see that the collider zone object is nested within the Breakroom Image Viewer object.