Synthesis VR API – Local API
The local API is a special URL that runs on every of your VR stations and can be used for building third-party services and functionalities. The API URL is: http://localhost:8080/control/<API_COMMAND> Commands: Command Description status Provides a way to check the if SynthesisVR is running well. It should contain “status”:1 in the response status/hmd Represents if the HMD is currently connected to SteamVR. Returns true or false status/controllers Returns the status of all connected controllers – their battery level, if they are currently charging and if they are wireless controllers status/hmdreboot Stops SteamVR, awaits for 15 seconds and starts SteamVR idleplayback/(true|false) Enables/Disables the Idle Playback functionality
Booking Add-On – Booking Widget Setup
This Documentation will provide a step by step guide to setting up your booking widget, integrating it in to your WordPress website and other advanced configurations. On your left menu click Administration Click Advanced Settings – Web Widgets as shown below This takes you to the Widgets Page. On the Booking Widgets TAB – Click the + sign to create a new web widget. This will open up a pop up menu to create a new widget. Widgets Pop Up Settings 1. Title – A Suitable title for your widget 2. Predefined Template – Select Template Version 5 from the drop down menu as shown below 3. Click the Experience Type+ buttonSelect the correct Experience from the dropdown menu this widget is going to apply. You can have multiple Experiences on the same widget. Make sure to click Experience Types+ button to add more experience. 4. Take Out Time Options+ (Optional) By default the booking will show all your time slots. Example: You have a 15, 30, 45 and 60 minutes duration on your Booking Rules for VR Experience. Online you only want to show the 30,45 and 60 minutes option and do not want customers booking 15 minutes, then you can use this Take Out Time Options+ and not show the 15 minutes duration as shown below. 5. Waiver Template (Optional)If you want your customers to select a waiver before checkout select the correct Waiver Template from the drop down as shown below: 6. About Field – (Optional)Here you can add text explaining the booking widgets or conditions. 7. Payment moduleSynthesis VR can integrate multiple merchant processors for free. Here you can select the correct Payment module that is to applied for taking customers’ payment online. **This module has to be setup prior to selecting from the drop down. 8. Collect More Information About Your Customers+ (Optional)By default only Email, Password and Full Name is entered when a customer is making a booking online. If you want to collect more information you can use this button to add multiple fields. All fields are default text inputs, but limitations can be set as shown below.**For more customization options check the booking customization section. 9.Booking Confirmation Points+ (Optional)You can create points that the customer would check off using this. For example, something like “I agree to come 15 minutes prior to my session start”. This checkbox would be required to be checked off. 10. Add HTML to the HEAD and BODY tag (Optional)These fields are used to customize various options on your widget settings. Using this you can pretty much customize and enhance various options according to your own individual requirements. **This is clearly explained in the customization section with multiple examples as use case scenarios.11. Customer can pay in your locationIf you want your customers to pay at your Arcade instead of ONLINE, select YES, If the customer has to Pay ONLINE, select NO 12. Disable enforcing account registrationIf you want to enforce customers to register before checkout. This option will be OBSOLETE if ONLINE PAYMENT OPTION is selected, customer will have to create a profile before checking out. 13.Arcade Image (Optional)Upload your logo or image of choosing for the widget 14. External CSS URL (Optional)Synthesis VR supports external styling using CSS. Please input URL to enable external styling. 15. Time FormatAs shown below, which format of time you want to use in your widget. AM/PM or Military style Time. 16. Pre-selected duration upon loading the widget (Optional)If you want a certain duration to load by default based on your booking duration, input the duration in minutes as shown below. This will load the 30 minutes duration by default on the booking page. 17. Earlier Possible Time After (Optional)This is an extremely valuable field for events and party bookings. For special events and parties if you require a certain duration then use this field.Type Digit and Type of Duration as shown below. This will require a 24 hour notice before they can make a reservation online. This will prevent same day reservations and have to be used carefully. Once you have setup everything please click the Save Changes button.
Voice Chat Service
The “voice chat” is an out-of-the-box feature of SynthesisVR and requires zero configuration. It bridges the input audio from all stations related to the same reservation/session and puts them into a “conference call” where they can communicate with each other and you can communicate with them. How do I enable the Voice Chat? In the Settings of the Access Point App on each of your stations, choose select the “Enable Voice Services” item and that will start a new background task: This will then launch the Voice Chat service and the interface. If you open the interface, you can change the microphone and headphone if necessary: That’s mostly it. Going forward, people within the same session will be able to hear each other regardless of whether they are in a multiplayer game or not.Customers, from within the VR interface, can also turn this off (or back on) for their individual station if they don’t want to be part of the conversation.From the V3.x interface:From the V4.x interface: Using the Voice Chat to talk to your customers All the Voice functionalities are based on the related Voice Over IP (VoIP) protocols and work via:1) Browser2) Third party apps for Windows ; Linux ; Android ; iOS3) Standalone VoIP devices4) Regular phones with ATA adapters Configuring a third party app Although all apps will have a different interface, they have a couple common configuration parameters. Lets use the Zoiper app as an example (available for all 4 major OS).1) Install Zoiper (https://www.zoiper.com/)2) Go to “Settings >> Create a new account”3) Select “SIP” as “Account type” and click on “Next”4) Fill the following credentials:a. User / user@host => 1000@192.168.1.105 (replace 192.168.1.105 with the local IP of the PC where you installed the SynthesisVR’s “VR Main Server” mode )b. Password => 3420c. Domain / Outbound proxy => [KEEP IT EMPTY]5) On the next screen, enable the “Skip auto-detection” option and click on “Next” and then click on “Close”.For Windows, we recommend the MicroSIP app (https://www.microsip.org/downloads):Example MicroSIP account configuration: What numbers I can dial? Each of your VR stations has an individual and unique “phone number”. If a station number is 10001:1) Dial 99910001 to reach to the individual station alone. To do that, you don’t need an active session in place.2) Dial 88710001 to reach to the conference call and talk with all the players in a session. The full conference session number is displayed on the “Your Arcade” page of your Dashboard and clicking on the gear icon in the top right of a station: Additional notes:1) The 1000 number is reserved for the Operator’s account. Its password is 3420.2) If you have the “VR Main Server” and “VR Station” modes both installed on the same PC, you may experience chunky audio with that particular station.3) If a customer mutes the Voice Chat, you are still able to call into that individual station and have a conversation.4) Third party firewalls and Antivirus software may block the audio. Please ensure the following network ports are not blocked (don’t forget to check your router as well):a. VR Main Server – TCP – 8021 ; 7443 ; 5066 ; 5060 ; 8020b. VR Main Server – UDP – 16384-32768c. VR Station – UDP – 5020 ; 4000-5000