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
  • Breakroom Video Player user controls
  • Setting up the Breakroom Video Player
  • Adding a splash screen image
  • Entering a video URL
  • Video playback options
  • Editing the Breakroom Video Player collider zone
  • Tips for best performance
Export as PDF
  1. CREATING CUSTOM EXPERIENCES
  2. Exploring the Breakroom Toolkit

Breakroom Video Player

The perfect tool for sharing training videos, highlighting sponsors, or creating dynamic event backdrops. Read on for more information about setting up and using the Breakroom Video Player.

PreviousExploring the Breakroom ToolkitNextBreakroom Web Browser

Last updated 6 months ago

Overview

The Breakroom Video Player allows users to access live or pre-recorded video content on demand. Object Owners and users with appropriate or permissions can also configure playback options and add a splash screen that will be displayed when the video player is not in use.

Breakroom Video Player user controls

Users can control any Breakroom Video Player using the buttons located in the bottom control bar. Videos are displayed on a per-user basis, not streamed openly to the Region as a whole.

Control bar button
Function

Play

Plays the video for the user who clicks it.

Pause

Pauses the video for the user who clicks it.

Stop

Stops the video for the user who clicks it.

Zoom In / Zoom Out

Allows the user to focus on and away from the screen.

Settings

Only available to Object Owners and users with appropriate permissions.

Setting up the Breakroom Video Player

Adding a splash screen image

To set a splash screen for your video player, follow these steps:

  1. Locate the Breakroom Video Player object you want to edit.

  2. Click on the gear icon to open the Breakroom Video Player 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 splash 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. When you're satisfied, click the Save and Close button.

Entering a video URL

To enter a video URL, follow these steps:

  1. Locate the Breakroom Video Player object you want to edit.

  2. Click on the gear icon to open the Breakroom Video Player control panel.

  3. Paste your video URL into the Video URL field.

  4. Click the Save and Close button.

Video playback options

The Breakroom Video Player control panel also allows you to customize the way videos are played. You can loop a video, mute a video until users interact with the player, and more.

To edit the video playback options, follow these steps:

  1. Locate the Breakroom Video Player object you want to edit.

  2. Click on the gear icon to open the Breakroom Video Player control panel.

  3. Click the ON or OFF button located next to each video playback option.

  4. Click the Save and Close button.

Video playback setting
Function

Auto Play

Loop Video

If set to ON, video will replay continuously.

Silent Mode

Post FX

Pops Out

Editing the Breakroom Video Player collider zone

Several advanced features and video playback options are triggered when an avatar enters the Breakroom Video Player collider zone. The size and position of this collider zone can be customized using the Region Editor.

To edit the Breakroom Video Player 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 Video Player 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 Video Player 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

  • Breakroom supports many common video formats, such as MP4, HLS, and YouTube videos.

  • Breakroom does not currently support videos hosted on Vimeo.

In your Inventory, you'll see the Breakroom Video Player represented by this icon:

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

The Breakroom Video Player control panel is only accessible to the Object Owner and users with appropriate or permissions. To access it, click on the gear icon in the bottom control bar.

Splash screen image settings are the very first thing you'll see in the Breakroom Video Player control panel. You can either choose a splash image from your , or upload a new splash image from your computer.

If set to ON, video will begin playing automatically when users enter the video player , and will stop when they exit the zone.

If set to ON, video will play with muted audio until a viewer clicks the .

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

If set to ON, video player screen will "pop out" to user screen when users enter the video player . 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.

For best performance, we recommend hosting your video as an MP4 file on a cloud server (such as ).

If a YouTube video is DRM-controlled or monetized, you will not be able to stream it through the Breakroom Video Player. Please be aware that YouTube may automatically apply DRM restrictions to a video if it detects the presence of copyrighted materials (such as background music). If the video you want to use is DRM-controlled or monetized, you may still be able to play it using the . Please note that playing a video on the web browser object offers a different experience, and that Breakroom cannot track video analytics through the Web Browser object.

Region Editor
World-
Region-level
Media Library
installing
positioning
RoomFurniture component
Amazon AWS
Breakroom Web Browser
collider zone
Zoom In button
collider zone
collider zone
World-
Region-level
Region Editor tools
Transform component
Pictured: The Breakroom Video Player control bar.
Highlighted: The location of the Breakroom Video Player gear icon.
Pictured: The Breakroom Video Player settings.
Pictured: The video URL and video settings in the Breakroom Video Player control panel.
Pictured: The Region Editor, with a Breakroom Video Player 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 Video Player object.
Picured: A Breakroom Video Player set up in the Desert Island region template.